Modding:Content Patcher - Revision history

imported>Sunbeam135 at 22:33, 22 December 2025

2025-12-22T22:33:52Z

← Older revision		Revision as of 22:33, 22 December 2025
Line 163:		Line 163:
	[[fr:Modding:Content Patcher]]		[[fr:Modding:Content Patcher]]
	[[pt:Modificações:Content Patcher]]		[[pt:Modificações:Content Patcher]]
			[[ru:Модификации:Content Patcher]]
	[[zh:模组:Content Patcher]]		[[zh:模组:Content Patcher]]

imported>Pathoschild: use {{Content Patcher example}}

2025-02-01T19:19:01Z

use {{Content Patcher example}}

← Older revision		Revision as of 19:19, 1 February 2025
Line 67:		Line 67:
	<li>[[Modding:Content packs#Create a content pack\|Create a SMAPI content pack per step 3 of the general Create a Content Pack page]].</li>		<li>[[Modding:Content packs#Create a content pack\|Create a SMAPI content pack per step 3 of the general Create a Content Pack page]].</li>
	<li>Create a <samp>content.json</samp> file in the same folder with this content:		<li>Create a <samp>content.json</samp> file in the same folder with this content:
	~~{{#tag:syntaxhighlight\|~~		{{Content Patcher example\|<nowiki>
	{		"Changes": [
	~~"Format": "~~{{Content Patcher ~~version}}",~~		]
	"Changes": [		</nowiki>}}
	]
	~~}\|lang=javascript~~}}
	</li>		</li>
	<li>Launch the game.</li>		<li>Launch the game.</li>
Line 86:		Line 84:

	You can list any number of patches in the <samp>Changes</samp> field, each surrounded by <code>{</code> and <code>}</code>. See the next section for more info, but here's a quick example:		You can list any number of patches in the <samp>Changes</samp> field, each surrounded by <code>{</code> and <code>}</code>. See the next section for more info, but here's a quick example:
	~~{{#tag:syntaxhighlight\|~~		{{Content Patcher example\|<nowiki>
	{		"Changes": [
	~~"Format": "~~{{Content Patcher ~~version}}",~~		{
	"Changes": [		"Action": "Load",
	{		"Target": "Animals/Dinosaur",
	"Action": "Load",		"FromFile": "assets/dinosaur.png"
	"Target": "Animals/Dinosaur",		},
	"FromFile": "assets/dinosaur.png"		{
	},		"Action": "EditImage",
			"Target": "Maps/springobjects",
	{		"FromFile": "assets/fish-object.png"
	"Action": "EditImage",		}
	"Target": "Maps/springobjects",		]
	"FromFile": "assets/fish-object.png"		</nowiki>}}
	},
	]
	~~}\|lang=javascript~~}}

	(There are other fields like <samp>ConfigSchema</samp> and <samp>DynamicTokens</samp> for more advanced usage; these are covered in the full readme.)		(There are other fields like <samp>ConfigSchema</samp> and <samp>DynamicTokens</samp> for more advanced usage; these are covered in the full readme.)
Line 126:		Line 121:
	//horse head in inventory		//horse head in inventory
	{		{
	"Action": "EditImage",		"Action": "EditImage",
	"Target": "LooseSprites/Cursors",		"Target": "LooseSprites/Cursors",
	"FromFile": "yourfile.png",		"FromFile": "yourfile.png",
	"FromArea": { insert values here },		"FromArea": { insert values here },
	"ToArea": { "X": 192, "Y": 192, "Width": 16, "Height": 16 }		"ToArea": { "X": 192, "Y": 192, "Width": 16, "Height": 16 }
	}		}
	</syntaxhighlight>		</syntaxhighlight>

imported>AldousPulteney: fr link

2024-12-27T15:53:40Z

fr link

