Modding:Modder Guide/APIs/Config - Revision history

imported>Margotbean: ru link

2026-01-07T18:48:48Z

ru link

← Older revision		Revision as of 18:48, 7 January 2026
Line 105:		Line 105:
	</syntaxhighlight>		</syntaxhighlight>

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

imported>Sunbeam135: /* Keybind settings */

2026-01-02T12:30:15Z

Keybind settings

← Older revision		Revision as of 12:30, 2 January 2026
Line 105:		Line 105:
	</syntaxhighlight>		</syntaxhighlight>

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

imported>Candybear: add zh link

2024-09-07T23:37:11Z

add zh link

← Older revision		Revision as of 23:37, 7 September 2024
Line 104:		Line 104:
	}		}
	</syntaxhighlight>		</syntaxhighlight>

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

imported>Atravita: /* Using the config file */

2023-05-26T02:07:27Z

Using the config file

← Older revision		Revision as of 02:07, 26 May 2023
Line 83:		Line 83:

	That's it! When the player launches the game, SMAPI will create the <samp>config.json</samp> file automatically if it doesn't exist yet, using the default config options you provided in your model. If you need to save some changes, you can use <samp>this.Helper.WriteConfig(this.Config)</samp>.		That's it! When the player launches the game, SMAPI will create the <samp>config.json</samp> file automatically if it doesn't exist yet, using the default config options you provided in your model. If you need to save some changes, you can use <samp>this.Helper.WriteConfig(this.Config)</samp>.

			Note that <samp>ReadConfig</samp> will raise an exception if the user does not provide a valid JSON.

	==Keybind settings==		==Keybind settings==

imported>Atravita: /* Using the config file */

2022-11-28T02:40:19Z

Using the config file

