translators
8,446
edits
Changes
Jump to navigation
Jump to search
Line 12:
Line 12: − "Name": "Your Project Name",+ − "Author": "your name",+ − "Version": "1.0.0",+ − "Description": "One or two sentences about the mod.",+ − "UniqueID": "YourName.YourProjectName",+ − "EntryDll": "YourDllFileName.dll",+ − "UpdateKeys": []+ − "Name": "Your Project Name",+ − "Author": "your name",+ − "Version": "1.0.0",+ − "Description": "One or two sentences about the mod.",+ − "UniqueID": "YourName.YourProjectName",+ − "UpdateKeys": [],+ − "ContentPackFor": {+ − "UniqueID": "Pathoschild.ContentPatcher"+ − }+ Line 64:
Line 64: − + Line 80:
Line 80: − + − + + + +
→Minimum SMAPI version: + MinimumGameVersion in SMAPI 4.0.6
| <syntaxhighlight lang="javascript">
| <syntaxhighlight lang="javascript">
{
{
"Name": "Your Project Name",
"Author": "your name",
"Version": "1.0.0",
"Description": "One or two sentences about the mod.",
"UniqueID": "YourName.YourProjectName",
"EntryDll": "YourDllFileName.dll",
"UpdateKeys": []
}
}
</syntaxhighlight>
</syntaxhighlight>
| <syntaxhighlight lang="javascript">
| <syntaxhighlight lang="javascript">
{
{
"Name": "Your Project Name",
"Author": "your name",
"Version": "1.0.0",
"Description": "One or two sentences about the mod.",
"UniqueID": "YourName.YourProjectName",
"UpdateKeys": [],
"ContentPackFor": {
"UniqueID": "Pathoschild.ContentPatcher"
}
}
}
</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>
|}
|}
===Minimum SMAPI version===
===Minimum SMAPI or game version===
The <samp>MinimumApiVersion</samp> fields sets the minimum SMAPI version needed to use this mod. If a player tries to use the mod with an older SMAPI version, they'll see a friendly message saying they need to update SMAPI. This also serves as a proxy for the minimum game version, since SMAPI itself enforces a minimum game version. Example: <syntaxhighlight lang="javascript">"MinimumApiVersion": "3.8.0"</syntaxhighlight>
The <samp>MinimumApiVersion</samp> and <samp>MinimumGameVersion</samp> field sets the minimum version of SMAPI or Stardew Valley needed to use this mod. If a player tries to use the mod with an older version, they'll see a friendly message saying they need to update it.
For example:
<syntaxhighlight lang="javascript">"MinimumApiVersion": "4.0.0"</syntaxhighlight>
===Dependencies===
===Dependencies===