Mod.json: Difference between revisions
From Shroudforge
More actions
Bonsaibauer (talk | contribs) Marked this version for translation |
Bonsaibauer (talk | contribs) Link Mod.json readers to the detailed capabilities guide |
||
| Line 43: | Line 43: | ||
<!--T:9--> | <!--T:9--> | ||
* [[Build your first mod]] | * [[Build your first mod]] | ||
* [[Modding: Capabilities|Mod capabilities and permissions]] | |||
* [[extended.mod.json]] | * [[extended.mod.json]] | ||
* [[:Category:Modding:Shroudforge|All modding resources]] | * [[:Category:Modding:Shroudforge|All modding resources]] | ||
Revision as of 12:43, 18 November 2026
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.