Skip to content

A Discord bot for displaying recent and overall osu! scores. Not affiliated with osu! or ppy in any way.

License

Notifications You must be signed in to change notification settings

azn-abel/OsuBot

Repository files navigation

OsuBot

A basic Discord bot for displaying recent and overall osu! scores. The aim of this bot is to provide a way for casual osu! players to share their accomplishments with each other. Commands and other features will be added upon request, and as I see fit. Basic documentation for this bot can be found below, and detailed documentation will be added to the wiki page once it is ready. Hope you enjoy!

Add this bot to your Discord server: Click here

Basic Commands

Quick note: for any username in any command, if the username contains spaces, "it will need quotation marks around it".

osu!link

Before interacting with the bot, it's recommended that you link your osu! account to your discord account using osu!link [username] [preferred_mode]. This will allow you to easily retrieve your own stats and scores by allowing you to type "me" instead of your full username when using commands. For example, you'd be able to use osu!recent me instead of osu!recent full_username.

Note: before running the osu!link command, you must provide your Discord username in your profile setting on https://osu.ppy.sh/home/account/edit, as shown below:

Return to table of contents

osu!info

Using osu!info [username] [mode] will return and display the cumulative stats of the specified user in an optionally specified mode. If the mode is not specified, it displays the user's stats for osu! standard.

Return to table of contents

osu!recent and osu!top

Using osu!recent [username] [mode] displays the specified user's most recent play in an optionally specified mode. If the mode is not specified, it displays the user's most recent play for osu! standard. This is useful for sharing accomplishments to members of a Discord server as they happen in real time.

Return to table of contents

Using osu!top [username] [mode] similarly displays a specified user's top play.

Return to table of contents

Adding a -d clause to the above will provide a more detailed response that covers the users top 5 most recent scores or highest pp plays.

Return to table of contents

osu!plot

Using osu!plot [username] [mode] will display basic statistics on the user's top 100 plays in an optionally specified mode, as well as a histogram showing their distribution. If the mode is not specified, it displays the user's stats for osu! standard.

Return to table of contents

osu!bar

Using osu!bar [mode] [number] displays the following embed, containing a list of countries that top osu! players are from, as well as a bar chart showing their distribution. The command can take optionally specified arguments mode and number, which default to osu! standard and 100 users, respectively. With higher numbers, the resulting bar chart may be hard to read due to how many countries are shown. If this is the case, you can click on the image to expand it.

Return to table of contents

About

A Discord bot for displaying recent and overall osu! scores. Not affiliated with osu! or ppy in any way.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published