A basic Twitch bot that relies on PyAutoGUI to run Aerolith (https://www.aerolith.org/) on stream. GUI built using PySimpleGUI (command line window still pops up to facilitate easier debugging). Credits to César Del Solar for helping to build an API to facilitate this, and many other Scrabble players for helping to test this out and share suggestions.
config.json
This is the configuration file to connect the bot to a Twitch account. Place it in the same folder as AerolithOnStream.exe or AerolithOnStream.py. The below example has fake credentials supplied:
{
"irc_token": "oauth:ab2cefg45hika25mntu34dsffsa143v3",
"nick": "bot_account",
"channel": "streamer",
"theme": "Dark Black",
"input_background": "#16161d",
"font": "Arial",
"colours": ["yellow", "#bdb7ab", "sandy brown"],
"box_height": [25, 5, 5]
}
Instructions adapted from https://github.com/danibarker/TwitchBot (the most awesome Scrabble bot in existence!) You can run AerolithOnStream.py if you have python, or the exe if you don't.
1. Create a new Twitch account with the username you want the bot to have and log in.
2. Go to https://twitchapps.com/tmi/ and click Connect. Copy what is in the text box including "oauth:".
3. Open config.json and replace the lines with your information before saving it. Be sure to leave the variables in quotes:
irc_token is the oauth, make sure it includes the text "oauth:" and not just the rest of the string
nick is your bot's username
channel is your stream channel (in lowercase)
theme is your preferred theme (default is Dark Black - you can select your favourite at https://pysimplegui.readthedocs.io/en/latest/cookbook/#themes-window-beautification)
input_background is the colour of the box showing the guesses and scores
font is your preferred font
colours are your preferred three colours for the top three positions - you may refer to https://github.com/PySimpleGUI/PySimpleGUI/blob/master/DemoPrograms/Demo_Color_Names_Smaller_List.py for colour names or use hex codes
box_height are your preferred number of rows to show for guesses, correct answers and wrong answers.
4. That's it, run AerolithOnStream.exe or AerolithOnStream.py and you should see a message on the console saying "Bot <Bot's nick> has joined the channel <Streamer>!"
5. You will need to have the PyAutoGUI and PySimpleGUI packages installed to run AerolithOnStream.py.
1. First, start up your Aerolith session and enter a room / table. Copy the room / table number.
2. Paste the room / table number into the "Room Number" field.
3. Start the round on Aerolith BEFORE clicking "Start" in the program. The bot will send the message "Starting Aerolith On Stream!"
4. After this, the bot will type out and enter stream chat messages sent - so switch your cursor back into Aerolith. (WARNING: Do not put your cursor in Twitch chat or the account that is logged in will start spamming!)
5. The bot will only send guesses if the letters in the stream message match one of the words in the quiz.
6. The bot will automatically deactivate when the quiz timer has expired. You can also manually deactivate it by typing in "!end" (streamer only) or clicking on "End" in the program.
7. To begin a new round, once again, start the round on Aerolith before clicking on "Start" in the program (staying in the same room / table will eliminate the need to update it).
8. To clear the scoreboard and "nopeboard" in between rounds, uncheck "Retain scores across rounds" before clicking "Start" in the program.
9. If you're playing Polish or Spanish Aerolith, you can check "Convert special characters into English letters" if you're using an English language keyboard, before starting the game. While Aerolith On Stream will record your guesses and score, your guesses with English letters will not be typed into Aerolith with the special characters.