← Older revision		Revision as of 15:53, 27 December 2024
Line 166:		Line 166:

	[[es:Modding:Content Patcher]]		[[es:Modding:Content Patcher]]
			[[fr:Modding:Content Patcher]]
	[[pt:Modificações:Content Patcher]]		[[pt:Modificações:Content Patcher]]
	[[zh:模组:Content Patcher]]		[[zh:模组:Content Patcher]]

imported>Margotbean at 01:53, 15 July 2023

2023-07-15T01:53:49Z

← Older revision		Revision as of 01:53, 15 July 2023
Line 165:		Line 165:
	-->		-->

			[[es:Modding:Content Patcher]]
	[[pt:Modificações:Content Patcher]]		[[pt:Modificações:Content Patcher]]
	~~[[es:Modding:Content Patcher]]~~
	[[zh:模组:Content Patcher]]		[[zh:模组:Content Patcher]]

imported>DELET at 22:11, 14 July 2023

2023-07-14T22:11:10Z

← Older revision		Revision as of 22:11, 14 July 2023
Line 165:		Line 165:
	-->		-->

			[[pt:Modificações:Content Patcher]]
	[[es:Modding:Content Patcher]]		[[es:Modding:Content Patcher]]
	[[zh:模组:Content Patcher]]		[[zh:模组:Content Patcher]]

imported>Pathoschild: /* Content format */ fix hardcoded version

2022-09-26T22:55:08Z

Content format: fix hardcoded version

← Older revision		Revision as of 22:55, 26 September 2022
Line 82:		Line 82:
	The <samp>content.json</samp> file you created above is what tells Content Patcher what to change. This has two main fields:		The <samp>content.json</samp> file you created above is what tells Content Patcher what to change. This has two main fields:

	* <samp>Format</samp>: the format version. You should always use the latest version (currently ~~1.25.0~~) to enable the latest features and avoid obsolete behavior.		* <samp>Format</samp>: the format version. You should always use the latest version (currently {{Content Patcher version}}) to enable the latest features and avoid obsolete behavior.
	* <samp>Changes</samp>: the changes you want to make. Each entry is called a ''patch'', and describes a specific action to perform: replace this file, copy this image into the file, etc. You can list any number of patches.		* <samp>Changes</samp>: the changes you want to make. Each entry is called a ''patch'', and describes a specific action to perform: replace this file, copy this image into the file, etc. You can list any number of patches.

imported>BekahMcDonald: /* Content format */

2022-05-07T10:57:50Z

Content format

← Older revision		Revision as of 10:57, 7 May 2022
Line 82:		Line 82:
	The <samp>content.json</samp> file you created above is what tells Content Patcher what to change. This has two main fields:		The <samp>content.json</samp> file you created above is what tells Content Patcher what to change. This has two main fields:

	* <samp>Format</samp>: the format version. You should always use the latest version (currently 1.23.0) to enable the latest features and avoid obsolete behavior.		* <samp>Format</samp>: the format version. You should always use the latest version (currently 1.25.0) to enable the latest features and avoid obsolete behavior.
	* <samp>Changes</samp>: the changes you want to make. Each entry is called a ''patch'', and describes a specific action to perform: replace this file, copy this image into the file, etc. You can list any number of patches.		* <samp>Changes</samp>: the changes you want to make. Each entry is called a ''patch'', and describes a specific action to perform: replace this file, copy this image into the file, etc. You can list any number of patches.

imported>Margotbean: Text replacement - "tt>" to "samp>"

2021-11-04T18:48:54Z

Text replacement - "tt>" to "samp>"

