senku-cli

A CLI that calculates your play — star rating and pp for all 4 modes (osu!standard, osu!taiko, osu!catch, osu!mania), powered by senku.

Install

Not published to PyPI — install directly from GitHub:

pip install git+https://github.com/datenshicommunity/senku-cli.git

This pulls in senku from PyPI automatically (declared as a dependency). To upgrade later:

pip install --upgrade --force-reinstall git+https://github.com/datenshicommunity/senku-cli.git

Usage

senku-cli <std|taiko|catch|mania> (--file PATH | --beatmap-id ID) [--mods MODS] [options...]

Beatmap source is either a local .osu file (--file) or a beatmap ID fetched directly from osu.ppy.sh (--beatmap-id) — no API key needed.

Mods are passed as a single string, either concatenated (HDDT) or comma-separated (HD,DT).

osu!standard

senku-cli std --beatmap-id 5127976 --n300 980 --n100 15 --n50 2 --nmiss 0 --mods HDDT

Options: --n300 --n100 --n50 --nmiss --combo (default: full combo). Supports the full mod matrix senku implements for std: DT/HT/NC/DC (via mods), HR/EZ, HD/FL, NF/SO/AP/RX/BL/TC/TD/MG/DF, and DA (ModDifficultyAdjust) via --da-cs/--da-ar/--da-od/--da-hp.

senku-cli std --file map.osu --n300 900 --n100 50 --nmiss 2 \
  --mods DA --da-cs 4 --da-ar 9.8 --da-od 8 --da-hp 5

osu!taiko

senku-cli taiko --beatmap-id 4478259 --n300 940 --n100 40 --nmiss 7 --mods HR

Options: --n300 --n100 --nmiss --convert (std→taiko convert flag). Supports DT/HT/NC/DC, HR/EZ (scales OD and slider velocity — see senku's docs), HD/FL, RX (a genuine difficulty-level change in taiko).

osu!catch

senku-cli catch --beatmap-id 341072 --n300 983 --n50 242 --mods HR

Options: --n300 (fruit) --n100 (large droplet) --n50 (small droplet) --nkatu (small droplet miss) --nmiss --combo (default: full combo). Supports DT/HT/NC/DC, HR/EZ (CS/AR scaling + the real client's legacy RNG position-jitter under HR), HD/FL/NF.

osu!mania

senku-cli mania --beatmap-id 2118256 --n320 1200 --n300 50 --mods DT

Options: --n320 (MAX) --n300 --n200 --n100 --n50 --nmiss. Supports DT/HT/NC/DC, NF/EZ.

Output

Beatmap:      beatmap #5127976
Mode:         osu
Mods:         DT, HD
Star rating:  2.6015
PP:           38.9421
Combo:        158/158
Breakdown:
  aim_difficulty: 1.2345
  speed_difficulty: 1.1234
  reading_difficulty: 0.5678
  flashlight_difficulty: 0.0000

Pass --json for machine-readable output instead.

License

MIT — see LICENSE.