A Discord bot that allows you to track osu! things. It has some useful commands too.
- Join the PippiTrack Discord server
- Create an issue on this repository.
- Contact me on Discord (Keziah#6631)
See documentation at https://pippitrack.com/
Start by linking your Discord account to an osu! username like so :
/link <username> <mode>
After inviting the bot to your server, you need to configure it.
/configure
Track a user (top plays, weekly updates and replays) You can track up to 100 players.
/track <username>
/untrack <username>
/tracklist <?page>
Update an osu! profile via osu!track
/update <?username>
Display peak rank and accuracy of a player
/score <?username>
/gifted <?username>
/peak <?username>
Display your profile stats via osu!sig
/osu <?username>
Tracked players are queued for an automatic osu!track update. (Once a day)
Tracked players that use o!rdr will have their replays sent in the replay channel. (if set)
Have Node.js (version 16.8.x or newer) installed.
npm install
Then copy the .env.example
to .env
and fill in the values.
To run the bot in development mode run :
npm run dev
To run the bot in production mode run :
npm run build && npm run start
Commands are classes that exports a run
method and several properties.
class Command {
name = 'command-name' // !command-name
arguments = ['username'] // Accepted arguments for the command !command-name <username>
description = 'Description of the command' // Used for the !help command
category = 'general'
async run(message, args) {}
}
Services needs to export a function that triggers the service (running a cron job, etc)
The Bot.js
file is used for the internal logic of the bot.
We'll add listeners to the bot's events and handle the commands.
- https://ameobea.me/osutrack/ osutrack is a statistics tracker for the game osu!. It stores user information in a database and creates graphs and displays statistics showing how that users' stats changed over time.. A project by ameobea
- o!rdr o!rdr is a free online tool to make renders of osu! replays using Danser. Made by MasterIO
- https://lemmmy.pw/osusig/ for the
!osu
profile image. Created by Lemmmy