Sonic Robo Chat 2 Client

This is a Twitch bot to go with the Sonic Robo Chat 2 mod to allow you to stream Sonic Robo Blast 2 with chat participation features. This is a command line only script and does not come with any kind of graphical interface.

Setup

First download and setup Sonic Robo Chat 2 itself.

Then download the contents of this repository. It does not matter where on your computer you save it.

Twitch API

For the bot to function it will need to be able to log into a Twitch account. This can be the same account you will be streaming from or one made just for the bot. In either case you will need to generate an OAuth token for the account. On the OAuth token page you just need to authorise your account and it will give you the token, which is just a string of letters and numbers.

Configuration

Fill in the Twitch account details in config.yaml. The configuration file uses the YAML format. Fill in the OAuth token, the name of the account you're using for the bot for the bot_nick and the channel you will be streaming from for channel. These can be the same account. Finally, set the srb2_dir to where ever Sonic Robo Blast 2 is installed on your computer.

The other options in the configuration file are detailed in below in the section Chat Configuration.

Python

This bot requires Python 3 to run. Download the latest version of Python 3 from the official Python website. Once you have Python 3 installed open the folder you saved the files from this repository in in your preferred terminal or command prompt.

You will need to install all of the requirements for the bot with Pip, Python's package manager. To do this simply run

pip3 install -r requirements.txt

in the directory with the requirements.txt file.

Running

To run the client open the folder you saved this repository to and run:

python3 sonic-robo-chat.py

If you want to rename the configuration file, use a configuration in a different directory or have different sets of configurations for different streams you can also specify the name of the configuration file to use as an argument instead of the default config.yaml file.

python3 sonic-robo-chat.py path/to/other-config.yaml

Chat Configuration

The configuration file specifies the following options using YAML:

• oauth_token: Your bot's Twitch account OAuth token.
• bot_nick: The name of the account of your bot (all lowercase).
• command_prefix: The prefix for messages that indicates a command. E.g. if set to "#" the command to change character will be "#char". Defaults to "!".
• channel: The name of the channel you will be streaming from.
• srb2_dir: The directory Sonic Robo Blast 2 is installed in.
• join_message: A message to display in chat when the bot starts.
• display_chat_messages: If set to yes then normal chat messages will be shown in-game
• display_chat_commands: If set to yes then chat commands will be shown in-game
• display_bot_messages: If set to yes then messages from the bot itself will be displayed in-game.
• subscriber_only: A list of commands that can only be used by subscribers.
• mod_only: A list of commands that can only be used by mods. Commands like config, despawnall and killall should probably be set here.
• disabled: A list of commands that are disabled entirely.
• min_bits: A dictionary specifying the amount of bits that each command should cost to use. E.g. if char: 50 is set here then a message must have a cheer of at least 50 bits for the this command to work. The command still has to be the first thing in the message so cheers should be at the end, not the start for commands to work.
• bits_per_ring: Allows the ring command to be used with a cheer to give more rings at once. E.g. if it's set to 2 and a user cheers with 100 bits then 50 ring commands will be sent to the game. Users can still send ring command without a cheer to give one ring unless the ring command in also specified in the min_bits dictionary.
• bits_per_unring: The same as the above, but for the unring command.
• write_immediately: Write commands immediately as they come in rather than queuing them.

Commands

Below is a table listing all the commands that can be used with examples of how to use them. This is assuming the command prefix is set to "!". If you change this prefix the commands will need to start with that instead.

Command	Description	Examples
char	Changes the player to a random character or one named in the command. Can add "rcolour" to the end of the command to make the character a random colour.	!char !char tails !char rcolour !char sonic rcolour
foll	Same as above, but for the follower character if playing a Sonic & Tails game	!foll !foll amy !foll rcolour !foll fang rcolour
swap	Swap the current player and follower characters, if there is one	!swap
ring	Grant the player one ring. If bits_per_ring is set then a command with a cheer can grant more rings based on the number of bits in the cheer.	!ring
unring	Takes one one ring away from the player. If bits_per_unring is set then a command with a cheer can take away more rings based on the number of bits in the cheer.	!ring
1up	Gives the player an extra life.	!1up
air	Gives the player air to stop them drowning. Also stops them momentarily so it can be used for evil.	!air
scale	Takes a decimal value and changes the players size proportional to that for 30 seconds. 2 is double the size, 0.25 is a quarter, etc. Has a limit of ten times or one tenth normal size.	!scale 4 !scale 0.5
sfx	Play the sound effect given a name or ID number. Names are case insensitive and the sfx_ prefix is optional. There is a list of sounds on the wiki.	!sfx 91 !sfx sfx_rumble !sfx Rumble
bgm	Change the music to the track named in the command. Track names can be found on the SRB2 wiki's list of music.	!bgm ACZ1 !bgm _DROWN
badnik	Spawns a badnik appropriate to the current level in front of the player. Any text after the command will be displayed with the user's name above the badnik.	!badnik I'm gonna get ya
monitor	Spawns a random monitor in front of the player. Any text after the command will be displayed with the user's name above the badnik.	!monitor it's dangerous to go alone, take this
obj	Spawn an object in front of the player with a given name or ID number. Any text following the ID number will be displayed with the user's name above the object. Names are case insensitive and the MT_ prefix is optional. See the wiki's list of objects.	!obj 572 Mario! !obj RedSpring !obj MT_BUMPER boooiing
spring	Spawns a random spring directly on top of the player.	!spring
config	Update the config for the mod itself. See the readme for the game mod for what they do. This should probably be kept as mod_only.	!config spawn_radius 100
killall	Kills all objects that have been spawned by commands. This runs the normal death routines. E.g. badniks will pop, etc. This should probably be kept as mod_only.	!killall
despawn	Despawns all objects that have been spawned by commands. This does not run the normal death routines; objects will just vanish. This should probably be kept as mod_only.	!despawn