Skip to content

About

osu!collector downloader & updater with multiple mirrors, collection.db generation, BBD search and more

Topics

Resources

Stars

102 stars

Watchers

2 watching

Forks

Repository files navigation

osu!collect banner

Free osu!collector downloader in your terminal

Build Latest release Downloads Platforms

Features · Install · Usage · Import · Configuration · FAQ · Wiki

osu!collect is a terminal app that downloads osu! beatmap collections from osu!collector. Paste a collection link, pick a folder, and every map batch-downloads using multiple mirrors in rotation with automatic failover. You also get a ready-to-import collection.db and ability to update the collections later.

osu!collect: paste an osu!collector collection, pick mirrors and a download folder osu!collect downloading a collection with live per-map progress, speed and ETA

Features

  • Free, no account needed, whereas the official osu!Collector app is paid.
  • Nine mirrors with automatic failover: osu!collect keeps downloading even when a few mirrors are throttled. See Mechanics.
  • Search for maps without a collection: per-diff criteria, auto-routed between the osu! api and nzbasic's community database. See Criteria.
  • A real osu! collection, verified: integrity-checked collection.db, ready to import directly into your preferred osu! client. See Verification.
  • Keep collections up to date: re-check a downloaded collection later, download only new or missing beatmaps. See Guide.

Installation

One-line install (recommended)

Linux x64 / macOS Apple Silicon:

curl -fsSL https://raw.githubusercontent.com/uwuclxdy/osu-collect/main/install.sh | bash

Windows x64 (PowerShell):

iwr https://raw.githubusercontent.com/uwuclxdy/osu-collect/main/install.bat -OutFile "$env:TEMP\osu-install.bat"; & "$env:TEMP\osu-install.bat"

Installs to %LOCALAPPDATA%\Programs\osu-collect, adds it to PATH, creates a desktop shortcut and registers in Settings -> Apps -> Installed apps. No admin needed.

Prebuilt binary

Download from Releases and run it in a terminal.

Note

osu!collect runs in a terminal. Windows users should be able to open it with a double click as well, but it's not guaranteed. Open an Issue if it doesn't work. Windows Terminal or PowerShell 7+ are recommended.

Install latest from source (Rust 1.85+)

cargo install --git https://github.com/uwuclxdy/osu-collect

Building from source and more: Installation in the wiki.

Uninstall

Windows: Settings -> Apps -> Installed apps -> osu!collect -> Uninstall.

Linux/macOS: run rm ~/.local/bin/osu-collect.

Usage

osu-collect

Paste a collection link, pick a directory, press ↵. The get maps tab has two more sources: find searches maps by per-difficulty criteria with no collection needed; update re-checks collections you downloaded and fetches only what's missing. Press ? in-app for every key.

Full guides in the wiki:

Importing into osu!

osu! lazer
  1. Import all downloaded maps into lazer.
  2. Click Run first time setup, then Next until the Import screen.
  3. Set previous osu! install to the folder of the collection you downloaded.
  4. Click Import content from previous version.
  5. Done. Both the maps and the collection are imported.
osu! stable

Drag the downloaded .osz files into osu!, then merge the generated collection.db with a tool like Collection Manager. If you have no existing collections, you can just replace your collection.db with the generated one.

More detail: Importing into osu! in the wiki.

Configuration

osu!collect reads an optional config file; most settings are editable live on the config tab, where changes apply and save immediately.

OS Path
Linux / macOS ~/.config/osu-collect/config.toml
Windows %APPDATA%\osu-collect\config.toml

See config.toml.example and Configuration (wiki).

Alternatives

Tool How osu!collect differs
osu!Collector desktop client The official app that needs a paid subscription; osu!collect is free.
BatchBeatmapDownloader Downloads by filters and criteria rather than osu!collector collections.
osu-collector-dl A CLI script with no TUI, no collection.db generation, and no updater.
OsuCollectionDownloader Generates .osdb files and needs the .NET runtime.
Collection Manager Manages and merges existing collections; pairs well with osu!collect for stable imports.

FAQ

How do I download an osu!collector collection for free? Run osu!collect, paste the collection URL, press ↵. Downloads come from public beatmap mirrors, or the official servers if you log in. No subscription needed.

Does it work with osu! lazer? Yes. See Importing into osu!. The generated collection.db imports through lazer's "first-time-setup".

Do I need an osu! account? No. Logging in is optional; it adds the official osu! servers and unlocks two find filters osu! only honors for supporter accounts (achieved rank, played).

Documentation

Full reference: osu!collect wiki.

What's next

Acknowledgments

Inspired by BatchBeatmapDownloader.

License

Licensed under either of MIT or Apache-2.0 at your option. Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this work shall be dual licensed as above, without any additional terms or conditions.

About

osu!collector downloader & updater with multiple mirrors, collection.db generation, BBD search and more

Topics

Resources

Stars

102 stars

Watchers

2 watching

Forks

Releases

Contributors

Languages