CynanBot Commands
!commands
Provides a link to this website.
Example usage
!commands
!supertrivia <optional amount parameter>
You can only use this command if you have been added to the channel's list of trivia game controllers.
Starts a new super trivia game.
Example usage
!supertrivia
Optionally, you can start a super trivia game, while also queue'ing up several more in line behind it.
Example usage
!supertrivia 3
!givecuteness <username> <amount>
You can only use this command if you have been added to the channel's list of trivia game controllers.
Gives a user some amount of cuteness. Note that amount can be a negative number. This is mostly intended for situations where a user clearly got a question correct, but failed/stumbled in some other way, like CynanBot didn't recognize the answer as correct for example.
Example usage
!givecuteness smcharles 20
!cuteness <optional username parameter>
Prints out your own current cuteness, plus the current top 10 leaderboard.
Example usage
!cuteness
Optionally, you can query for someone else's cuteness by specifying their username.
Example usage
!cuteness smcharles
!cutenesschampions
Prints out the channel's cutest users (cumulative). This is essentially a "top 10 of all time" list.
Example usage
!cutenesschampions
!cutenesshistory <optional username parameter>
Prints out the channel's cutest users for the past 3 months.
Example usage
!cutenesshistory
Optionally, you can query for someone else's cuteness history by specifying their username.
Example usage
!cutenesshistory smcharles
!mycuteness
Prints out your own total cuteness, your best ever cuteness month, and your recent cuteness history.
Example usage
!mycuteness
!triviascore <optional username parameter>
Prints out your own trivia score.
Example usage
!triviascore
Optionally, you can query for someone else's trivia score by specifying their username.
Example usage
!triviascore smcharles
!bantriviaquestion <trivia emoji>
You can only use this command if you have been added to the channel's list of trivia game controllers.
Every trivia question is tagged with a consistent emoji at the beginning of the chat message. Use this emoji with the command.
Example usage
!bantriviaquestion 🍌
!triviainfo <trivia emoji>
You can only use this command if you have been added to the channel's list of trivia game controllers.
Displays miscellaneous debug information about a trivia question. This command doesn't really do a whole lot, and is mostly just intended for general question curation purposes.
Example usage
!triviainfo 🍎
!addtriviaanswer <trivia emoji>
You can only use this command if you have been added to the channel's list of trivia game controllers.
Adds an additional answer to a question/answer style trivia question. This is intended to be used for situations where it could be understood that someone answered correctly, but the bot just didn't catch it. For example, someone answered a question with a first and last name, but the question required a first name, middle name, and last name too.
Example usage
!addtriviaanswer 🍐 Benjamin Franklin
!gettriviaanswers <trivia emoji>
You can only use this command if you have been added to the channel's list of trivia game controllers.
Retrieves the list of additional answers that a trivia question has. This list could be empty.
Example usage
!gettriviaanswers 🐬
!deletetriviaanswers <trivia emoji>
You can only use this command if you have been added to the channel's list of trivia game controllers.
Deletes the list of additional answers that a trivia question has. This command will also show you the additional trivia answers that the question had (if any).
Example usage
!deletetriviaanswers 🐅
!clearsupertriviaqueue
You can only use this command if you have been added to the channel's list of trivia game controllers.
Completely clears out the queue of pending super trivia games.
Explanation: if the !supertrivia command is used while another super trivia game is already in progress, that new game will queue up, and will automatically begin once the current super trivia game is finished. This can occur continuously, so that a rather large queue could eventually build up.
Example usage
!clearsupertriviaqueue
!addtriviacontroller <username>
Only the streamer can use this command.
Adds a user to the channel's list of trivia game controllers.
Example usage
!addtriviacontroller smcharles
!gettriviacontrollers
Only the streamer can use this command.
Displays a list of the channel's trivia game controllers.
Example usage
!gettriviacontrollers
!removetriviacontroller <username>
Only the streamer can use this command.
Removes a user from the channel's list of trivia game controllers.
Example usage
!removetriviacontroller smcharles
!addglobaltriviacontroller <username>
Only the CynanBot administrator can use this command.
Adds a user to the list of global trivia game controllers.
Example usage
!addglobaltriviacontroller smcharles
!getglobaltriviacontrollers
Only the CynanBot administrator can use this command.
Displays the list of the global trivia game controllers.
Example usage
!getglobaltriviacontrollers
!removeglobaltriviacontroller <username>
Only the CynanBot administrator can use this command.
Removes a user from the list of global trivia game controllers.
Example usage
!removeglobaltriviacontroller smcharles
!addbannedtriviacontroller <username>
Only the CynanBot administrator can use this command.
Adds a user to the list of banned trivia game controllers. These users do not have access to any privileged trivia command in any channel.
Example usage
!addbannedtriviacontroller a_n_i_v
!getbannedtriviacontrollers
Only the CynanBot administrator can use this command.
Displays the list of banned trivia game controllers. These users do not have access to any privileged trivia command in any channel.
Example usage
!getbannedtriviacontrollers
!removebannedtriviacontroller <username>
Only the CynanBot administrator can use this command.
Removes a user from the list of banned trivia game controllers.
Example usage
!removebannedtriviacontroller a_n_i_v
!addrecurringsupertriviaaction
Only the streamer can use this command.
Begins configuration of an automatically-recurring super trivia event. CynanBot will print out instructions in chat on how to configure this, please follow those instructions to finish the setup.
Example usage
!addrecurringsupertriviaaction
!removerecurringsupertriviaaction
Only the streamer can use this command.
Immediately removes the automatically-recurring super trivia event (if any).
Example usage
!removerecurringsupertriviaaction
!addrecurringcutenessaction
Only the streamer can use this command.
Begins configuration of an automatically-recurring cuteness leaderboard event. CynanBot will print out instructions in chat on how to configure this, please follow those instructions to finish the setup.
Example usage
!addrecurringcutenessaction
!removerecurringcutenessaction
Only the streamer can use this command.
Immediately removes the automatically-recurring cuteness leaderboard event (if any).
Example usage
!removerecurringcutenessaction
!addrecurringweatheraction
Only the streamer can use this command.
Begins configuration of an automatically-recurring weather event. CynanBot will print out instructions in chat on how to configure this, please follow those instructions to finish the setup.
Example usage
!addrecurringweatheraction
!removerecurringweatheraction
Only the streamer can use this command.
Immediately removes the automatically-recurring weather event (if any).
Example usage
!removerecurringweatheraction
!addrecurringwordofthedayaction
Only the streamer can use this command.
Begins configuration of an automatically-recurring Word Of The Day event. CynanBot will print out instructions in chat on how to configure this, please follow those instructions to finish the setup.
Example usage
!addrecurringwordofthedayaction
!removerecurringwordofthedayaction
Only the streamer can use this command.
Immediately removes the automatically-recurring Word Of The Day event (if any).
Example usage
!removerecurringwordofthedayaction
CynanBot Setup
#1 Install Git
git should be accessible via your system path. To confirm this, you can run git --version on the command line.
#2 Install Python
Python 3.12 is the lowest compatible version. This Python installation should also be accessible via your system path. To confirm this, you can run python --version on the command line.
If python --version does not work, you may need to restart your computer, or maybe try python3 --version instead.
#3 Create a new working directory for CynanBot and its Python environment
This is where CynanBot will be installed. I personally use C:\Apps\CynanBot Environment\.
Open up a command prompt and switch to the directory above where you want the CynanBot installation to be. So in my case, I am working within C:\Apps.
Run this command: python -m venv "CynanBot Environment"
#4 Clone the CynanBot repository
This is where CynanBot will be actually installed. I personally use C:\Apps\CynanBot Environment\CynanBot.
#5 Install DECtalk (if you are planning to use TTS)
I recommend placing this dectalk folder directly inside of your CynanBot working directory. So in my case, this is C:\Apps\CynanBot Environment\dectalk\.
#6 Get client ID and client secret for the Twitch account that you'll use
You can get those here for a Twitch account with developer credentials: .
#7 Fill in Auth Repository information
Using a text editor, open authRepository.json within the root CynanBot directory and fill in the necessary information.
#8 Fill in Users Repository information
Using a text editor, open usersRepository.json within the root CynanBot directory and fill in the necessary information.
#9 Activate CynanBot Python Environment
In your Windows command prompt: .\Scripts\activate
In your Linux terminal: source bin/activate