Home

Welcome to the wiki! This documents the building process, source code, and skinning information.

Getting started

Choose your platform to build and run the game:

• Linux
• Mac OS
• Windows — MSYS2 MinGW64
• Android

Command line

YataiDON [song_path] [difficulty] [--auto] [--practice]
YataiDON --skin-viewer
YataiDON --sandbox

Argument	Description
song_path	Path to a .tja, .osu, or .bin chart file
difficulty	Difficulty index 0–4 to load directly
--auto	Enable autoplay
--practice	Load the song in game_practice
--skin-viewer	Open the skin_viewer without playing a song
--sandbox	Open the sandbox development preview tool

Skinning

Create and customise skins to change the game's visuals, sounds, and background animations.

• Skinning Information/File Structure — folder layout and parent skin inheritance
• Skinning Information/Graphics — texture.json format, animated frames, crops
• Skinning Information/Animations — animation.json reference
• Skinning Information/Skin Config — skin_config.json key reference
• Skinning Information/Skin Options — optional engine behaviour flags
• Skinning Information/Sounds — custom hit sounds (neiro)
• Skinning Information/Lua Scripting — tex, anim, and text API for background scripts
• Skinning Information/Skin Viewer — in-game texture browser and frame order editor

Source code documentation

The source is split into three layers:

• libs/ — reusable subsystems: audio, input, rendering, parsing, scripting, score storage
• objects/ — self-contained UI and gameplay components grouped by screen
• scenes/ — the full screen implementations that compose objects into playable screens

Start with YataiDON for the entry point and frame loop, or browse the sidebar for a specific subsystem.