Modding:Modder Guide/APIs/Content - Revision history

imported>Selph: Add link to framework tutorial

2026-05-21T02:18:56Z

Add link to framework tutorial

← Older revision		Revision as of 02:18, 21 May 2026
Line 601:		Line 601:

	This works for any asset type (e.g. maps or textures), and you can do this even without an internal file (e.g. using <code>e.LoadFrom(() => new Dictionary<string, ExampleModel>(), AssetLoadPriority.Medium)</code>).		This works for any asset type (e.g. maps or textures), and you can do this even without an internal file (e.g. using <code>e.LoadFrom(() => new Dictionary<string, ExampleModel>(), AssetLoadPriority.Medium)</code>).

			==See also==
			* [https://stardewmodding.wiki.gg/wiki/Tutorial:_Making_Framework_Mods Tutorial: Making Framework Mods] for an external tutorial on making new framework mods that utilize the content pipeline, including loading, reading and invalidating new assets.

	[[ru:Модификации:Руководство мододела/API/Контент]]		[[ru:Модификации:Руководство мододела/API/Контент]]
	[[zh:模组:制作指南/APIs/Content]]		[[zh:模组:制作指南/APIs/Content]]

imported>Pathoschild: update for SMAPI 4.4.0 release

2026-01-11T03:43:53Z

update for SMAPI 4.4.0 release

← Older revision		Revision as of 03:43, 11 January 2026
Line 345:		Line 345:
	* <samp>PatchMode.Replace</samp> (default): erase the original content within the area before pasting in the new content;		* <samp>PatchMode.Replace</samp> (default): erase the original content within the area before pasting in the new content;
	* <samp>PatchMode.Overlay</samp>: draw the new content over the original content, so the original content shows through transparent or semi-transparent pixels.		* <samp>PatchMode.Overlay</samp>: draw the new content over the original content, so the original content shows through transparent or semi-transparent pixels.
	* ~~{{SMAPI upcoming\|4.4.0\|~~<samp>PatchMode.Mask</samp>: apply a transparency mask to the original content. This subtracts the alpha value of each pixel in the mask from the corresponding pixel in the target content (ignoring colors in mask). For example, a fully opaque pixel in the mask will result in a fully transparent pixel in the final image.}}		* <samp>PatchMode.Mask</samp>: apply a transparency mask to the original content. This subtracts the alpha value of each pixel in the mask from the corresponding pixel in the target content (ignoring colors in mask). For example, a fully opaque pixel in the mask will result in a fully transparent pixel in the final image.
	\|}		\|}

imported>Pathoschild: /* Edit an image */ + PatchMode.Mask in SMAPI 4.4.0

2026-01-11T01:10:01Z

Edit an image: + PatchMode.Mask in SMAPI 4.4.0

← Older revision		Revision as of 01:10, 11 January 2026
Line 345:		Line 345:
	* <samp>PatchMode.Replace</samp> (default): erase the original content within the area before pasting in the new content;		* <samp>PatchMode.Replace</samp> (default): erase the original content within the area before pasting in the new content;
	* <samp>PatchMode.Overlay</samp>: draw the new content over the original content, so the original content shows through transparent or semi-transparent pixels.		* <samp>PatchMode.Overlay</samp>: draw the new content over the original content, so the original content shows through transparent or semi-transparent pixels.
			* {{SMAPI upcoming\|4.4.0\|<samp>PatchMode.Mask</samp>: apply a transparency mask to the original content. This subtracts the alpha value of each pixel in the mask from the corresponding pixel in the target content (ignoring colors in mask). For example, a fully opaque pixel in the mask will result in a fully transparent pixel in the final image.}}
	\|}		\|}

imported>Margotbean: ru link

2026-01-07T18:50:31Z

ru link

← Older revision		Revision as of 18:50, 7 January 2026
Line 601:		Line 601:
	This works for any asset type (e.g. maps or textures), and you can do this even without an internal file (e.g. using <code>e.LoadFrom(() => new Dictionary<string, ExampleModel>(), AssetLoadPriority.Medium)</code>).		This works for any asset type (e.g. maps or textures), and you can do this even without an internal file (e.g. using <code>e.LoadFrom(() => new Dictionary<string, ExampleModel>(), AssetLoadPriority.Medium)</code>).

	[[ru:Модификации:Руководство мододела/API/~~Content~~]]		[[ru:Модификации:Руководство мододела/API/Контент]]
	[[zh:模组:制作指南/APIs/Content]]		[[zh:模组:制作指南/APIs/Content]]

imported>VulpesLucida: zh link

2025-01-05T14:28:34Z

zh link

← Older revision		Revision as of 14:28, 5 January 2025
Line 602:		Line 602:

	[[ru:Модификации:Руководство мододела/API/Content]]		[[ru:Модификации:Руководство мододела/API/Content]]
			[[zh:模组:制作指南/APIs/Content]]

imported>Quicksilver at 23:34, 3 December 2024

2024-12-03T23:34:13Z

← Older revision		Revision as of 23:34, 3 December 2024
Line 601:		Line 601:
	This works for any asset type (e.g. maps or textures), and you can do this even without an internal file (e.g. using <code>e.LoadFrom(() => new Dictionary<string, ExampleModel>(), AssetLoadPriority.Medium)</code>).		This works for any asset type (e.g. maps or textures), and you can do this even without an internal file (e.g. using <code>e.LoadFrom(() => new Dictionary<string, ExampleModel>(), AssetLoadPriority.Medium)</code>).

	[[ru:Модификации:~~Моддер гайд~~/~~APIs~~/~~Контент~~]]		[[ru:Модификации:Руководство мододела/API/Content]]

imported>Pathoschild: /* What's an 'asset name'? */ update Content Patcher info (no longer changing in 2.0)

2024-05-29T04:35:31Z

What's an 'asset name'?: update Content Patcher info (no longer changing in 2.0)

← Older revision		Revision as of 04:35, 29 May 2024
Line 26:		Line 26:
	\|}		\|}

	~~For legacy reasons, the asset name~~ in [[Modding:Content Patcher\|Content Patcher ~~content~~ packs]] ~~does not~~ include the language code. ~~That will change in~~ the ~~upcoming~~ Content Patcher ~~2.0.0~~.		Note that in [[Modding:Content Patcher\|Content Patcher packs]], the asset name ''doesn't'' include the language code. For example, the Content Patcher asset name in the second row above is <samp>Maps/Desert</samp>.

	===What does the content API do?===		===What does the content API do?===

imported>Gdnoob1324 at 04:51, 12 May 2024

2024-05-12T04:51:01Z

← Older revision		Revision as of 04:51, 12 May 2024
Line 240:		Line 240:
	private void OnAssetRequested(object sender, AssetRequestedEventArgs e)		private void OnAssetRequested(object sender, AssetRequestedEventArgs e)
	{		{
	if (e.NameWithoutLocale.IsEquivalentTo("Data/~~ObjectInformation~~"))		if (e.NameWithoutLocale.IsEquivalentTo("Data/Objects"))
	{		{
	e.Edit(asset =>		e.Edit(asset =>
	{		{
	var data = asset.AsDictionary<~~int~~, ~~string~~>().Data;		var data = asset.AsDictionary<string, ObjectData>().Data;

	foreach ((~~int~~ itemID, ~~string~~ itemData) in data)		foreach ((string itemID, ObjectData itemData) in data)
	{		{
	~~string[] fields =~~ itemData.~~Split('/');~~		itemData.Price *= 2;
	~~fields[1]~~ = (int.Parse(fields[1]) * 2~~).ToString();~~
	~~data[itemID] = string.Join('/', fields)~~;
	}		}
	});		});

imported>Pathoschild: /* Edit an image */ update PatchMode.Overlay for alpha blending in newer versions

2024-04-14T15:49:32Z

Edit an image: update PatchMode.Overlay for alpha blending in newer versions

← Older revision		Revision as of 15:49, 14 April 2024
Line 346:		Line 346:
	\| ''(optional)'' How the image should be patched. The possible values...		\| ''(optional)'' How the image should be patched. The possible values...
	* <samp>PatchMode.Replace</samp> (default): erase the original content within the area before pasting in the new content;		* <samp>PatchMode.Replace</samp> (default): erase the original content within the area before pasting in the new content;
	* <samp>PatchMode.Overlay</samp>: draw the new content over the original content, so the original content shows through ~~any ''fully''~~ transparent pixels.		* <samp>PatchMode.Overlay</samp>: draw the new content over the original content, so the original content shows through transparent or semi-transparent pixels.
	\|}		\|}

	:; ExtendImage		:; ExtendImage
	:: Extend the image if needed to fit the given size. Note that '''~~this~~ is an expensive operation''', creates a new texture instance, and extending a spritesheet horizontally may cause game errors or bugs. For example:		:: Extend the image if needed to fit the given size. Note that '''resizing the image is an expensive operation''', creates a new texture instance, and extending a spritesheet horizontally may cause game errors or bugs. For example:
	:: <syntaxhighlight lang="C#">		:: <syntaxhighlight lang="C#">

imported>DeLiXxN at 02:21, 19 May 2023

2023-05-19T02:21:15Z

← Older revision		Revision as of 02:21, 19 May 2023
Line 515:		Line 515:
	===Cache invalidation===		===Cache invalidation===
	You can reload an asset by invalidating it from the cache. It will be reloaded next time the game requests it (and mods will have another chance to intercept it), and SMAPI will automatically update references to the asset in many cases. For example, this lets you change what clothes an NPC is wearing (by invalidating their cached sprites or portraits).		You can reload an asset by invalidating it from the cache. It will be reloaded next time the game requests it (and mods will have another chance to intercept it), and SMAPI will automatically update references to the asset in many cases. For example, this lets you change what clothes an NPC is wearing (by invalidating their cached sprites or portraits).

	Please be aware that in some cases a localized version of the asset will be cached and simply invalidating the default asset will not work for any language other than english.		Please be aware that in some cases a localized version of the asset will be cached and simply invalidating the default asset will not work for any language other than english.