I complement the sender of a message with a 3.33% (by default) chance. I currently have about 50 ways to complement you, which you can extend yourself, or disregard completely.
Note that you might need to VIP me in your chat, especially if your viewers tend to make heavy use of the !complement command - this is because Twitch seems to count many bot messages as spam, and mutes/times out the bot.
If, for whatever reason, you decide to change your Twitch username, know that the bot will NOT be in your chat if you don't take action. You will have to come into the bot's channel chat and type !refresh. MAKE SURE you run the !refresh command after changing your username, as if you change your username a second time without having run the !refresh command after the first time you changed it, you will not be able to get the bot to join your chat on your own (i.e. you will have to contact me and get me to run the !refreshall command)
The following commands work anywhere that I have joined:
-
!complement <username> - If username provided, complement that user; otherwise, get a complement yourself! Note that even if command complements are disabled (!disablecmdcomplement), mods and the broadcaster are still able to use this.
-
!compignoreme - I will stop complementing you (see !ignoreme in '[ComplementsBot chat only](#ComplementsBot chat only)'); note that this command gives no feedback whether it was successful
-
!compunignoreme - undo !compignoreme/!ignoreme (see in '[ComplementsBot chat only](#ComplementsBot chat only)'); note that this command gives no feedback whether it was successful
Say these commands in my channel chat (https://www.twitch.tv/complementsbot):
-
!joinme - I will join your channel; if you change your Twitch username, you might need to use this again before I can chat in your channel again. Don't worry, all of your custom settings (such as complement chance, custom complements etc.) will be restored for your new name - no data is lost.
-
!leaveme - I will leave your channel, but keep your settings in case you decide you want me back
-
!deleteme - I will leave your channel and delete all of your settings; this does not affect your ignored status, so if you did !ignoreme, I will still know that you don't want to be complemented after doing !deleteme, and your twitch username/user id will still be stored in my database. If you don't want this, then also do !unignore me - this will remove any reference of you from my database
-
!userid - returns the twitch user's ID from their username; if no name specified, returns ID of caller
-
!username - returns the twitch user's name from their ID
-
!ignoreme - I will stop complementing you
-
!unignoreme - undo !ignoreme
-
!count - Check out how many channels I'm in
-
!about - Learn all about me
These commands must be used by the channel owner in their own channel:
-
!compleave/!compleaveme - same as !leaveme, but you can do it in your own channel.
-
!setchance - change how likely it is that person sending message gets complemented; default is 3.33%; setting it to a number over 100 makes it always trigger, and to 0 or less to never trigger
-
!addcomplement/!addcomp <complement> - add a custom complement for to your own channel
-
!removeallcomplements/!removeallcomps - removes all custom complements added by you
-
!removecomplement/!removecomp <phrase> - remove a complement from your own channel; the complement which gets removed is one which contains "phrase" in it, after "phrase" has gone through the process of:
- all non-alphanumeric (numbers and letters) characters get removed; this includes spaces
- all letters in "phrase" get converted into lowercase
- the resulting string (which was originally "phrase") will be compared to all custom complements with the same two things done to them, and any complement containing the phrase will be removed.
- any removed complements will be showed in the chat
- this might get the bot timed out/banned from your channel, especially if you are removing a lot of custom complements. Consider VIPing it if you plan on using it!
- Example usage: say that one of your custom complements is "You arw an awful person!"; you can remove this by typing '!removecomp youar wa', assuming no other custom complements contain the phrase 'youarwa' after having gone through the above process.
-
!disablecmdcomplement/!disablecommandcomplement/!disablecommandcomp/!disablecmdcomp - ComplementsBot will no longer send out complements when a viewer uses the !complement command; by default, this is off
-
!enablecmdcomplement/!enablecommandcomplement/!enablecommandcomp/!enablecmdcomp - undoes !disablecommandcomplement; this is the default
-
!disablerandomcomplement/!disablerandcomplement/!disablerandcomp/!disablerandomcomp - ComplementsBot will no longer send out complements randomly; by default, ComplementsBot does randomly send out complements
-
!enablerandomcomplement/!enablerandcomplement/!enablerandcomp/!enablerandomcomp - undoes !disablerandomcomplement; this is the default
-
!setmutettsprefix - the character/string to put in front of a message to mute TTS (text-to-speech); default is "!"
-
!mutecmdcomplement/!mutecommandcomplement/!mutecommandcomp/!mutecmdcomp - mutes tts for complements sent with !complement command; this is the default
-
!unmutecmdcomplement/!unmutecommandcomplement/!unmutecommandcomp/!unmutecmdcomp - undoes !mutecmdcomplement;
-
!muterandomcomplement/!muterandcomplement/!muterandcomp/!muterandomcomp - mutes tts for complements randomly given out;
-
!unmuterandomcomplement/!unmuterandcomplement/!unmuterandcomp/!unmuterandomcomp - undoes !muterandomcomplement; this is the default
-
!disablecustomcomplements/!disablecustomcomps - I will not complement people using your own complements
-
!enablecustomcomplements/!enablecustomcomps - I will complement people using your complements; this is the default
-
!disabledefaultcomplements/!disabledefaultcomps - I will not complement people using the default complements
-
!enabledefaultcomplements/!enabledefaultcomps - I will complement people using the default; this is the default
-
!listcomplements/!listcomps - lists all complements which have been added; this might get the bot timed out/banned from your channel, especially if you have a lot of custom complements. Consider VIPing it if you plan on using it!
-
!ignorebots/!ignorebot - ignores users whose name ends in 'bot' for random complement (they can still be manually complemented using the !complement command if command complements are enabled (!enablecmdcomplement)); this is the case by default
-
!unignorebots/!unignorebot - undo ignorebots; by default, bots are ignored.
The following commands have not been implemented yet, but are planned to be:
These commands must be used by the channel owner in their own channel:
- !getcomplement <index> - shows you the complement of specified index number
- commands which will allow channel owners to change who can use which command (user groups would be: channel owner, moderators, VIPs, subscribers, regular user <- this one would allow everyone)
Twitch channel: https://www.twitch.tv/complementsbot
Also check out https://www.twitch.tv/ereiarrus (if I ever decide to stream...)
YouTube channel: https://www.youtube.com/channel/UChejDismPBRIXFUNC-hB_bQ
Donations to my PayPal are appreciated, but never necessary: [email protected]
I followed https://dev.to/ninjabunny9000/let-s-make-a-twitch-bot-with-python-2nd8 to get started, along with looking at https://github.com/TwitchIO/TwitchIO for examples to build upon:
- Make sure you have Python installed (Python 3.12 was used): https://www.python.org/downloads/
- Run pipenv: pipenv --python 3.12
- pipenv install twitchio
Make sure create a .env file in the src directory with the following variables:
- TMI_TOKEN= get your token from https://twitchapps.com/tmi/
- DATABASE_URL= the URL to your realtime database as shown in firebase
- CLIENT_SECRET= go to https://dev.twitch.tv/console/apps, click 'Manage', and generate a 'New Secret'.
(alternatively, you can set these as environment variables, and do export for each one:
export TMI_TOKEN; export DATABASE_URL; export CLIENT_SECRET;).
Also put these environment variables as repository secrets on GitHub, and either as a file or environment variables on your server.
Once you have your firebase app, go to 'Service accounts' in project settings. From here, generate a new private key, and save the file as '.firebase_config.json' in the src directory. Also save the contents of the '.firebase_config.json' file as a repository secret called 'FIREBASE_CONFIG'.
Create a Realtime Database in firebase with private access.
set up SSH key on server:
- ssh-keygen -t ed25519 -C "<your GitHub email here>"
- eval `ssh-agent -s`
- ssh-add ~/.ssh/id_ed25519
- cat ~/.ssh/id_ed25519 - then add this into your repository secrets as 'SSH_KEY'
- will possibly also need to
chmod 700 ~,chmod 700 ~/.ssh,chmod 700 ~/.ssh/authorized_keys(see https://unix.stackexchange.com/questions/407394/ssh-copy-id-succeeded-but-still-prompt-password-input for more)
Inside your repository secrets (on GitHub), also add:
- HOST_IP= the IP address of your server
- DEPLOY_TARGET_LOCATION= where on your server you want the repo files to get copied to (to then have a docker container created out of)
- VPS_PORT= by default, this is 20, however, you might need to edit it if your FTP port is different.
- VPS_USERNAME= the user through which you are accessing your server (preferably NOT root)
At the end of the day, you should have the following repository secrets: CLIENT_SECRET, DATABASE_URL, DEPLOY_TARGET_LOCATION, FIREBASE_CONFIG, HOST_IP, SSH_KEY, TMI_TOKEN, VPS_PORT, VPS_USERNAME
- git pull the repository
- make sure python is installed (ideally with the same version as used for the program, in this case 3.12); also ensure pip was installed with it
- install requirements: python3 -m pip install -r requirements.txt
- make .env and .firebase_config files to match your local ones (NEVER PUSH THEM TO GITHUB!)
- start up the program either directly in the background:
python3 main.py > /dev/null 2>&1 &, or as a daemon:setsid python3 main.py >/dev/null 2>&1 < /dev/null &
This is the better option than just running it directly.
Mostly following instructions from https://docs.docker.com/engine/install/centos/ and https://docs.docker.com/engine/install/linux-postinstall/ in this part
First, we have to make a clean installation of Docker on the server (example is for CentOS):
sudo yum remove docker docker-client docker-client-latest docker-common docker-latest docker-latest-logrotate docker-logrotate docker-enginesudo yum install -y yum-utilssudo yum install -y docker-composesudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.reposudo yum install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin -y- If prompted to accept the GPG key, verify that the fingerprint matches 060A 61C5 1B55 8A7F 742B 77AA C52F EB6B 621E 9F35, and if so, accept it.sudo systemctl start docker- verify it works using
sudo docker run hello-world
Add user to the docker usergroup:
sudo groupadd docker- create it in case it doesn't exist- possibly need to
rm -rf ~/.docker sudo usermod -aG docker <username>, and relog into account
Start docker on boot:
sudo systemctl enable docker.servicesudo systemctl enable containerd.service
Or to disable it on boot:
sudo systemctl disable docker.servicesudo systemctl disable containerd.service
Docker makes log files that could get out of hand (https://docs.docker.com/config/containers/logging/json-file/)
in /etc/docker, create a daemon.json file with contents:
{ "log-driver": "json-file", "log-opts": { "max-size": "30m", "max-file": "3" } }
Docker has to be restarted before these changes take place; existing containers do not use the new config.
Finally, to start the app (i.e. run the container):
docker run --log-driver json-file --log-opt max-size=30m --log-opt max-file=3 complements-bot-py
Here I make use of in-line logging alterations --log-driver json-file --log-opt max-size=30m --log-opt max-file=3.