goub

osu! User Beatmap Downloader

About being flagged as virus.

Installation

There are two ways:

Precompiled Executable from Releases

• Download a precompiled executable from Releases.
• Place it anywhere on your computer.
• Run the executable using your command-line interface of choice.

Compile Yourself

• Install Go from the official website.
• Clone this project using Git or download source code directly from Github.
• Open your command-line interface of choice (e.g. cmd for Windows users) in the project directory.
• Run go get to download necessary dependencies.
• Run go build to build an executable file.
• Place the compiled executable anywhere on your computer.

You can also add the executable to path, which lets you use the executable from any directory on your computer:

• Add the path to that file in PATH environment variable. Windows tutorial here.
• Restart your command-line interface.

How to Use

You can access the help command using --help or -h.

Configuration file generation

Configuration file generation is fairly straightforward. The following command will create a configuration file in your home directory.

goub generate_config --client_id YOUR_CLIENT_ID --client_secret YOUR_CLIENT_SECRET

Obviously, replace YOUR_CLIENT_ID and YOUR_CLIENT_SECRET with your osu! API v2 credentials.

Downloading beatmaps

The following downloads all Ryuusei Aika's ranked and favorite beatmapsets.

goub download -u 7777875 --ranked --favorite

You can also specify output path. The following command downloads all Ryuusei Aika's ranked and favorite beatmapsets to my songs folder.

goub download -u 7777875 -r -f -o C:\Users\Kris\AppData\Local\osu!\Songs

goub --help for more.

Todo

• Ability to download top plays (im lazy)
• Recursively download user's favorites and the favorite beatmapset's creator's favorite beatmapsets and so on.