Modding:Modder Guide/APIs/Mod structure - Revision history

imported>Margotbean: update ru link

2026-01-07T18:30:26Z

update ru link

← Older revision		Revision as of 18:30, 7 January 2026
Line 58:		Line 58:

	[[es:Modding:Guía del Modder/APIs/Mod structure]]		[[es:Modding:Guía del Modder/APIs/Mod structure]]
	[[ru:Модификации:Руководство мододела/API/~~Mod structure~~]]		[[ru:Модификации:Руководство мододела/API/Структура мода]]
	[[zh:模组:制作指南/APIs/Mod structure]]		[[zh:模组:制作指南/APIs/Mod structure]]

imported>Sunbeam135: /* Dependencies */

2026-01-02T11:25:27Z

Dependencies

← Older revision		Revision as of 11:25, 2 January 2026
Line 58:		Line 58:

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

imported>Atravita: /* Mod entry */ seal by default.

2022-11-28T02:35:56Z

Mod entry: seal by default.

← Older revision		Revision as of 02:35, 28 November 2022
Line 23:		Line 23:

	/// <summary>The mod entry point.</summary>		/// <summary>The mod entry point.</summary>
	~~public~~ class ModEntry : Mod		internal sealed class ModEntry : Mod
	{		{
	/// <summary>The mod entry point, called after the mod is first loaded.</summary>		/// <summary>The mod entry point, called after the mod is first loaded.</summary>

imported>Margotbean: ES link

2022-02-02T17:35:28Z

ES link

← Older revision		Revision as of 17:35, 2 February 2022
Line 57:		Line 57:
	* Reference projects/DLLs and copy their DLLs into your mod folder. SMAPI will detect the reference and load the DLLs from your mod folder automatically. '''Don't do this for referencing a mod''' — that can cause confusing errors when multiple versions are available (see the first option instead).		* Reference projects/DLLs and copy their DLLs into your mod folder. SMAPI will detect the reference and load the DLLs from your mod folder automatically. '''Don't do this for referencing a mod''' — that can cause confusing errors when multiple versions are available (see the first option instead).

			[[es:Modding:Guía del Modder/APIs/Mod structure]]
	[[zh:模组:制作指南/APIs/Mod structure]]		[[zh:模组:制作指南/APIs/Mod structure]]

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

2021-11-04T18:48:28Z

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

← Older revision		Revision as of 18:48, 4 November 2021
Line 8:		Line 8:
	A SMAPI mod must have...		A SMAPI mod must have...
	# a compiled DLL file which contains the code to run as part of the mod (see [[#Mod entry\|''mod entry'' below]]);		# a compiled DLL file which contains the code to run as part of the mod (see [[#Mod entry\|''mod entry'' below]]);
	# a [[Modding:Modder Guide/APIs/Manifest\|<tt>manifest.json</tt> file]] which describes the mod.		# a [[Modding:Modder Guide/APIs/Manifest\|<samp>manifest.json</samp> file]] which describes the mod.

	It may optionally have...		It may optionally have...
	# any number of [[#Dependencies\|compiled <tt>.dll</tt> and <tt>.pdb</tt> files referenced by the main mod DLL]];		# any number of [[#Dependencies\|compiled <samp>.dll</samp> and <samp>.pdb</samp> files referenced by the main mod DLL]];
	# an [[Modding:Modder Guide/APIs/Translation\|<tt>i18n</tt> folder containing translations]];		# an [[Modding:Modder Guide/APIs/Translation\|<samp>i18n</samp> folder containing translations]];
	# any number of custom files used by the mod code (usually in an <tt>assets</tt> folder by convention).		# any number of custom files used by the mod code (usually in an <samp>assets</samp> folder by convention).

	==Mod entry==		==Mod entry==
	The main mod project must have a subclass of <tt>StardewModdingAPI.Mod</tt>. The class is often named <tt>ModEntry</tt> by convention, but you can use any valid C# name. The class must implement an <tt>Entry</tt> method, which SMAPI will call once the mod is loaded. The <tt>helper</tt> argument provides access to nearly all [[Modding:Modder Guide/APIs\|SMAPI APIs]] (available as <tt>this.Helper</tt> in other methods).		The main mod project must have a subclass of <samp>StardewModdingAPI.Mod</samp>. The class is often named <samp>ModEntry</samp> by convention, but you can use any valid C# name. The class must implement an <samp>Entry</samp> method, which SMAPI will call once the mod is loaded. The <samp>helper</samp> argument provides access to nearly all [[Modding:Modder Guide/APIs\|SMAPI APIs]] (available as <samp>this.Helper</samp> in other methods).

	Here's the minimum possible implementation (which does nothing at all):		Here's the minimum possible implementation (which does nothing at all):
Line 34:		Line 34:
	</syntaxhighlight>		</syntaxhighlight>

	The <tt>Entry</tt> method is called very early in the launch process, so some things aren't initialised yet. You can use events like <tt>GameLaunched</tt>, <tt>SaveLoaded</tt>, or <tt>DayStarted</tt> to access all features. Here's a quick summary of using APIs in <tt>Entry</tt>:		The <samp>Entry</samp> method is called very early in the launch process, so some things aren't initialised yet. You can use events like <samp>GameLaunched</samp>, <samp>SaveLoaded</samp>, or <samp>DayStarted</samp> to access all features. Here's a quick summary of using APIs in <samp>Entry</samp>:
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
Line 43:		Line 43:
	\| ✓ available. That includes [[Modding:Modder Guide/APIs/Events\|registering event handlers]], [[Modding:Modder Guide/APIs/Config\|reading configuration]], [[Modding:Modder Guide/APIs/Content\|loading assets]], and [[Modding:Modder Guide/APIs/Integrations#Mod registry\|fetching mod info]].		\| ✓ available. That includes [[Modding:Modder Guide/APIs/Events\|registering event handlers]], [[Modding:Modder Guide/APIs/Config\|reading configuration]], [[Modding:Modder Guide/APIs/Content\|loading assets]], and [[Modding:Modder Guide/APIs/Integrations#Mod registry\|fetching mod info]].
	\|-		\|-
	\| <tt>helper.ModRegistry.GetApi</tt>		\| <samp>helper.ModRegistry.GetApi</samp>
	\| ✖ Not available, since some mods aren't initialised yet.		\| ✖ Not available, since some mods aren't initialised yet.
	\|-		\|-
	\| Game fields		\| Game fields
	\| ✖ Not reliably available, since mods are loaded early in the process. That includes core fields like <tt>Game1.objectInformation</tt>.		\| ✖ Not reliably available, since mods are loaded early in the process. That includes core fields like <samp>Game1.objectInformation</samp>.
	\|}		\|}

imported>臭美香喷喷: zh link added.

2021-06-26T04:35:08Z

zh link added.

← Older revision		Revision as of 04:35, 26 June 2021
Line 56:		Line 56:
	* [https://docs.microsoft.com/en-us/xamarin/cross-platform/app-fundamentals/shared-projects Create a shared project] and reference it from your mod project. The shared project's code will be compiled as part of your mod project (so it'll be one DLL containing both projects in the mod folder).		* [https://docs.microsoft.com/en-us/xamarin/cross-platform/app-fundamentals/shared-projects Create a shared project] and reference it from your mod project. The shared project's code will be compiled as part of your mod project (so it'll be one DLL containing both projects in the mod folder).
	* Reference projects/DLLs and copy their DLLs into your mod folder. SMAPI will detect the reference and load the DLLs from your mod folder automatically. '''Don't do this for referencing a mod''' — that can cause confusing errors when multiple versions are available (see the first option instead).		* Reference projects/DLLs and copy their DLLs into your mod folder. SMAPI will detect the reference and load the DLLs from your mod folder automatically. '''Don't do this for referencing a mod''' — that can cause confusing errors when multiple versions are available (see the first option instead).

			[[zh:模组:制作指南/APIs/Mod structure]]

imported>RetroEdit: Replace deprecated tags with tags

2021-02-19T18:26:22Z

Replace deprecated <source> tags with <syntaxhighlight> tags

← Older revision		Revision as of 18:26, 19 February 2021
Line 19:		Line 19:

	Here's the minimum possible implementation (which does nothing at all):		Here's the minimum possible implementation (which does nothing at all):
	<~~source~~ lang="c#">		<syntaxhighlight lang="c#">
	using StardewModdingAPI;		using StardewModdingAPI;

Line 32:		Line 32:
	}		}
	}		}
	</~~source~~>		</syntaxhighlight>

	The <tt>Entry</tt> method is called very early in the launch process, so some things aren't initialised yet. You can use events like <tt>GameLaunched</tt>, <tt>SaveLoaded</tt>, or <tt>DayStarted</tt> to access all features. Here's a quick summary of using APIs in <tt>Entry</tt>:		The <tt>Entry</tt> method is called very early in the launch process, so some things aren't initialised yet. You can use events like <tt>GameLaunched</tt>, <tt>SaveLoaded</tt>, or <tt>DayStarted</tt> to access all features. Here's a quick summary of using APIs in <tt>Entry</tt>:

