osuskincheck

Read-only checks for osu! skin folders: skin.ini parsing, partial hitsound sets, MP3 padding, 0-byte files and @2x images without SD versions.
https://osuskins.org/

To install, run:

haxelib install osuskincheck 0.1.0 

See using Haxelib in Haxelib documentation for more information.

README.md

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

CheckWhy it matters
skin.ini present, [General] section, Name, VersionWithout 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 hitsoundsMP3 encoder padding adds a few ms of silence, so the sound feels late. Use WAV or OGG.
0-byte filesThey can fail to load; a short silent WAV is the safer way to mute an element.
File names with leading/trailing spacesEasy to miss and osu! will not match them.
@2x images with no SD versionSD 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.

Contributors
zentaolabs
Version
0.1.0
Published
4 days ago
License
MIT

All libraries are free

Every month, more than a thousand developers use Haxelib to find, share, and reuse code — and assemble it in powerful new ways. Enjoy Haxe; It is great!

Explore Haxe

Haxe Manual

Haxe Code Cookbook

Haxe API documentation

You can try Haxe in the browser! try.haxe.org

Join us on GitHub!

Haxe is being developed on GitHub. Feel free to contribute or report issues to our projects.

Haxe on GitHub

⌂