Modding
Extend Nox with custom mods using the SDK and CCK
Getting Started
Setup
Scaffold a new mod: nox.mod.json, asmdef, .gitignore, and folder structure.
Implementing Features
Use the initializer lifecycle and Core API to add features.
Building
Compile and package your mod with the Mod Builder editor panel.
Publishing
Set up CI with GitHub Actions to build and release automatically.
Core APIs
Mod API
Query, load, unload, and reload mods at runtime.
Event API
Publish/subscribe event bus for cross-mod communication.
Asset API
Load Unity assets and scenes from your mod's Assets/ folder.
Config API
Persistent per-mod configuration storage with dot-path access.
Lib API
Load and manage native libraries (.dll, .so, .dylib).
Logger API
Structured logging with levels, tags, and Unity context.
Feature APIs
Control Protocol
External control via WebSocket, MCP, and HTTP REST. Register operators from your mod.
Settings
Add toggle, range, button, or dropdown handlers. Persisted config with in-game UI.
Terminal
Register custom commands. ArgParser, environments, and command chaining.
Audio
Volume channels with dependency hierarchies. Microphone DSP and voice pipeline.
Keybinding
Input bindings with typed callbacks. Keyboard, gamepad, XR controllers.