imported>Pathoschild: remove footer (no longer needed with new sidebar)

2019-09-13T17:49:48Z

remove footer (no longer needed with new sidebar)

← Older revision		Revision as of 17:49, 13 September 2019
Line 1:		Line 1:
	{{../../header}}		{{../../header}}

	'''See [[Modding:Modder Guide/Get Started\|Modding:Modder Guide]] for an introduction to creating a SMAPI mod. This is a technical reference page which assumes you've already followed that guide.'''		'''See [[Modding:Modder Guide/Get Started\|Modding:Modder Guide]] for an introduction to creating a SMAPI mod. This is a technical reference page which assumes you've already followed that guide.'''

	__TOC__		__TOC__

	==Basic structure==		==Basic structure==
	A SMAPI mod must have...		A SMAPI mod must have...
Line 53:		Line 56:
	* [https://docs.microsoft.com/en-us/xamarin/cross-platform/app-fundamentals/shared-projects Create a shared project] and reference it from your mod project. The shared project's code will be compiled as part of your mod project (so it'll be one DLL containing both projects in the mod folder).		* [https://docs.microsoft.com/en-us/xamarin/cross-platform/app-fundamentals/shared-projects Create a shared project] and reference it from your mod project. The shared project's code will be compiled as part of your mod project (so it'll be one DLL containing both projects in the mod folder).
	* Reference projects/DLLs and copy their DLLs into your mod folder. SMAPI will detect the reference and load the DLLs from your mod folder automatically. '''Don't do this for referencing a mod''' — that can cause confusing errors when multiple versions are available (see the first option instead).		* Reference projects/DLLs and copy their DLLs into your mod folder. SMAPI will detect the reference and load the DLLs from your mod folder automatically. '''Don't do this for referencing a mod''' — that can cause confusing errors when multiple versions are available (see the first option instead).

	~~{{modding guide footer~~
	~~\|prev = [[Modding:Modder Guide/APIs\|SMAPI reference]]~~
	~~\|next =~~
	}}

imported>Margotbean: direct link to "Modder Guide"

2019-05-07T19:56:52Z

direct link to "Modder Guide"

← Older revision		Revision as of 19:56, 7 May 2019
Line 1:		Line 1:
	{{../../header}}		{{../../header}}
	'''See [[Modding:Modder Guide]] for an introduction to creating a SMAPI mod. This is a technical reference page which assumes you've already followed that guide.'''		'''See [[Modding:Modder Guide/Get Started\|Modding:Modder Guide]] for an introduction to creating a SMAPI mod. This is a technical reference page which assumes you've already followed that guide.'''
	__TOC__		__TOC__
	==Basic structure==		==Basic structure==

imported>Pathoschild: /* Mod entry */ simplify argument reference

2019-04-02T16:36:55Z

Mod entry: simplify argument reference

← Older revision		Revision as of 16:36, 2 April 2019
Line 13:		Line 13:

	==Mod entry==		==Mod entry==
	The main mod project must have a subclass of <tt>StardewModdingAPI.Mod</tt>. The class is often named <tt>ModEntry</tt> by convention, but you can use any valid C# name. The class must implement an <tt>Entry</tt> method, which SMAPI will call once the mod is loaded. The <tt>~~IModHelper~~ helper</tt> argument provides access to nearly all [[Modding:Modder Guide/APIs\|SMAPI APIs]] (available as <tt>this.Helper</tt> in other methods).		The main mod project must have a subclass of <tt>StardewModdingAPI.Mod</tt>. The class is often named <tt>ModEntry</tt> by convention, but you can use any valid C# name. The class must implement an <tt>Entry</tt> method, which SMAPI will call once the mod is loaded. The <tt>helper</tt> argument provides access to nearly all [[Modding:Modder Guide/APIs\|SMAPI APIs]] (available as <tt>this.Helper</tt> in other methods).

	Here's the minimum possible implementation (which does nothing at all):		Here's the minimum possible implementation (which does nothing at all):