CoWorkingTwitchBot

A Twitch Co-Working Bot that will allow chat to run their Pomodoros and add tasks. Sends a message in the chat once the time for a session is up. Also outputs the tasks to the website or file output that can be added on stream as an input for your stream set-up.

Credits to:

• @Patriick for the Testing and suggestions.
• @RumpleStudy for the original Bot idea.
• @tabi_katze and @undefined_dot_json, the devs of the original pomo bot.

❖ How to use the !pomo command ❖

You can use the !pomo command to set your own personalised timer and appear on the stream! Simply type !pomo [number] to set a timer in minutes.

More details:

• '!pomo <work mins> [break mins] [num sessions] [task]'. E.g. !pomo 25 5 4 Essay.
• '!pomo complete' --> cancel your sessions
• '!pomo check' --> check your timer
• '!pomo +/-<mins>' --> edit your timer
• '!task <task>' --> create a task (and replace the done task if any)
• '!done' --> complete your task but keep it on the board
• '!finish' --> complete your task and remove it from the board

How to Run the Bot

On Replit:

1. Create an account for the Bot
2. Create an application in the bot account using twitch.tv dev console (you will need to activate 2FA for this). Set the URL to "https://twitchtokengenerator.com"
3. Use the token generator link to generate an Auth token.
4. Create a Replit Account
5. Fork this Repl
6. Set the Environment Variables from the left hand bar of Repl (set the "AUTH_TOKEN" to the auth token you get from Step 3 and "BOT_NAME" to the username of your bot)
7. Run it. You should see "Logged in as | <bot name>"
8. Using your streaming account visit the bot's twitch chat and type in "!hello" to test if bot is working.
9. Using the streaming account type in "!join <your stream account username>"
10. Type "!hello" in your stream chat to test the bot
11. Type "!pomo <work mins> [break mins] [num sessions] [topic]" to run the bot
12. Open up the website window from the right hand side of the Replit and then type in your stream account username to see the board. Add the URL to your OBS browser source

When running next time just run the Repl and it should work. Indicated by a message of "<bot name> has landed!"

Locally:

1. Follow steps 1-3
2. Go to 'bot.py' and replace the 'os.environ["AUTH_TOKEN"]' with the Auth token and 'os.environ["BOT_NAME"]' with your stream account username.
3. Type "!hello" in your stream chat to test the bot
4. Type "!pomo <work mins> [break mins] [num sessions] [topic]" to run the bot
5. Add the text file named "<your stream account username>pomoboard.txt" to your stream setup as a text source

Please contact me for any questions or suggestions.