{"id":50585980,"url":"https://github.com/zfi2/osu-beatmap-downloader","last_synced_at":"2026-06-05T06:04:21.896Z","repository":{"id":338508606,"uuid":"1158129885","full_name":"zfi2/osu-beatmap-downloader","owner":"zfi2","description":"a command-line tool to fetch and download all your most played osu! beatmaps (which in theory, includes all the beatmaps you've ever played).","archived":false,"fork":false,"pushed_at":"2026-02-14T21:13:34.000Z","size":16,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-05T06:04:20.314Z","etag":null,"topics":["backup","beatmap","beatmaps","cli","downloader","mirror","osu","osu-api","rhythm-game","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zfi2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-14T21:02:58.000Z","updated_at":"2026-04-09T08:19:50.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/zfi2/osu-beatmap-downloader","commit_stats":null,"previous_names":["zfi2/osu-beatmap-downloader"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/zfi2/osu-beatmap-downloader","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zfi2%2Fosu-beatmap-downloader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zfi2%2Fosu-beatmap-downloader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zfi2%2Fosu-beatmap-downloader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zfi2%2Fosu-beatmap-downloader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zfi2","download_url":"https://codeload.github.com/zfi2/osu-beatmap-downloader/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zfi2%2Fosu-beatmap-downloader/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33932048,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-05T02:00:06.157Z","response_time":120,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backup","beatmap","beatmaps","cli","downloader","mirror","osu","osu-api","rhythm-game","rust"],"created_at":"2026-06-05T06:04:20.786Z","updated_at":"2026-06-05T06:04:21.882Z","avatar_url":"https://github.com/zfi2.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# osu! beatmap downloader\n\na command-line tool to fetch and download all your most played osu! beatmaps (which in theory, includes all the beatmaps you've ever played).\nuseful for new osu! installs.\n\n## features\n\n- fetches your complete most played beatmap list from the osu! API\n- downloads beatmaps from nerinyan.moe or catboy.best mirrors\n- resumes downloads (skips already downloaded beatmaps)\n- exports your beatmaps to a JSON format\n- optional configurable parameters via `.env` environment variables\n\n## prerequisites\n\n- rust toolchain (install from https://rustup.rs/)\n- osu! API credentials (see setup section below)\n\n## setup\n\n1. clone or download this repository\n\n2. get your osu! API credentials:\n   - visit https://osu.ppy.sh/home/account/edit#oauth\n   - click on \"New OAuth Application\"\n   - put in any name you wish\n   - copy your client ID and client secret\n\n3. Create a `.env` file in the project root\n\n4. Edit `.env` and fill in your credentials:\n   ```env\n   # osu! API credentials\n   OSU_CLIENT_ID=your_client_id_here\n   OSU_CLIENT_SECRET=your_client_secret_here\n   OSU_USERNAME=your_osu_username\n   \n   # optional: beatmap download directory (defaults to ./beatmaps)\n   BEATMAP_OUTPUT_DIR=./beatmaps\n\n   # optional: use alternative mirror (catboy.best instead of nerinyan.moe)\n   # set to 'true' or 'yes' to enable (defaults to false)\n   USE_ALTERNATIVE_MIRROR=false\n   ```\n\n## usage\n\n### fetch and download in one command:\n```bash\ncargo run --release -- all\n```\n\n### or run separately:\n\nfetch beatmap list:\n```bash\ncargo run --release -- fetch\n```\n\ndownload beatmaps:\n```bash\ncargo run --release -- download\n```\n\n## output files\n\n- `osu_most_played_maps.json` - full beatmap information in a JSON format\n- `beatmaps/*.osz` - downloaded beatmap files (ready to import into osu!)\n\nfiles are saved in this format: `{beatmapset_id} {artist} - {title}.osz`\n\n## how it works\n\n1. **fetching**: authenticates with the osu! API and retrieves your complete most played beatmap list (with a silly progress indicator)\n2. **re-fetching**: when using the `all` command, if a beatmap list already exists, you'll be prompted whether to re-fetch or use the existing data\n3. **download**: uses the nerinyan.moe and catboy.best mirror API's to download beatmap files\n4. **rate limiting**: automatically adapts to beatmap mirrors rate limits\n5. **resume**: skips already downloaded files, making it safe to re-run\n\n## troubleshooting\n\n1. **authentication failed**: double-check your client ID and client secret in your `.env` file\n2. **missing dependencies**: run `cargo build` to install all required dependencies\n3. **rate limited**: the tool should handle this automatically, if not, you just have to wait and re-run the tool later\n\n## license\n\nthis project is licensed under the MIT License. see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzfi2%2Fosu-beatmap-downloader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzfi2%2Fosu-beatmap-downloader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzfi2%2Fosu-beatmap-downloader/lists"}