Skip to content

Twitch setup

Jump to bottom
berichan edited this page Mar 28, 2021 · 9 revisions

A seperate config is required to setup the twitch functionality. The bot will automatically create a twitch.json file upon first startup. The discord bot must be set up to use the Twitch functionality of the bot. This cannot be changed, the bot uses discord as a front-end

Get a bot token from Twitch, fill out the twitch configuration fields, then start. You will need to define:

  1. Channel: The username that owns the channel you will be streaming on; this is to tell your bot which channel to join and interact with.
  2. Username: The username of the bot account that will be interacting with your channel.
  3. Token: The login token for the bot account.

WARNING: Do not run the bot with credentials that are your own user (streaming) account.

Twitch will warn you and suspend your main account if you are found to be self-botting. Create a separate bot account and generate your login token for that bot. The Twitch bot maintains a list of users waiting for a code. If they do not whisper a code fast enough, they will be removed from the list.

All destinations should be kept as configurated by the bot. If for any reason you need to change these, the following values are predefined for twitch message destinations. These values are the same as the Pokemon SysBot:

Disabled = 0,
Channel = 1,
Whisper = 2,

Order Mode

Orders work the same as the discord bot, but due to Twitch whisper limits, the bot requires that users whisper a 3-digit pin once their order is in a temporary queue, then use this pin on an external open-source page (https://berichan.github.io/GetDodoCode/) to reveal the dodo code once it has been generated. The page the user will see will be slightly different, as the hash does not need to be entered manually, all they have to do is enter their pin.

All pings will happen in the chat.

Blocking dodo codes

A file named "blocker.txt" will be written with a symbol, then cleared while the dodo is being shown on screen. Simply add this as a text resource and place/scale it over where the dialogue box show up on your OBS scene. The default symbol is a heart, but you may change this with any utf8 value if required.

Dodo restore mode

All dodo restore mode functionality is information set by host-defined commands. You may add, edit or delete as required in the twitch.json under the UserDefinitedCommands and/or UserDefinedSubOnlyCommands parameter, as well as their respective return message destinations. I recommend adding personal/rule commands for your island as a message too, if applicable.

The following values can be placed in messages:

  • {islandname}: The island name of the currently running bot
  • {dodo}: The current dodo code
  • {vcount}: The number of visitors currently on the island
  • {visitorlist}: The names of every visitor on the island
  • {villagerlist}: The names of every villager on the island
  • {user}: The Twitch username of the person calling the command
Clone this wiki locally