hanaru provides minimal API to get beatmaps and metadata. It's based on drogon, which makes it really fast.
It's also caches every beatmap that has been requested to provide work faster.
hanaru cannot handle beatmaps with video, so if you want to download beatmapset with video - you should download them manually
when hanaru log in into your account, you will see a new session named 'Webkit (Safari)' and icon from mobile
because of peppy's underlying user-agent parsing, this is the best choose between anything else (its most uncommon)
please don't be scared when you see this session!
- drogon
- curl (custom http client, required to be able to log in into osu website)
Unix
sudo apt-get install curl
Windows
vcpkg install curl:{triplet} drogon[core,mysql]:{triplet}
where {triplet} is x{system_bits}-windows
hanaru also allows you to specify amount of required free space on hard drive
"required_free_space": 5120 // In megabytesby default required_free_space is 5 GB, which optimal for HDD, but might be low if you running this on SDD (o.o)
minimal is 1 GB (or 1024), because drogon can left some other stuff in uploads folder
please note that this value cannot be precisely verified, since the value is taken only at the start of the program
so settings this value to something like 25 GB might be good if this enough, if not - please don't be greedy
hanaru uses own JSON structure for /s/ and /b/ routes, which will be copied to Aru later
also hanaru can be used with same database as uses shiro, and shiro can connect to hanaru through connector
hanaru uses token bucket system to rate limit requests, with 600 tokens and refresh rate at 10 tokens per second
/s/ and /b/ routes consumes 1 token if data in database, and 11 if it downloaded from osu! servers (which will upper limit of osu! API tokens)
/d/ route consumes 1 token if data in cache, 21 token if data loaded from disk and 61 token if data loaded from osu! server
please note that this rate limit works for the entire system, so if you download a lot of maps, only /s/ and /b/ routes will be available
hanaru allow you to don't worry about huge and unrelated error handling systems
for example, if everything good in /d/ route, then you will get osz file and 200 response
but if something gone wrong - status code will be 400 or 500
here's list of all exceptions:
- 404 - beatmapset doesn't exist
- 418 - something went wrong so beatmap was lost, please try again
- 423 - downloader is unauthorized (wrong username/password)
- 429 - you hit rate limit, please try again after 10 seconds (this also might be our downloader rate limited by peppy's system)
in /b/ and /s/ routes on error you will receive status code, other than 200 and empty JSON object or array (like original osu! API)
currently theres only 404 may occur, or global 500 error, so don't try to parse JSON before checking status code