Implementing Features

Once your mod is scaffolded, the real work begins: implementing features using the initializer lifecycle and the Core API.

The Initializer Lifecycle

Every mod entry point implements one or more initializer interfaces. Each provides hook methods that Nox calls at specific moments.

Base: IModInitializer

All initializers inherit from this one. Every method has a default empty body — override only what you need.

Context-specific initializers

Each context adds its own lifecycle methods on top of the base. They all follow the same pattern — pick the one matching your target:

The Core API (IModCoreAPI)

Passed to OnInitialize, it's your gateway to the Nox runtime:

public void OnInitialize(IModCoreAPI api) {
    // Access other mods
    var allMods = api.ModAPI.GetMods();

    // Read/write persistent config
    var config = api.ConfigAPI.GetConfig("my_key");

    // Log messages
    api.LoggerAPI.Log("Mod initialized!");

    // Subscribe to events
    api.EventAPI.Subscribe("user.login", OnUserLogin);

    // Access assets from your Assets/ folder
    var prefab = api.AssetAPI.Load<GameObject>("my_prefab");
}

Available APIs

Context-specific CoreAPIs

Each context receives its own CoreAPI variant. Today they are empty extensions of IModCoreAPI, but they allow future context-specific additions:

Writing a Feature End-to-End

Let's build a simple Greeter mod that says hello.

namespace My.Super.Mod {
    public interface IGreeterAPI {
        string SayHello(string name);
    }
}

namespace My.Super.Mod.CCK {
    public class Greeter : IGreeterAPI {
        public string SayHello(string name) {
            return $"Hello {name}, welcome to Nox!";
        }
    }
}

using Nox.CCK.Mods.Cores;
using Nox.CCK.Mods.Initializers;

namespace My.Super.Mod.Runtime {
    public class Main : IMainModInitializer, IGreeterAPI {
        private IModCoreAPI coreAPI;
        private Greeter greeter;

        public void OnInitialize(IModCoreAPI api) {
            coreAPI = api;
            greeter = new Greeter();

            coreAPI.LoggerAPI.Log("Greeter mod initialized!");
        }

        public void OnDispose() {
            greeter = null;
            coreAPI = null;
        }

        public string SayHello(string name) {
            return greeter.SayHello(name);
        }
    }
}

Best Practices

• Always clean up in OnDispose: unsubscribe from events, nullify static references, cancel pending async operations.
• SDK = interfaces/enums only: no logic, no implementations.
• Use [NoxPublic] to mark methods intended for public consumption (helps with documentation generation).
• Test in both Editor and build: some APIs behave differently (e.g., file paths, Application.*).

Continue to Building Your Mod to compile and package it.