← Older revision		Revision as of 02:40, 28 November 2022
Line 58:		Line 58:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	/// <summary>The main entry point for the mod.</summary>		/// <summary>The main entry point for the mod.</summary>
	~~public~~ class ModEntry : Mod		internal sealed class ModEntry : Mod
	{		{
	/*********		/*********

imported>Atravita: /* Default values */

2022-11-28T02:39:50Z

Default values

← Older revision		Revision as of 02:39, 28 November 2022
Line 27:		Line 27:
	You can set default values in your data model:		You can set default values in your data model:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	class ModConfig		public sealed class ModConfig
	{		{
	public bool ExampleBoolean { get; set; } = true;		public bool ExampleBoolean { get; set; } = true;
Line 37:		Line 37:

	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	class ModConfig		public sealed class ModConfig
	{		{
	public bool ExampleBoolean { get; set; }		public bool ExampleBoolean { get; set; }

imported>Atravita: /* Creating a config model */

2022-11-28T02:39:31Z

Creating a config model

← Older revision		Revision as of 02:39, 28 November 2022
Line 7:		Line 7:
	The ''config model'' is a C# class you create, with properties representing the settings you want to store. It can contain almost anything from a few boolean fields to a complex object graph (though you should try to keep things simple for players). Here's a simple config model:		The ''config model'' is a C# class you create, with properties representing the settings you want to store. It can contain almost anything from a few boolean fields to a complex object graph (though you should try to keep things simple for players). Here's a simple config model:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	class ModConfig		public sealed class ModConfig
	{		{
	public bool ExampleBoolean { get; set; }		public bool ExampleBoolean { get; set; }
Line 21:		Line 21:
	}		}
	</syntaxhighlight>		</syntaxhighlight>

			These properties must be public.

	===Default values===		===Default values===

imported>Margotbean: Text replacement - "''e.g.''," to "''e.g.,''"

2021-11-08T00:39:45Z

Text replacement - "''e.g.''," to "''e.g.,''"

← Older revision		Revision as of 00:39, 8 November 2021
Line 85:		Line 85:
	: {{main article\|Modding:Modder Guide/APIs/Input}}		: {{main article\|Modding:Modder Guide/APIs/Input}}

	You can use SMAPI's [[Modding:Modder Guide/APIs/Input#KeybindList\|<samp>KeybindList</samp>]] in your model to let users configure keybinds. This automatically supports multi-key or alternative bindings (''e.g.'', to support split-screen mode):		You can use SMAPI's [[Modding:Modder Guide/APIs/Input#KeybindList\|<samp>KeybindList</samp>]] in your model to let users configure keybinds. This automatically supports multi-key or alternative bindings (''e.g.,'' to support split-screen mode):

	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">

imported>Margotbean: Text replacement - "(e.g. " to "(''e.g.'', "

2021-11-07T23:41:28Z

Text replacement - "(e.g. " to "(''e.g.'', "

← Older revision		Revision as of 23:41, 7 November 2021
Line 85:		Line 85:
	: {{main article\|Modding:Modder Guide/APIs/Input}}		: {{main article\|Modding:Modder Guide/APIs/Input}}

	You can use SMAPI's [[Modding:Modder Guide/APIs/Input#KeybindList\|<samp>KeybindList</samp>]] in your model to let users configure keybinds. This automatically supports multi-key or alternative bindings (e.g. to support split-screen mode):		You can use SMAPI's [[Modding:Modder Guide/APIs/Input#KeybindList\|<samp>KeybindList</samp>]] in your model to let users configure keybinds. This automatically supports multi-key or alternative bindings (''e.g.'', to support split-screen mode):

	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">

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

2021-11-04T18:48:10Z

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

← Older revision		Revision as of 18:48, 4 November 2021
Line 1:		Line 1:
	{{../../header}}		{{../../header}}

	You can let users configure your mod through a standard <tt>config.json</tt> file. SMAPI will automatically create the file and take care of reading, normalising, and updating it.		You can let users configure your mod through a standard <samp>config.json</samp> file. SMAPI will automatically create the file and take care of reading, normalising, and updating it.

	==Config model==		==Config model==
Line 14:		Line 14:
	</syntaxhighlight>		</syntaxhighlight>

	That model would be saved to <tt>config.json</tt> with this content:		That model would be saved to <samp>config.json</samp> with this content:
	<syntaxhighlight lang="json">		<syntaxhighlight lang="json">
	{		{
Line 49:		Line 49:

	==Using the config file==		==Using the config file==
	To read the <tt>config.json</tt> (SMAPI will create it automatically):		To read the <samp>config.json</samp> (SMAPI will create it automatically):

	<ol>		<ol>
	<li>Create your [[#Config model\|config model]].</li>		<li>Create your [[#Config model\|config model]].</li>
	<li>Access the config values in your <tt>ModEntry</tt> class:		<li>Access the config values in your <samp>ModEntry</samp> class:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	/// <summary>The main entry point for the mod.</summary>		/// <summary>The main entry point for the mod.</summary>
Line 80:		Line 80:
	</ol>		</ol>

	That's it! When the player launches the game, SMAPI will create the <tt>config.json</tt> file automatically if it doesn't exist yet, using the default config options you provided in your model. If you need to save some changes, you can use <tt>this.Helper.WriteConfig(this.Config)</tt>.		That's it! When the player launches the game, SMAPI will create the <samp>config.json</samp> file automatically if it doesn't exist yet, using the default config options you provided in your model. If you need to save some changes, you can use <samp>this.Helper.WriteConfig(this.Config)</samp>.

	==Keybind settings==		==Keybind settings==
	: {{main article\|Modding:Modder Guide/APIs/Input}}		: {{main article\|Modding:Modder Guide/APIs/Input}}

	You can use SMAPI's [[Modding:Modder Guide/APIs/Input#KeybindList\|<tt>KeybindList</tt>]] in your model to let users configure keybinds. This automatically supports multi-key or alternative bindings (e.g. to support split-screen mode):		You can use SMAPI's [[Modding:Modder Guide/APIs/Input#KeybindList\|<samp>KeybindList</samp>]] in your model to let users configure keybinds. This automatically supports multi-key or alternative bindings (e.g. to support split-screen mode):

	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
Line 94:		Line 94:
	</syntaxhighlight>		</syntaxhighlight>

	The value is automatically written/parsed in the <tt>config.json</tt> file as a string:		The value is automatically written/parsed in the <samp>config.json</samp> file as a string:
	<syntaxhighlight lang="json">		<syntaxhighlight lang="json">
	{		{