osu!fetch

Prints Information about your osu! Profile to the Terminal inspired by fastfetch/neofetch.

I made this project to learn rust so feel free to open an issue to suggest code improvements.

Installation

Windows

Make sure your terminal has true color support otherwise it won't work. (Old Windows 10 CMD is not supported for example) You can run the install script or download the exe from the Releases Tab

Arch Linux

yay -S osu-fetch-bin

Nix(OS)

nix profile add 'git+https://codeberg.org/tsuniko/osufetch'

Other Distros

rpm and deb packages can be found in the Releases Tab

First time setup

When you run osu!fetch for the first time it will ask you for your osu! user ID, Client ID and Client Secret

You can get your osu! user ID by copying the digits at the end of your Profile URL.

To obtain your Client Secret you will have to create a new OAuth Application in your osu! account settings.

Then you need to enter an Application Name (You don't need a Callback URL) You can put whatever you want in the Application name but i suggest naming it osufetch.

Once you press the "Register application" button you will be able to see your Client ID and Client Secret.

Now you can enter that into osufetch and you will be ready to go!

You can edit your config file at ~/.config/osufetch/config.toml to change what modules are displayed, the seperator and the color of text.

Configuration

Config example:

#You can get your Client ID and Client Secret by creating a new OAuth Application in your osu! Account settings.
#There is a more detailed explanation using Images on the Codebergs README.md (TODO: INSERT LINK HERE)
#Colors are RGB values
[user]
user_id = 27277272
client_id = 727272
client_secret = "meow"
[display]
modules = ["username", "join_date", "mode", "rank", "pp", "playtime", "playcount", "total_score", "ranked_score", "top_play", "badges", "country", "current_daily_streak", "best_daily_streak", "follower_count", "ranked_count", "loved_count"]
avatar = true
title = true
separator = ":"
avatar_size = 35
label_color = [200, 100, 100]
value_color = [100, 200, 100]

List of Modules