A Discord bot that keeps track of members' osu! ranks and updates their roles accordingly.
- Updates roles every 12 hours
- Users can pick their desired gamemode to be tracked
- OAuth2 authentication with osu!*
- Slash commands*
- Automatic role removal/added on registration (you can essentially lock people out of the server until they've registered)
- Blacklist osu! users
- Whitelist osu! users from certain countries
- Postgresql database
- Python 3.10+
- osu!API v2 API key
This README will assume you have managed to set all of these up correclty.
Both hosting options below require you to create a config.
Make a copy of config.yaml.example and remove the .example part. Now edit the config to your liking!
Run docker-compose up and you should be good!
- Install dependencies
python -m pip install -r requirements.txt
This assumes that python points to a python3.10+ installation.
- Run the bot
python src/run.py
If you don't feel like hosting the bot yourself you can invite our instance to your server!
Even though the bot has recently been rewritten, it is quite the mess. All contributions are much appreciated!
Please read CONTRIBUTING.md.