This project's goal is to provide an assistance in identifying potential issues in regards to the rankability and performance of osu! storyboards. The intended use is mostly for self-modding purposes.

Please make sure you understand the limitations and implications of information generated by this project and always confirm issues yourself if you intend to use it for modding purposes.

The project is mostly designed to work as a library targeting .NET Standard 2.1.

The OsbConsoleInterpreter is a minimal application that demonstrates the intended use. You need to have .NET Core 3.1 runtime installed to run it. Get it here: https://aka.ms/dotnet-download

You can test it by providing a path to a mapset that contains a storyboard in .osb format, for example:

OsbConsoleInterpreter.exe "C:\Program Files\osu!\Songs\104621 Rhythmics & Cat Like Thief - Summer Wars"

Or try supplying a diffname in addition to analyse a diff-specific storyboard instead:

OsbConsoleInterpreter.exe "C:\Program Files\osu!\Songs\527869 Toromaru - Enigma" "NOVICE"

Note that this may take a while as a lot of data is generated and evaluated to generate the warnings and draw the graphs.

When the evaluation is done you will find 3 files, StoryboardWarnings.txt, commandgraph.jpg and spritegraph.jpg in the mapset folder.

Check the wiki for further information on how to work with these.