General Settings - kwsch/SysBot.NET GitHub Wiki

SysBot.Pokemon's settings are split into multiple classes, arranged by their general function. When you click on a setting's row, the bottom pane will give you a description of what the setting controls.

General

If you cannot get a setting to "stick", restart the program or remove/readd the bot.

  • Most settings can be changed while the program is running, allowing for small behavior tweaks without stopping the bots. Examples include:
    • Toggling the ability for users to join the queue
    • Changing when the queue automatically closes/opens
    • Folder of where to dump things
  • Some settings are only checked when the program first starts, generally for computationally intensive setup. Examples include:
    • Fake trainer data used to generate new PKM files from a ShowdownSet. For fake TID/SID, we need the 16 bit values rather than the 6digit TID style of current games. Hover over the TID/SID in PKHeX to get the old-style representation (16bit).
    • Stop conditions (for loading in IVs).

Settings are saved when you hit Start, and are also saved when you close the program. The values are saved in config.json.

  • Deleting the config will cause the program to regenerate the default settings the next time it opens.
  • In general, config files are compatible for future updates. However, some settings may be forgotten/reset, so if you notice things misbehaving, double check your settings for that feature.

Settings

These are settings that apply to multiple bots and may be scattered around the Hub.

  • AntiIdle: The bot will press B periodically to keep the Switch from going into sleep mode. You can also disable sleep through the Switch settings. This does not work in Scarlet/Violet.
  • LoggingEnabled: If set to true, the program will keep text logs in the logs folder for troubleshooting. Restart to apply changes.
  • MaxArchiveFiles: This controls the number of old text logs to retain. Set this to 0 or a negative number to disable log cleanup entirely. Restart to apply changes.
  • ScreenOff: Every bot has this setting, which turns the screen off when the bot is started and turns the screen back on when the bot is stopped.
  • EmitCountsOnStatusCheck: When enabled, the bot's counts will be displayed in $status.

Debug

  • SkipConsoleBotCreation: Bots will not be started if enabled. This can be used to test integration with Twitch, Discord, etc.