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.

Extended.mod.json: Difference between revisions

From Shroudforge
Create English ShroudForge Wiki article
 
Marked this version for translation
Line 10: Line 10:
<translate>
<translate>


<!--T:1-->
<code>extended.mod.json</code> is an optional file alongside <code>mod.json</code>. Use it to define player-facing settings, organize them into groups, add actions and links, and store the enabled state.
<code>extended.mod.json</code> is an optional file alongside <code>mod.json</code>. Use it to define player-facing settings, organize them into groups, add actions and links, and store the enabled state.


== Main fields ==
== Main fields == <!--T:2-->


<!--T:3-->
* <code>schemaVersion</code> is currently <code>1</code>.
* <code>schemaVersion</code> is currently <code>1</code>.
* <code>enabled</code> stores whether the mod is switched on.
* <code>enabled</code> stores whether the mod is switched on.
Line 21: Line 23:
* <code>launcher</code> can preserve the origin of an imported EML mod.
* <code>launcher</code> can preserve the origin of an imported EML mod.


== Example ==
== Example == <!--T:4-->


<!--T:5-->
<pre>
<pre>
{
{
Line 45: Line 48:
</pre>
</pre>


<!--T:6-->
The setting key is <code>greeting</code>. Lua code reads the value by using that exact key with <code>shroudforge.settings.get</code>. A group makes the setting visible in the Modloader.
The setting key is <code>greeting</code>. Lua code reads the value by using that exact key with <code>shroudforge.settings.get</code>. A group makes the setting visible in the Modloader.


<!--T:7-->
The [https://shroudforge.net/schemas/1.8.0/extended.mod.schema.json canonical extended manifest schema] defines the structure and data types. Use the [https://shroudforge.net/tools/modding/mod-settings/ Mod Settings editor] to edit a sample and preview how its settings appear in the Modloader. The [https://shroudforge.net/schemas/ versioned schema catalogue] lists the published manifest schemas.
The [https://shroudforge.net/schemas/1.8.0/extended.mod.schema.json canonical extended manifest schema] defines the structure and data types. Use the [https://shroudforge.net/tools/modding/mod-settings/ Mod Settings editor] to edit a sample and preview how its settings appear in the Modloader. The [https://shroudforge.net/schemas/ versioned schema catalogue] lists the published manifest schemas.



Revision as of 00:15, 18 November 2026


extended.mod.json is an optional file alongside mod.json. Use it to define player-facing settings, organize them into groups, add actions and links, and store the enabled state.

Main fields

  • schemaVersion is currently 1.
  • enabled stores whether the mod is switched on.
  • targets selects the process that loads the mod. It does not replicate changes over the network.
  • settings stores mod-specific values.
  • groups organizes settings in the Modloader. Ungrouped settings appear in a default group.
  • launcher can preserve the origin of an imported EML mod.

Example

{
  "$schema": "https://shroudforge.net/schemas/1.8.0/extended.mod.schema.json",
  "schemaVersion": 1,
  "enabled": false,
  "targets": ["client"],
  "settings": {
    "greeting": {
      "value": "Hello from my mod",
      "label": "Greeting",
      "control": "text"
    }
  },
  "groups": [
    {
      "label": "Messages",
      "settings": ["greeting"]
    }
  ]
}

The setting key is greeting. Lua code reads the value by using that exact key with shroudforge.settings.get. A group makes the setting visible in the Modloader.

The canonical extended manifest schema defines the structure and data types. Use the Mod Settings editor to edit a sample and preview how its settings appear in the Modloader. The versioned schema catalogue lists the published manifest schemas.