Grimwar/Server-side modding

Getting started · Maps · VSig · VMod · Addons · Workshop · Servers · SDK

Draft documentation. This page is being verified against the current public SDK and may change before release.

Grimwar server mods are C# source packages compiled at runtime and executed through an interpreter while the player and dedicated-server builds remain IL2CPP. Mods receive the stable Grimwar.ModApi capability surface rather than direct access to Unity, networking, the filesystem, reflection, or process APIs.

Package pipeline

addon.json + mod.json + C# sources
  -> package and API-version validation
  -> capability and syntax validation
  -> compile against Grimwar.ModApi
  -> isolated interpreted execution
  -> scoped commands, events, timers, effects, storage, and VSig

Core services

The mod context provides bounded services for logging, commands, player snapshots, messages, menus, gameplay effects, administration, game modes, events, timers, time, randomness, persistent storage, VSig, and mod inspection.

Minimal structure

Every mod declares a stable ID, version, API version, entry point, source files, dependencies, permissions, kind, and server-only execution flag in mod.json. Its entry class implements IMod and registers callbacks during OnLoad.

The complete API reference and copy-ready examples will be generated from the public Mod API source after its documentation contract is finalized.