docs

Kuroosu patcher

The Kuroosu patcher is a small add-on for osu! that makes Relax and Autopilot nicer to play and shows your pp while you play. It is in its test phase: the download opens here as soon as the tests are done.

1What it does

  • Relax and Autopilot: you see your misses, hear the combo break sound, can fail, and your scores are saved in the local leaderboard.
  • Live pp counter while you play and in replays, in every mode (osu!, Taiko, Catch, Mania). It uses osu!'s own pp calculation, so on Relax and Autopilot the number can differ from the pp on the website.
  • Your pp counter, your way: pick its size, place and colour in the osu! options (section “Kuroosu patcher”). A change shows on the next map.
  • Discord status: your Discord profile shows that you play on Kuroosu, the map, the mode and your live pp, with buttons to the server and your profile. You can turn it off in the same options. Tip: turn off osu!'s own Discord option, or Discord shows two entries.
  • Small extras: your mods stay visible while playing and automatic restart with Sudden Death.

Only for Kuroosu The starter refuses to load into an osu! that is connected to another server. Never try it on the official osu! server – you would get banned there.

2How it works

The patcher is one single file, OsuPompa-Patcher.exe. On the first start a small window asks for your osu! folder (it usually finds it by itself). Press Play: it opens your normal osu! on Kuroosu and loads the add-on into the running game after a few seconds. From then on it starts right away. Hold Shift while starting it to pick another osu! folder.

Your osu! files are never changed: close osu! and everything is as before. The patcher keeps its own files in %LOCALAPPDATA%\Kuroosu\Patcher. Your antivirus may warn about it, because loading something into another program looks suspicious to it.

If something does not work, the file osupompa-patcher.log in your osu! folder says why – send it to us with Report a bug. After an osu! update single features can stop working until we update the patcher.

3The anti-cheat check always on

While osu! runs with the patcher, the anti-cheat check is on. The starter window says so before you press Play. If you do not want it, do not use the patcher – you can play on Kuroosu without it. About once a minute the patcher tells our server:

  • your osu! player name,
  • the file names of the DLLs loaded inside osu! (no folders),
  • the names of the programs that are running (names only),
  • whether a debugger is attached to osu!.

It does not read your files, window titles, browser, passwords or anything you type, and it changes nothing on your PC. Our server keeps: that you played with the check and when, anything that matches a known cheat (only staff see that), and a list of DLL names without any player. Program names that match nothing are thrown away right away. Sessions are deleted after 60 days.

A finding never restricts anyone by itself – staff look at it together with your replays.

4Source code

The patcher is based on osu-patcher by rushiiMachine (with the updates by 7mochi) and is free software under the GPL-3.0 licence. You get the source code of our version together with the download; until then ask us on Discord.