Mod.json: Difference between revisions
From Shroudforge
More actions
Bonsaibauer (talk | contribs) Create English ShroudForge Wiki article |
Bonsaibauer (talk | contribs) Marked this version for translation |
||
| Line 10: | Line 10: | ||
<translate> | <translate> | ||
<!--T:1--> | |||
Every ShroudForge mod package needs a <code>mod.json</code> file in its root folder. ShroudForge reads it before preparing or starting the mod. It describes the package and the capabilities it requests. | Every ShroudForge mod package needs a <code>mod.json</code> 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 == | == Required fields == <!--T:2--> | ||
<!--T:3--> | |||
The required fields are <code>id</code>, <code>name</code>, and <code>version</code>. Other fields are optional. | The required fields are <code>id</code>, <code>name</code>, and <code>version</code>. Other fields are optional. | ||
== Example == | == Example == <!--T:4--> | ||
<!--T:5--> | |||
<pre> | <pre> | ||
{ | { | ||
| Line 30: | Line 33: | ||
</pre> | </pre> | ||
<!--T:6--> | |||
The <code>id</code> is the unique package identifier. The <code>name</code> is shown to players. The <code>version</code> follows the package's release version. <code>authors</code> identifies the creators. <code>capabilities</code> lists the supported actions the mod requests. <code>dependencies</code> lists other mods required by this package. | The <code>id</code> is the unique package identifier. The <code>name</code> is shown to players. The <code>version</code> follows the package's release version. <code>authors</code> identifies the creators. <code>capabilities</code> lists the supported actions the mod requests. <code>dependencies</code> lists other mods required by this package. | ||
<!--T:7--> | |||
The [https://shroudforge.net/schemas/1.8.0/manifest.schema.json canonical manifest schema] defines the accepted fields and data types. | The [https://shroudforge.net/schemas/1.8.0/manifest.schema.json canonical manifest schema] defines the accepted fields and data types. | ||
== Related pages == | == Related pages == <!--T:8--> | ||
<!--T:9--> | |||
* [[Build your first mod]] | * [[Build your first mod]] | ||
* [[extended.mod.json]] | * [[extended.mod.json]] | ||
Revision as of 00:15, 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.