Main repository for the multi-platform, novelty and utility chatbot Supibot.
Supibot can and is currently run on four distinct chat platforms:
Pick your platform, and follow these steps:
| Platform | Directions |
|---|---|
| Twitch channel | Fill out this form. |
| Discord server | The administrator of given server should PM me on Discord - simply join my server and you can PM me immediately. Keep the Discord-specific rules in mind too! |
| Cytube room | Fill out this form. |
| IRC channel | Currently only active on Libera. Contact me for more info. |
To contact me, see Contact on my website.
It's possible to host your own instance of Supibot. You can either set it up as a node app manually, or use the docker image. Follow this guide if you are interested, and contact me if you have any questions or notes.
Importantly, the bot can be run and used for debugging without authenticating to any actual chat platforms.
By default, Supibot exposes port 11001 to a simple TCP connection, usable via utilities such as ncat.
Do keep in mind that this example uses a debugging fork of Supibot which uses the * character as its prefix.
By default, the DEBUG_NET_EDIT_USER env variable is set, so you will be able to create a user on the go, and even set them as admin.
If you want to change this port, it is defined as the port option within platform net's configuration in config.json.
Do keep in mind that when running via Docker, the configuration of exposed ports also needs to change accordingly in docker-compose as well.
Also by default, Supibot runs in debug mode with the default Chrome DevTools port open (9229).
This allows connecting via the chrome://inspect tool.
Finally, check out the "usageGuide" text in config.json for a brief guide on how to enable/disable a specific set of commands or other modules.
Owners of channels (or Discord servers) have elevated rights to manage Supibot. They are allowed to e.g. disable specific commands, ban users from specific commands or ban them outright - all in the scope of their channel/server.
If the channel/server owner wishes to delegate this power to one or more users, they should:
- For Discord, either:
- appoint the user as an administrator
- create a role named "Supibot Ambassador" and assign the user to it
- For other platforms: create a suggestion (
$suggestcommand) explaining that they wish to assign an ambassador(s) in a channel. Make sure to list their names and your channel's name
The DankChat mobile application for Twitch chat uses Supibot's API in order to hint its commands in any channel Supibot is actively in! It's a wonderful app to use on the go, and I endorse it.