CUSTOM BOT SETUP GUIDE
This guide serves to help you set up your custom bot, with the instructions being as simple and clear as possible.
REQUIREMENTS
The bot needs a few other things installed to function properly:
You will also need a Twitch account specifically made for your bot to use, don't use the account you'll actually be streaming from. Make your bot a moderator in your chat, and if you use BetterTTV, make sure to add your new bot. All of your bots can use the same account.
- Python 3.7.0 is what the bot runs off of. If you have another version of Python installed, don't worry, you can install this separately.
- Microsoft Excel (or any .xlsx editor) is needed to edit the bot's settings file. We recommend LibreOffice as a free alternative.
You will also need a Twitch account specifically made for your bot to use, don't use the account you'll actually be streaming from. Make your bot a moderator in your chat, and if you use BetterTTV, make sure to add your new bot. All of your bots can use the same account.
SETTING UP YOUR BOT
Once you download your bot, extract the zip file anywhere you wish. However, please do not put the folder anywhere that may cause problems with admin privileges, such as the Program Files folders on your Windows drive.
Once extracted, open your bot's folder, then open the Setup folder inside of that. Run Install_Requirements.bat (if Windows gives you a warning, click "Run anyway"), a command prompt window will open up. Press any key, and it will install all the Python libraries the bot needs to function.
The bot will now automatically configure your authentication for you. You'll see a browser window open with Twitch authentication- please sign in using your channel's account, not your personal account. Once you sign in, you'll be prompted if you want to sign in with a second account.
If you want to have your bot chat through a separate account and not your channel, you can type Y at the prompt- otherwise type N. Once it says everything is set up, press any key to close the window, and you can close your browser window too.
If you encounter any errors, please contact me and I'll fix it ASAP! I probably just forgot a requirement to install.
Once extracted, open your bot's folder, then open the Setup folder inside of that. Run Install_Requirements.bat (if Windows gives you a warning, click "Run anyway"), a command prompt window will open up. Press any key, and it will install all the Python libraries the bot needs to function.
The bot will now automatically configure your authentication for you. You'll see a browser window open with Twitch authentication- please sign in using your channel's account, not your personal account. Once you sign in, you'll be prompted if you want to sign in with a second account.
If you want to have your bot chat through a separate account and not your channel, you can type Y at the prompt- otherwise type N. Once it says everything is set up, press any key to close the window, and you can close your browser window too.
If you encounter any errors, please contact me and I'll fix it ASAP! I probably just forgot a requirement to install.
Once all requirements have been installed, go back to the main bot folder, and you will see that a new Config folder has been created. Inside of it, you can ignore token.txt and puppet.txt - these are your auth tokens, so don't share them! Open Settings.xlsx with your spreadsheet editor of choice. This spreadsheet is where you go to edit your bot settings.
The "Option" column is the name of the setting, the gray "Your Setting" column is what you change to adjust the setting, and the "Description" column is a short description of what the setting does.
Your settings will be specific to your bot, so please ask me if you have any questions about your settings!
The "Option" column is the name of the setting, the gray "Your Setting" column is what you change to adjust the setting, and the "Description" column is a short description of what the setting does.
Your settings will be specific to your bot, so please ask me if you have any questions about your settings!
USING YOUR BOT
With all the settings and authentication set up, you're ready to go! In the main folder, you'll see RunBot.exe - I recommend that you right click on it and run it as Administrator for best compatibility. Once you start it, you'll see a console window appear and the bot will start.
If everything goes right, you should see "Connection to chat successful" appear. After you see this message, all messages in your channel's Twitch chat will appear in the console, now including channel point redemptions, subscriptions, and bits cheered.
If everything goes right, you should see "Connection to chat successful" appear. After you see this message, all messages in your channel's Twitch chat will appear in the console, now including channel point redemptions, subscriptions, and bits cheered.
At this point, your bot is fully working. You can test out the commands I wrote for you by running them either in chat or in the console, and you can stop the bot by typing stop in the console. If chat doesn't appear as expected or commands don't work, please ask me!
UPDATING TO A NEW VERSION
I will notify you as soon as a new version is available. Releases are accessible via github, and you'll be linked a github page for your bot once I have a first working version. When a new version releases, simply download the bot again and extract the zip file to your install folder, overwriting when asked. If there are any new settings, the bot will automatically add them the first time it is run. Remember to start the bot after updating, and it will let you know if any new settings have been created. Run RXBot to check if any new settings have been added, you will be notified if so.