Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 2.64 KB

README.md

File metadata and controls

49 lines (33 loc) · 2.64 KB
Raw

SysBot.NET

License

Support Discord:

For support on setting up your own instance of SysBot.NET, feel free to join the discord! (Beware of un-official discords who claim to be official)

sys-botbase client for remote control automation of Nintendo Switch consoles.

SysBot.Base:

  • Base logic library to be built upon in game-specific projects.
  • Contains a synchronous and asynchronous Bot connection class to interact with sys-botbase.

SysBot.Tests:

  • Unit Tests for ensuring logic behaves as intended :)

Example Implementations

The driving force to develop this project is automated bots for Nintendo Switch Pokémon games. An example implementation is provided in this repo to demonstrate interesting tasks this framework is capable of performing. Refer to the Wiki for more details on the supported Pokémon features.

SysBot.Pokemon:

  • Class library using SysBot.Base to contain logic related to creating & running Sword/Shield bots.

SysBot.Pokemon.WinForms:

  • Simple GUI Launcher for adding, starting, and stopping Pokémon bots (as described above).
  • Configuration of program settings is performed in-app and is saved as a local json file.

SysBot.Pokemon.Discord:

  • Discord interface for remotely interacting with the WinForms GUI.
  • Provide a discord login token and the Roles that are allowed to interact with your bots.
  • Commands are provided to manage & join the distribution queue.

SysBot.Pokemon.Twitch:

  • Twitch.tv interface for remotely announcing when the distribution starts.
  • Provide a Twitch login token, username, and channel for login.

SysBot.Pokemon.YouTube:

  • YouTube.com interface for remotely announcing when the distribution starts.
  • Provide a YouTube login ClientID, ClientSecret, and ChannelID for login.

Uses Discord.Net , TwitchLib and StreamingClientLibary as a dependency via Nuget.

Other Dependencies

Pokémon API logic is provided by PKHeX, and template generation is provided by Auto-Legality Mod. Current template generation uses @santacrab2's Auto-Legality Mod fork.

License

Refer to the License.md for details regarding licensing.