Skip to content

Repository files navigation

Showerbot

Discord bot for osu! based on Bathbot.

This is a self-host bot meaning you can't invite an existing bot, you must run it yourself.

Commands

It only has the following commands:

  • Prefix:
    • <help: Display help for prefix commands
    • <ping: Check if the bot is online
    • <nlb: Display the national leaderboard of a map
  • Slash:
    • /pingnlb
    • /nlb

Setup

  • Before starting, be sure you have access to an osu! account that has supporter. The bot will be able to show the national map leaderboards of that user's country.
  • Copy-paste the content of the .env.example file into a file called .env and fill in all required variables

Binary

  • Download a binary from the releases page for your operating system and put it next to the .env file
  • Run the binary

Docker

  • Download the docker-compose.yml and put it next to the .env file
  • Optionally set PUID and PGID in your .env to match the owner of your maps directory on the host (defaults to 1000)
  • Optionally set MAPS_DIR in your .env to the directory containing your .osu files on the host (defaults to ./maps)
  • Run docker compose up -d

About

Tiny discord bot for osu! to show national map leaderboards

Resources

Stars

Watchers

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages