Modding:Migrate to SMAPI 4.0 - Revision history

imported>VulpesLucida: +zh link

2025-03-29T10:24:01Z

+zh link

← Older revision		Revision as of 10:24, 29 March 2025
Line 227:		Line 227:

	[[Category:Modding]]		[[Category:Modding]]

			[[zh:模组:迁移至SMAPI 4.0]]

imported>Atravita: /* Other API changes */

2023-08-23T09:53:11Z

Other API changes

← Older revision		Revision as of 09:53, 23 August 2023
Line 146:		Line 146:
	\| <samp>PerScreen<T>(null)</samp>		\| <samp>PerScreen<T>(null)</samp>
	\| Passing null into the constructor is deprecated. You should call <code>PerScreen<T>()</code> to use the default value.		\| Passing null into the constructor is deprecated. You should call <code>PerScreen<T>()</code> to use the default value.
			\|-
			\| <samp>SDate.Season</samp>
			\| <samp>SDate.Season</samp> is now the <samp>Season</samp> enum, to match the game. Use <samp>SDate.SeasonKey</samp> if you absolutely need the string form.
	\|}		\|}

imported>Pathoschild: /* How to update your mod */ expand a bit, no longer need SMAPI for developers to see deprecation messages

2022-08-24T21:15:23Z

How to update your mod: expand a bit, no longer need SMAPI for developers to see deprecation messages

← Older revision		Revision as of 21:15, 24 August 2022
Line 30:		Line 30:

	===How to update your mod===		===How to update your mod===
	You don't need to comb through your code manually. SMAPI can tell you if you're using a deprecated ~~interface~~:		You don't need to comb through your code manually. SMAPI can tell you if you're using a deprecated API:

	# ~~Use the latest [https://smapi.io/~~ SMAPI ~~for developers] download. This~~ will show deprecation messages in the console:<br />[[File:Modding - updating deprecated SMAPI code - deprecation warnings.png]]		# SMAPI will show deprecation messages in the console window (the exact format changes depending on the deprecation level, but you can just search for your mod name):<br />[[File:Modding - updating deprecated SMAPI code - deprecation warnings.png]]
	# When you look at the code, you'll see ~~a deprecation warning~~ with ~~a hint of~~ how to fix it:<br />[[File:Modding - updating deprecated SMAPI code - deprecation intellisense.png]]		# When you look at the code in Visual Studio, you'll see build warnings with hints on how to fix them:<br />[[File:Modding - updating deprecated SMAPI code - deprecation intellisense.png]]
	# You can refer to the following sections on how to replace specific ~~interfaces~~.		# You can refer to the following sections on how to replace specific APIs.

	==Breaking changes==		==Breaking changes==

imported>Pathoschild: /* What's changing? */ update Content Patcher %

2022-08-24T21:10:21Z

What's changing?: update Content Patcher %

← Older revision		Revision as of 21:10, 24 August 2022
Line 9:		Line 9:
	[[File:SMAPI compatibility.png\|thumb\|SMAPI compatibility over time. The SMAPI 2.0 release appears as a small bump in October 2017, and SMAPI 3.0 was released alongside Stardew Valley 1.4.]]		[[File:SMAPI compatibility.png\|thumb\|SMAPI compatibility over time. The SMAPI 2.0 release appears as a small bump in October 2017, and SMAPI 3.0 was released alongside Stardew Valley 1.4.]]

	The [[Modding:Modder Guide/APIs/Content\|content interception API]] (''i.e.'' <samp>IAssetLoader</samp> and <samp>IAssetEditor</samp>) was introduced five years ago in [https://github.com/Pathoschild/SMAPI/blob/develop/docs/release-notes-archived.md#20 SMAPI 2.0.0]. Since then it's become one of the most important parts of SMAPI; for example, it's the basis for Content Patcher which is now the backbone for 39.7% of all mods. However, the API has remained essentially unchanged since its introduction and it doesn't account for all the use cases that apply today.		The [[Modding:Modder Guide/APIs/Content\|content interception API]] (''i.e.'' <samp>IAssetLoader</samp> and <samp>IAssetEditor</samp>) was introduced five years ago in [https://github.com/Pathoschild/SMAPI/blob/develop/docs/release-notes-archived.md#20 SMAPI 2.0.0]. Since then it's become one of the most important parts of SMAPI; for example, it's the basis for Content Patcher which is now the backbone for 41.1% of all mods. However, the API has remained essentially unchanged since its introduction and it doesn't account for all the use cases that apply today.

	SMAPI 4.0.0 is the release that fixes that. This completely redesigns the content API:		SMAPI 4.0.0 is the release that fixes that. This completely redesigns the content API:

imported>Pathoschild: split into 'breaking changes' vs 'other changes', add raw texture data

2022-06-07T16:55:11Z

split into 'breaking changes' vs 'other changes', add raw texture data

@@ Line 36: / Line 36: @@
 # You can refer to the following sections on how to replace specific interfaces.
-==Changes==
+==Breaking changes==
 ===Content interception API===
 The <samp>IAssetLoader</samp> and <samp>IAssetEditor</samp> interfaces no longer exist. Both have been replaced by the [[Modding:Modder Guide/APIs/Events#Content.AssetRequested|<samp>AssetRequested</samp> event]], which is used like this:
@@ Line 203: / Line 203: @@
 | This is usually only needed for <samp>System.Configuration.ConfigurationManager.dll</samp> or <samp>System.Runtime.Caching.dll</samp>, and can probably be removed.
 |}
 [[Category:Modding]]

imported>Pathoschild: /* Changes */ + removed dependencies

2022-06-01T01:15:50Z

Changes: + removed dependencies

@@ Line 184: / Line 184: @@
 string value = perScreen.Value; // returns empty string by default
 </syntaxhighlight>
 |}
 [[Category:Modding]]

imported>Pathoschild: /* Content loading API */ + migration notes for .xnb files loaded through content pipeline

2022-05-11T21:22:41Z

Content loading API: + migration notes for .xnb files loaded through content pipeline

← Older revision		Revision as of 21:22, 11 May 2022
Line 108:		Line 108:
	\| <samp>helper.Content.Load</samp>		\| <samp>helper.Content.Load</samp>
	\| Use <samp>helper.GameContent</samp> or <samp>helper.ModContent</samp>, and remove the <samp>ContentSource</samp> parameter.		\| Use <samp>helper.GameContent</samp> or <samp>helper.ModContent</samp>, and remove the <samp>ContentSource</samp> parameter.

			Migration notes:
			* When loading assets from <samp>helper.GameContent</samp>, don't add a <samp>.xnb</samp> file extension (''e.g.'' use <code>"Portraits/Abigail"</code> instead of <code>"Portraits/Abigail.xnb"</code>). You're requesting an [[Modding:Modder Guide/APIs/Content#What's an 'asset name'?\|asset name]], not a file path.
			* When loading XNB files from <samp>helper.ModContent</samp>, ''do'' add the <samp>.xnb</samp> file extension. It's no longer added automatically if needed.
	\|-		\|-
	\| <samp>helper.Content.NormalizeAssetName</samp>		\| <samp>helper.Content.NormalizeAssetName</samp>

imported>Pathoschild: /* Content interception API */ fix missing bracket

2022-05-07T14:50:30Z

Content interception API: fix missing bracket

← Older revision		Revision as of 14:50, 7 May 2022
Line 60:		Line 60:
	}		}
	}		}
			}
	</syntaxhighlight>		</syntaxhighlight>

imported>Pathoschild: /* Content interception API */ + link to content API docs

2022-05-01T23:36:12Z

Content interception API: + link to content API docs

← Older revision		Revision as of 23:36, 1 May 2022
Line 67:		Line 67:
	* When loading an asset, you must now specify an <samp>AssetLoadPriority</samp> which decides what happens if two loads apply to the same asset. <samp>AssetLoadPriority.Exclusive</samp> matches the previous behavior, but may reduce mod compatibility. See the IntelliSense documentation for more info.		* When loading an asset, you must now specify an <samp>AssetLoadPriority</samp> which decides what happens if two loads apply to the same asset. <samp>AssetLoadPriority.Exclusive</samp> matches the previous behavior, but may reduce mod compatibility. See the IntelliSense documentation for more info.

	See the [[Modding:Modder Guide/APIs/Events#Content\|content ~~event docs~~]] for more info on how to use them.		See the [[Modding:Modder Guide/APIs/Events#Content\|content events]] and [[Modding:Modder Guide/APIs/Content\|content API]] docs for more info on how to use them.

	===Content loading API===		===Content loading API===

imported>Pathoschild: update intro for SMAPI 3.14.0 release

2022-05-01T22:57:11Z

update intro for SMAPI 3.14.0 release

← Older revision		Revision as of 22:57, 1 May 2022
Line 2:		Line 2:

	{{Modder compatibility header}}		{{Modder compatibility header}}
	~~{{SMAPI upcoming\|4.0.0}}~~

	This page explains how to update your mod code for compatibility with SMAPI 4.0.0. ~~See also [[Modding:Migrate to Stardew Valley 1~~.~~6\|'~~'~~Migrate~~ to ~~Stardew Valley 1~~.~~6'']]~~.		This page explains how to update your C# mod code for compatibility with SMAPI 4.0.0. (Content packs aren't affected.) You can update mods now, there's no need to wait for the 4.0 release itself.

	==Overview==		==Overview==