Modding:Modder Guide/APIs/Manifest - Revision history

imported>Margotbean: ru link

2026-01-07T18:40:31Z

ru link

← Older revision		Revision as of 18:40, 7 January 2026
Line 150:		Line 150:

	[[es:Modding:Guía del Modder/APIs/Manifest]]		[[es:Modding:Guía del Modder/APIs/Manifest]]
	[[ru:Модификации:Руководство мододела/API/~~Manifest~~]]		[[ru:Модификации:Руководство мододела/API/Манифест]]
	[[tr:Modlama:Mod Rehberi/API'ler/Manifest]]		[[tr:Modlama:Mod Rehberi/API'ler/Manifest]]
	[[zh:模组:制作指南/APIs/Manifest]]		[[zh:模组:制作指南/APIs/Manifest]]

imported>Sunbeam135: /* Anything else */

2026-01-02T11:35:34Z

Anything else

← Older revision		Revision as of 11:35, 2 January 2026
Line 150:		Line 150:

	[[es:Modding:Guía del Modder/APIs/Manifest]]		[[es:Modding:Guía del Modder/APIs/Manifest]]
			[[ru:Модификации:Руководство мододела/API/Manifest]]
	[[tr:Modlama:Mod Rehberi/API'ler/Manifest]]		[[tr:Modlama:Mod Rehberi/API'ler/Manifest]]
	[[zh:模组:制作指南/APIs/Manifest]]		[[zh:模组:制作指南/APIs/Manifest]]

imported>Pathoschild: /* Basic fields */ + %ProjectVersion% in mod build package 4.4.0

2025-04-14T00:13:40Z

Basic fields: + %ProjectVersion% in mod build package 4.4.0

