Twitch + Bancho chat bot for handling osu! related functions.
| License: | MIT |
|---|
- Sign in to https://gumiya.pmrowla.com/
- Link and verify your osu! account
- Configure and enable the bot
- Check the FAQ.
- Submit bug/feature requests via github issues (please check to see if your issue has already been posted first).
- For other generic help requests please try to refrain from cluttering up the github issues list and just ask in discord.
This intent of this project is to eventually have feature parity with the Mikuia osu! plugin. Currently working features include:
- Beatmap requests
- PP info for requests via Tillerino
- Optional request filtering based on star rating
- Optional subscribers only mode for map requests
- osu! player !stats command for Twitch chat
Gumiya is not intended to be a general purpose Twitch bot, and as such will never include support for non-osu! related Mikuia features.
- Mods for map requests can be specified with or without the leading
+and are not case sensitive. When mods are used, the bot output will always the display the modified AR, OD and BPM, but displaying modified star rating is dependent on Tillerino. If Tillerino is unavailable, or if Tillerino does not have a calculated PP or star rating for a certain map + mod combination, the nomod star rating will be used (see the HDDTHR example screenshot). - When filtering map requests by star rating, the filtering is done based on nomod star rating, regardless of whether the request specifies mods.
- Use docker-compose with
dev.yml(see docs from cookiecutter-django below). - Dev discord: https://discord.gg/JDZhNPG
- If you just want to run your own IRC bot for map requests on a single Twitch channel, a standalone version of the Gumiya bot is available as gumiyabot.
- If for some reason you are interested in running your own instance of the entire Gumiya bot + webapp server package, the whole thing is deployable with docker-compose.
See detailed cookiecutter-django Docker documentation for details.