osuskincheck
Read-only checks for an osu! skin folder, written in Haxe for any sys target (neko, hl, cpp, python, php, eval). It is a port of osu-skin-lint (Python), osu_skin_check (Ruby) and the Go version, so the same skin gives the same warnings everywhere.
Nothing in the skin folder is modified.
What it checks
| Check | Why it matters |
|---|---|
skin.ini present, [General] section, Name, Version | Without Version osu! treats the skin as 1.0 and old layout rules apply. |
Partial sample sets (normal, soft, drum × hitnormal/hitwhistle/hitfinish/hitclap) | A set with only some files mixes custom and default sounds in the same map. |
.mp3 hitsounds | MP3 encoder padding adds a few ms of silence, so the sound feels late. Use WAV or OGG. |
| 0-byte files | They can fail to load; a short silent WAV is the safer way to mute an element. |
| File names with leading/trailing spaces | Easy to miss and osu! will not match them. |
@2x images with no SD version | SD players get the HD image scaled down, which can look soft. |
Use
haxelib install osuskincheck
haxelib run osuskincheck "C:/osu!/Skins/My Skin"
Exit code is 1 when there are warnings, so it can run in a skin repository's CI.
From code:
var r = osuskincheck.SkinCheck.check("Skins/My Skin");
for (w in r.warnings) trace(w);
var ini = osuskincheck.SkinCheck.parseIni(sys.io.File.getContent("Skins/My Skin/skin.ini"));
trace(ini.get("General").get("Name"));
Background
The checks come from the questions that keep coming up when people install skins. Longer explanations of each element (hit bursts, cursor trails, combo colours, mania columns) are in the skin guides on osuskins.org and on the install page.
Unofficial tool, not affiliated with ppy or osu!. MIT licensed, by ZentaoLabs.