← Older revision		Revision as of 00:13, 14 April 2025
Line 52:		Line 52:
	\|-		\|-
	\| <samp>Version</samp>		\| <samp>Version</samp>
	\| The mod's [http://semver.org/ semantic version]. Make sure you update this for each release! SMAPI uses this for update checks, mod dependencies, and compatibility blacklists (if the mod breaks in a future version of the game). ~~Examples~~:		\| The mod's [http://semver.org/ semantic version]. Make sure you update this for each release! SMAPI uses this for update checks, mod dependencies, and compatibility blacklists (if the mod breaks in a future version of the game). For example:
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	"Version": "1.0.0"		"Version": "1.0.0"
	</syntaxhighlight>		</syntaxhighlight>

			If you set the <code><Version></code> in your <samp>.csproj</samp> project file, you can use the exact text <samp>%ProjectVersion%</samp> in the manifest file to set the same version automatically:
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	"Version": "~~1.0.1-beta.2~~"		"Version": "%ProjectVersion%"
	</syntaxhighlight>		</syntaxhighlight>
	\|-		\|-

imported>VulpesLucida: Fix link

2025-01-05T11:31:19Z

Fix link

← Older revision		Revision as of 11:31, 5 January 2025
Line 1:		Line 1:
	{{../../header}}		{{../../header}}

	Every SMAPI mod or content pack must have a <samp>manifest.json</samp> file in its folder. SMAPI uses this to identify and load the mod, perform update checks, etc. The manifest info is also available to any mod in code (using <samp>this.ModManifest</samp> for the current mod's manifest, or [[../#Mod registry\|mod registry]] for other mods' manifests).		Every SMAPI mod or content pack must have a <samp>manifest.json</samp> file in its folder. SMAPI uses this to identify and load the mod, perform update checks, etc. The manifest info is also available to any mod in code (using <samp>this.ModManifest</samp> for the current mod's manifest, or [[../Integrations#Mod registry\|mod registry]] for other mods' manifests).

	==Basic examples==		==Basic examples==
Line 145:		Line 145:

	===Anything else===		===Anything else===
	Any other fields will be stored in the <samp>IManifest.ExtraFields</samp> dictionary, which is available through the [[../#Mod registry\|mod registry]]. Extra fields are ignored by SMAPI, but may be useful for extended metadata intended for other mods.		Any other fields will be stored in the <samp>IManifest.ExtraFields</samp> dictionary, which is available through the [[../Integrations#Mod registry\|mod registry]]. Extra fields are ignored by SMAPI, but may be useful for extended metadata intended for other mods.

	[[es:Modding:Guía del Modder/APIs/Manifest]]		[[es:Modding:Guía del Modder/APIs/Manifest]]
	[[tr:Modlama:Mod Rehberi/API'ler/Manifest]]		[[tr:Modlama:Mod Rehberi/API'ler/Manifest]]
	[[zh:模组:制作指南/APIs/Manifest]]		[[zh:模组:制作指南/APIs/Manifest]]

imported>Pathoschild: /* Specialized fields */ hide private assemblies feature for now (removed from the SMAPI 4.1.x release)

2024-11-15T21:44:38Z

Specialized fields: hide private assemblies feature for now (removed from the SMAPI 4.1.x release)

← Older revision		Revision as of 21:44, 15 November 2024
Line 114:		Line 114:
	==Specialized fields==		==Specialized fields==
	'''⚠️ Most mods shouldn't need to use these fields.'''		'''⚠️ Most mods shouldn't need to use these fields.'''
			<!-- removed from SMAPI 4.1.0
	===Private assemblies===		===Private assemblies===
	{{SMAPI upcoming\|4.1.0\|content=		{{SMAPI upcoming\|4.1.0\|content=
Line 142:		Line 142:
	</syntaxhighlight>		</syntaxhighlight>
	}}		}}
			-->

	===Anything else===		===Anything else===

imported>Peaw at 09:59, 15 September 2024

2024-09-15T09:59:00Z

← Older revision		Revision as of 09:59, 15 September 2024
Line 147:		Line 147:

	[[es:Modding:Guía del Modder/APIs/Manifest]]		[[es:Modding:Guía del Modder/APIs/Manifest]]
			[[tr:Modlama:Mod Rehberi/API'ler/Manifest]]
	[[zh:模组:制作指南/APIs/Manifest]]		[[zh:模组:制作指南/APIs/Manifest]]

imported>Pathoschild: /* Private assemblies */ clarify

2024-07-06T20:11:50Z

Private assemblies: clarify

← Older revision		Revision as of 20:11, 6 July 2024
Line 117:		Line 117:
	===Private assemblies===		===Private assemblies===
	{{SMAPI upcoming\|4.1.0\|content=		{{SMAPI upcoming\|4.1.0\|content=
	A ''private assembly'' is a DLL which only one mod can reference. This ensures that the mod has the exact version it was designed for, and lets different mods use different versions of the same assembly. You can use this even if the assembly was already loaded by SMAPI or another mod.		A ''private assembly'' is a DLL which only one mod can reference. This ensures that the mod has the exact version it was designed for, and lets different mods use different versions of the same assembly. You can use this even if another copy of the assembly was already loaded by SMAPI or another mod.

	Caveats:		Caveats:

imported>Pathoschild: + private assemblies in SMAPI 4.1.0

2024-07-06T18:39:35Z

+ private assemblies in SMAPI 4.1.0

← Older revision		Revision as of 18:39, 6 July 2024
Line 111:		Line 111:

	See [[../Update checks\|''update checks'']] for more information.		See [[../Update checks\|''update checks'']] for more information.

			==Specialized fields==
			'''⚠️ Most mods shouldn't need to use these fields.'''

			===Private assemblies===
			{{SMAPI upcoming\|4.1.0\|content=
			A ''private assembly'' is a DLL which only one mod can reference. This ensures that the mod has the exact version it was designed for, and lets different mods use different versions of the same assembly. You can use this even if the assembly was already loaded by SMAPI or another mod.

			Caveats:
			* Each private copy of a DLL has ''separate'' static values. Don't use this for assemblies that need to share global state (e.g. Harmony).
			* The DLL needs to be in your mod folder.

			You must specify the assembly name (without the version, culture, and private key). For example:
			<syntaxhighlight lang="javascript">
			"PrivateAssemblies": [
			{
			"Name": "Newtonsoft.Json"
			}
			]
			</syntaxhighlight>

			SMAPI will log a warning if it doesn't detect a reference to the DLL, which is usually a mistake. If that's deliberate (e.g. you're accessing it through reflection), you can suppress that warning:
			<syntaxhighlight lang="javascript">
			"PrivateAssemblies": [
			{
			"Name": "Newtonsoft.Json",
			"UsedDynamically": true // not recommended -- only set if DLL is accessed in a special way
			}
			]
			</syntaxhighlight>
			}}

	===Anything else===		===Anything else===

imported>Pathoschild: /* Minimum SMAPI version */ + MinimumGameVersion in SMAPI 4.0.6

2024-04-08T03:09:42Z

Minimum SMAPI version: + MinimumGameVersion in SMAPI 4.0.6

← Older revision		Revision as of 03:09, 8 April 2024
Line 80:		Line 80:
	\|}		\|}

	===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===

imported>Pathoschild: /* Basic examples */ restore generic example (new mod authors often copy & paste this example and forget to change some values, and we don't want them accidentally releasing with another mod's info), update indentation

2022-02-25T17:00:00Z

Basic examples: restore generic example (new mod authors often copy & paste this example and forget to change some values, and we don't want them accidentally releasing with another mod's info), update indentation

← Older revision		Revision as of 17:00, 25 February 2022
Line 4:		Line 4:

	==Basic examples==		==Basic examples==
	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):		Here's the basic format (see below for details on each field):
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
Line 12:		Line 12:
	\| <syntaxhighlight lang="javascript">		\| <syntaxhighlight lang="javascript">
	{		{
	"Name": "~~CJB Cheats Menu~~",		"Name": "Your Project Name",
	"Author": "~~CJBok and Pathoschild~~",		"Author": "your name",
	"Version": "1.29.1",		"Version": "1.0.0",
	"Description": "~~Simple in-game cheats menu!~~",		"Description": "One or two sentences about the mod.",
	"UniqueID": "~~CJBok~~.~~CheatsMenu~~",		"UniqueID": "YourName.YourProjectName",
	"EntryDll": "~~CJBCheatsMenu~~.dll",		"EntryDll": "YourDllFileName.dll",
	~~"MinimumApiVersion": "3.12.6~~",		"UpdateKeys": []
	"UpdateKeys": [ ~~"Nexus:4"~~ ]
	}		}
	</syntaxhighlight>		</syntaxhighlight>
	\| <syntaxhighlight lang="javascript">		\| <syntaxhighlight lang="javascript">
	{		{
	"Name": "Your Project Name",		"Name": "Your Project Name",
	"Author": "your name",		"Author": "your name",
	"Version": "1.0.0",		"Version": "1.0.0",
	"Description": "One or two sentences about the mod.",		"Description": "One or two sentences about the mod.",
	"UniqueID": "YourName.YourProjectName",		"UniqueID": "YourName.YourProjectName",
	"UpdateKeys": [],		"UpdateKeys": [],
	"ContentPackFor": {		"ContentPackFor": {
	"UniqueID": "Pathoschild.ContentPatcher"		"UniqueID": "Pathoschild.ContentPatcher"
	}		}
	}		}
	</syntaxhighlight>		</syntaxhighlight>