Overview
The two kinds of modding, what each can do, and where to start.
Mod folder structure
Every folder the engine recognises inside a mod, plus pack.json, modsList.txt and load order.
Script security sandbox
Default Lua/Python/HScript softmod sandbox, blocked capabilities, logs, and per-mod exceptions.
Lua scripting
How Lua scripts are loaded, the variables they get, control flow, and practical patterns.
Script hooks
Every callback the engine fires into Lua, Python and HScript, with arguments and return semantics.
Lua API reference
Every Lua function exposed by Phoenix Engine, generated from the engine sources.
Python scripting
Hython-based Python scripting — setup, differences from Lua, and examples.
Python API reference
Every Python function exposed by Phoenix Engine, generated from the engine sources.
Scripted states
Softcode menus, pause, game over and custom screens with data/states/Name.hx.
Transparent window
Punch a hole in the game window — color-key transparency, whole-window alpha and click-through for overlay/desktop-pet mods.
HScript
Standalone .hx/.hscript mods — Haxe scripts with the full engine hook lifecycle, plus running Haxe from Lua.
4th wall breaking (META_HORROR)
The 4th-wall-breaking system effects (wallpaper, taskbar, volume, mouse/keyboard) and how to use them safely.
Custom events & notetypes
Chart-driven scripting — defining your own event notes and note types.