Repository navigation
KuroBot v1.0.0
The first official version of KuroBot!
I'm proud to present to you all: KuroBot. A super fun project by _Kurookami_ to create an all-in-one Twitchbot which is specialized for osu! streamers.
If you have already completed the setup for an earlier version, you can just download the KuroBot.exe and replace the one you already had in the folder. No additional setup needed after the first time.
Features
Commands
It can do a bunch of things that are pretty basic for all Twitchbots, like !lurk, !followage and !shoutout, just to name a few. I've also made some specific commands for osu!, like !rank, !profile and !osustats. Special thanks to @IanRockwell for the !np and !nppp commands. You can view the full list of commands here: The KuroBot website!
Points System
I'll gladly introduce the points system of this bot. Viewers can earn points by being active in the chat. For every message that's sent, the bot will look at the length of the message and calculate how many points the user earns based on this formula:
min(15, round(len(message.content) / 4))There are also some rewards users can claim if they have enough points. Some examples of these are: !memecam, !bonk and a command I'm really proud of: !vip.
Redemptions Listener
This is another feature I'm really proud of. The downside of this feature is that you have to be either an Affiliate or Partner to be able to use it. Upon turning this on when starting the bot, it will look for all Twitch Channel Points Redemptions that are being claimed during the entire runtime of the bot.
The current version of this Redemptions Listener only looks for redemptions that start with Exchange. It will then look for the amount of Channel Points this redemption costed, and add this amount to it's own points system.
Dashboard
The last big thing I added to the bot is a locally running dashboard. Right after the bot starts up, you will see a browser page pop up with the dashboard page, running on http://localhost:7273/. Here you can see the top 5 points earners in your personal bot's points system, your current osu! rank + Twitch title, and also the status of the features you enabled / disabled when starting up the bot. Along with just viewing the enabled options, you can also toggle the option that controls the !rq command. This command will tell the chat whether you will accept map requests or not.
A full list of all the commands is available on https://clflix.github.io/KuroBot/commands, as well as a very quick and basic overview of the features it has on the homepage.
Suggestions / Bugs
Bugs
If you encounter a bug while running the bot, you can create an Issue on the Issues page. I have a bug reporting template in there, so be sure to use it and don't mind telling me I should improve it if you think so. 😅
Suggestions
Would you like to see a new feature in the bot? Go ahead and create a Discussion post under the tab "Suggestions" in the Discussions page!