← Older revision		Revision as of 18:48, 4 November 2021
Line 17:		Line 17:

	===Assets===		===Assets===
	An ''asset'' is essentially a file in the game's <tt>Content</tt> folder with a unique ''asset name''. The asset name never includes the <tt>Content</tt> path, language, or file extension (you can use tokens to target specific languages). For example:		An ''asset'' is essentially a file in the game's <samp>Content</samp> folder with a unique ''asset name''. The asset name never includes the <samp>Content</samp> path, language, or file extension (you can use tokens to target specific languages). For example:

	{\| class="wikitable"		{\| class="wikitable"
Line 24:		Line 24:
	! asset name		! asset name
	\|-		\|-
	\| <tt>Content/Portraits/Abigail.xnb</tt>		\| <samp>Content/Portraits/Abigail.xnb</samp>
	\| <tt>Portraits/Abigail</tt>		\| <samp>Portraits/Abigail</samp>
	\|-		\|-
	\| <tt>Content/Maps/spring_beach.xnb</tt><br /><tt>Content/Maps/spring_beach.es-ES.xnb</tt><br /><tt>Content/Maps/spring_beach.fr-FR.xnb</tt>		\| <samp>Content/Maps/spring_beach.xnb</samp><br /><samp>Content/Maps/spring_beach.es-ES.xnb</samp><br /><samp>Content/Maps/spring_beach.fr-FR.xnb</samp>
	\| <tt>Maps/spring_beach</tt>		\| <samp>Maps/spring_beach</samp>
	\|}		\|}

	An asset may contain multiple sprites or data entries. For example, here's what <tt>Portraits/Abigail</tt> contains if you unpack it:		An asset may contain multiple sprites or data entries. For example, here's what <samp>Portraits/Abigail</samp> contains if you unpack it:

	[[File:Modding - creating an XNB mod - example portraits.png]]		[[File:Modding - creating an XNB mod - example portraits.png]]

	So if you wanted to change Abigail's portraits, you would use Content Patcher to load or edit <tt>Portraits/Abigail</tt>.		So if you wanted to change Abigail's portraits, you would use Content Patcher to load or edit <samp>Portraits/Abigail</samp>.

	===Load vs edits===		===Load vs edits===
	There are two conceptual ways you can change an asset:		There are two conceptual ways you can change an asset:

	* ''Load'' the initial version of an asset. Each asset can only be loaded by one mod at the same time. This is mainly useful for total replacement mods (like a mod that completely changes an NPC's portraits), or to provide files that don't exist in the <tt>Content</tt> folder.		* ''Load'' the initial version of an asset. Each asset can only be loaded by one mod at the same time. This is mainly useful for total replacement mods (like a mod that completely changes an NPC's portraits), or to provide files that don't exist in the <samp>Content</samp> folder.
	* ''Edit'' an asset after it's loaded. Any number of edits can be applied to the same asset.		* ''Edit'' an asset after it's loaded. Any number of edits can be applied to the same asset.

Line 54:		Line 54:
	</pre>		</pre>

	This is divided into four main action types (<tt>Load</tt>, <tt>EditData</tt>, <tt>EditImage</tt>, <tt>EditMap</tt>), which are explained in more detail in the Content Patcher readme (see below).		This is divided into four main action types (<samp>Load</samp>, <samp>EditData</samp>, <samp>EditImage</samp>, <samp>EditMap</samp>), which are explained in more detail in the Content Patcher readme (see below).

	==Get started==		==Get started==
	===Intro to JSON===		===Intro to JSON===
	You'll notice a lot of files with <tt>.json</tt> at the end of the name when creating mods for Stardew Valley. That means they're formatted as JSON, which is just a way of writing text that's readable to code. If you haven't used JSON before, reading ''[https://towardsdatascience.com/an-introduction-to-json-c9acb464f43e An Introduction to JSON]'' first will be very helpful to understand what the files are doing.		You'll notice a lot of files with <samp>.json</samp> at the end of the name when creating mods for Stardew Valley. That means they're formatted as JSON, which is just a way of writing text that's readable to code. If you haven't used JSON before, reading ''[https://towardsdatascience.com/an-introduction-to-json-c9acb464f43e An Introduction to JSON]'' first will be very helpful to understand what the files are doing.

	===Create example mod===		===Create example mod===
Line 64:		Line 64:
	<ol>		<ol>
	<li>Install [https://smapi.io/ SMAPI] and {{nexus mod\|1915\|Content Patcher}}.</li>		<li>Install [https://smapi.io/ SMAPI] and {{nexus mod\|1915\|Content Patcher}}.</li>
	<li>Unpack the game's <tt>Content</tt> folder so you can see what each asset contains (see [[Modding:Editing XNB files#Unpack game files]]).</li>		<li>Unpack the game's <samp>Content</samp> folder so you can see what each asset contains (see [[Modding:Editing XNB files#Unpack game files]]).</li>
	<li>[[Modding:Content packs#Create a content pack\|Create a SMAPI content pack per step 3 of the general Create a Content Pack page]].</li>		<li>[[Modding:Content packs#Create a content pack\|Create a SMAPI content pack per step 3 of the general Create a Content Pack page]].</li>
	<li>Create a <tt>content.json</tt> file in the same folder with this content:		<li>Create a <samp>content.json</samp> file in the same folder with this content:
	{{#tag:syntaxhighlight\|		{{#tag:syntaxhighlight\|
	{		{
Line 80:		Line 80:

	===Content format===		===Content format===
	The <tt>content.json</tt> file you created above is what tells Content Patcher what to change. This has two main fields:		The <samp>content.json</samp> file you created above is what tells Content Patcher what to change. This has two main fields:

	* <tt>Format</tt>: the format version. You should always use the latest version (currently 1.23.0) to enable the latest features and avoid obsolete behavior.		* <samp>Format</samp>: the format version. You should always use the latest version (currently 1.23.0) to enable the latest features and avoid obsolete behavior.
	* <tt>Changes</tt>: the changes you want to make. Each entry is called a ''patch'', and describes a specific action to perform: replace this file, copy this image into the file, etc. You can list any number of patches.		* <samp>Changes</samp>: the changes you want to make. Each entry is called a ''patch'', and describes a specific action to perform: replace this file, copy this image into the file, etc. You can list any number of patches.

	You can list any number of patches in the <tt>Changes</tt> field, each surrounded by <code>{</code> and <code>}</code>. See the next section for more info, but here's a quick example:		You can list any number of patches in the <samp>Changes</samp> field, each surrounded by <code>{</code> and <code>}</code>. See the next section for more info, but here's a quick example:
	{{#tag:syntaxhighlight\|		{{#tag:syntaxhighlight\|
	{		{
Line 104:		Line 104:
	}\|lang=javascript}}		}\|lang=javascript}}

	(There are other fields like <tt>ConfigSchema</tt> and <tt>DynamicTokens</tt> for more advanced usage; these are covered in the full readme.)		(There are other fields like <samp>ConfigSchema</samp> and <samp>DynamicTokens</samp> for more advanced usage; these are covered in the full readme.)

	==Next steps==		==Next steps==

imported>Margotbean: zh link

2021-08-08T16:29:20Z

zh link

← Older revision		Revision as of 16:29, 8 August 2021
Line 166:		Line 166:

	[[es:Modding:Content Patcher]]		[[es:Modding:Content Patcher]]
			[[zh:模组:Content Patcher]]

imported>UlyanaLeyana: /* Content format */

2021-06-06T01:19:03Z

Content format

← Older revision		Revision as of 01:19, 6 June 2021
Line 82:		Line 82:
	The <tt>content.json</tt> file you created above is what tells Content Patcher what to change. This has two main fields:		The <tt>content.json</tt> file you created above is what tells Content Patcher what to change. This has two main fields:

	* <tt>Format</tt>: the format version. You should always use the latest version (currently 1.22.0) to enable the latest features and avoid obsolete behavior.		* <tt>Format</tt>: the format version. You should always use the latest version (currently 1.23.0) to enable the latest features and avoid obsolete behavior.
	* <tt>Changes</tt>: the changes you want to make. Each entry is called a ''patch'', and describes a specific action to perform: replace this file, copy this image into the file, etc. You can list any number of patches.		* <tt>Changes</tt>: the changes you want to make. Each entry is called a ''patch'', and describes a specific action to perform: replace this file, copy this image into the file, etc. You can list any number of patches.