32
edits
Changes
Modding:Modder Guide/APIs/Manifest (view source)
Revision as of 15:45, 25 February 2022
, 15:45, 25 February 2022Using a real example for the manifest.json file instead of fake data.
==Basic examples==
==Basic examples==
Here's the basic format (see below for details on each field):
Here's an example of the basic format from version 1.29.1 of the CJB Cheats Menu mod (see below for details on each field):
{| class="wikitable"
{| class="wikitable"
|-
|-
| <syntaxhighlight lang="javascript">
| <syntaxhighlight lang="javascript">
{
{
"Name": "CJB Cheats Menu",
"Author": "CJBok and Pathoschild",
"Version": "1.29.1",
"Description": "Simple in-game cheats menu!",
"UniqueID": "CJBok.CheatsMenu",
"EntryDll": "CJBCheatsMenu.dll",
"MinimumApiVersion": "3.12.6",
"UpdateKeys": [ "Nexus:4" ]
}
}
</syntaxhighlight>
</syntaxhighlight>
|-
|-
| <samp>UniqueID</samp>
| <samp>UniqueID</samp>
| A unique identifier for your mod. The recommended format is <samp><your name>.<mod name></samp>, with no spaces or special characters. SMAPI uses this for update checks, mod dependencies, and compatibility blacklists (if the mod breaks in a future version of the game). When another mod needs to reference this mod, it uses the unique ID. Example: <syntaxhighlight lang="javascript">"UniqueID": "Pathoschild.LookupAnything"</syntaxhighlight>
| A unique identifier for your mod. The recommended format is <samp><your name>.<mod name></samp>, with no spaces or special characters. SMAPI uses this for update checks, mod dependencies, and compatibility blacklists (if the mod breaks in a future version of the game). When another mod needs to reference this mod, it uses the unique ID. For this reason, once you've published your mod, do not change this unique ID in future versions of the same mod. Example: <syntaxhighlight lang="javascript">"UniqueID": "Pathoschild.LookupAnything"</syntaxhighlight>
|-
|-
| <samp>EntryDll</samp> '''or''' <samp>ContentPackFor</samp>
| <samp>EntryDll</samp> '''or''' <samp>ContentPackFor</samp>