Codebase documentation for the Friday Night Funkin' Phoenix Engine — a Haxe/HaxeFlixel engine built for weak devices and easy modding.
Install the Haxe toolchain, run the setup scripts and compile for Windows, Linux, macOS, Android, iOS, HTML5, Neko or Flash.
The layers of the engine: boot sequence, state flow, asset resolution, the Conductor, preferences and the platform layer.
Gameplay, charts, characters and stages, shaders, options, editors, audio, mobile, debugging and deep links.
Mod folder layout, Lua and Python scripting, HScript, every script hook, custom events and notetypes.
Every Haxe type under source/, generated from the sources — fields, signatures, compile-time flags and links to GitHub.
Workflow, code style, the CI build matrix and how to keep this documentation in sync with the code.