electrobot

Twitch bot that manages predictions via chat commands and starts pre-made predictions automatically based on Livesplit. Now with hotkey support.

Prerequisites

Python (Add to PATH)
Livesplit and Livesplit Server (Optional)
A Twitch account (Affiliate) (with 2FA enabled)
A Twitch bot account (Optional)

Installation

Download the latest release and extract.
In the extracted folder, run the following command to install necessary dependencies:
```
pip install -r requirements.txt
```

Configuration

Register Application

Since the bot runs locally you must register your own app with Twitch, this only takes a few minutes. Follow their instructions and you should end up with an application in your console.

Once you see your application click on manage, then

Give the application a unique name
Set OAuth Redirect URLs to http://localhost:8777. The port doesn't really matter as long as it's not used elsewhere.
In Category choose Chat Bot.
Click I'm not a robot, then Save
Take note of the Client ID, you will need this shortly.
Click on New Secret and also note this down.
Save

Config.toml

Open the config folder.

Copy config-example.toml and rename the copy to config.toml.
Open config.toml and change the value in client_id to the client ID you noted down earlier.
Do the same thing with client_secret and redirect_uri.
If you didn't use port 8777 you MUST also change the port field under [socket] as by default it is set to 8777.
Under [twitch.info] change the value of channel to your Twitch channel.
Finally change the value of bot_account to the Twitch channel of your bot. You can also use your streaming account for this.
Save

Hotkeys

Under [hotkeys] in config.toml you can bind actions to hotkeys and choose to enable/disable hotkeys to easily perform actions.

Possible field names:

lock
cancel
resolve_<1-10> **by default only the first four outcomes are made into a hotkey.

List of available keys

Additional configuration

Under [messages] you can edit the messages of the bot on different events.
Under [permissions] you can allow or disallow mods and VIPs to use commands.

Managing predictions

Run manager_v2.pyw

Here you can create predictions for every split for multiple categories

Add one or more categories: click top left on File > Open and select 1 or more .lss files
Add or edit a prediction: select your desired category/split, fill in the form and click Save Prediction
Delete a prediction: select your desired category/split and click Delete
Make a category's predictions active: select your desired category and click the blue button

The yellow stars indicate which category is active and which splits have predictions respectively.

*If you add splits often and you want to add a prediction for those splits you can rename any split in the Splits list to that split and make the prediction that way. The order or missing splits is irrelevant. The split list is more of a convenience feature. And if you want a prediction for every split well :(

Usage

Authorization

Run authorize.py. The script will ask you to authorize with a bot or streamer account and will then open your default browser. Make sure to authorize the correct account.

You need to run authorize.py twice, once for a streamer account and once for a bot account. You can use your streaming account as bot if you want to. The bot should probably be VIP or Mod to circumvent any slowdown in chat. I only tested thoroughly with Mod status.

If both accounts are authorized you should only need to rerun authorize.py if you change your Twitch password or disconnect the integration which you can do on this page under Other Connections.

Livesplit

You can make predictions start automatically based on Livesplit splits by using the Livesplit Server component. You know it works when you right click on Livesplit, Control and Start Server should be there.

Make sure to start Livesplit Server before you start the bot.

If you added predictions with manager_v2.pyw a prediction should start when the given split name starts.

The default port on which Livesplit Server runs is 16834, if you're using a different port, you must also change the port in config.toml under [livesplit].

Starting the bot

Run electrobot.py

If all was configured correctly you should see this:

Chat commands:

The broadcaster and moderators can use these commands:

Start predictions with pred start <name>
- <name> must correspond to the Name field of a prediction
Lock predictions with pred lock or wait until the timer runs out
Resolve predictions with pred outcome <1-10>
Cancel predictions with pred cancel
!modcommands shows this above list

Only the broadcaster can use hotkeys

Examples:

rayer456 / electrobot