Jump to content
Toggle menu
  • 64 articles
  • 37 files
  • 9 users
  • 4.6K edits
Shroudforge
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Mod.json

From Shroudforge
Revision as of 00:15, 18 November 2026 by Bonsaibauer (talk | contribs) (Create English ShroudForge Wiki article)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)


Every ShroudForge mod package needs a mod.json file in its root folder. ShroudForge reads it before preparing or starting the mod. It describes the package and the capabilities it requests.

Required fields

The required fields are id, name, and version. Other fields are optional.

Example

{
  "$schema": "https://shroudforge.net/schemas/1.8.0/manifest.schema.json",
  "id": "example.hello-ember",
  "name": "Hello Ember",
  "version": "1.0.0",
  "authors": ["Your Name"],
  "capabilities": ["runtime"],
  "dependencies": []
}

The id is the unique package identifier. The name is shown to players. The version follows the package's release version. authors identifies the creators. capabilities lists the supported actions the mod requests. dependencies lists other mods required by this package.

The canonical manifest schema defines the accepted fields and data types.