528
edits
Changes
Jump to navigation
Jump to search
Line 1:
Line 1: − + − + − + + + + + + + + + + + + + + + + + + + − <ol>+ − <li>Create your model. This is just a C# class with properties for the config options you want, and it can contain almost anything from a few boolean fields to a complex object graph. (You should try to keep it simple for your users, though.) You can set default values directly:+ − + − + − + − + − + − + − + − + − + − + − + + + + + + + − public class ModEntry : Mod+ Line 54:
Line 78: − + − + − ==JSON files==+ − ===Using JSON files=== − Sometimes one <tt>config.json</tt> isn't enough, or you need to store data that's not meant to be edited by the user. This is pretty easy too: − <ol> − <li>Create your model (just like the previous section).</li> − <li>In your mod code, use the mod helper to read/write a named file. This example assumes you created a class named <tt>ModData</tt>, but you can use different names too. − <source lang="c#">+ − + − var model = this.Helper.ReadJsonFile<ModData>("data.json") ?? new ModData(); − + − this.Helper.WriteJsonFile("data.json", model); − </source> − Note that <tt>ReadJsonFile</tt> will return <tt>null</tt> if the file doesn't exist. The above example will create a default instance if that happens; if you don't want to do that, just remove the <code>?? new ModData()</code> part.</li>+ − + + + + + − ===Subfolders and file names===+ − + − + − ===Per-save JSON files===+ − You can create per-save files by using the save ID in the name. For example, here's a typical per-save data file:+ − + − − // read file − var model = this.Helper.ReadJsonFile<ModData>($"data/{Constants.SaveFolderName}.json") ?? new ModData(); − − // write file (if needed) − this.Helper.WriteJsonFile($"data/{Constants.SaveFolderName}.json", model); −
Modding:Modder Guide/APIs/Config (view source)
Revision as of 02:07, 26 May 2023
, 02:07, 26 May 2023→Using the config file
{{../../header}}
{{../../header}}
You can let users configure your mod through a <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 files==
==Config model==
Here's the simplest way to use <tt>config.json</tt>:
===Creating a 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#">
public sealed class ModConfig
{
public bool ExampleBoolean { get; set; }
public int ExampleNumber { get; set; }
}
</syntaxhighlight>
That model would be saved to <samp>config.json</samp> with this content:
<syntaxhighlight lang="json">
{
"ExampleBoolean": false,
"ExampleNumber": 0
}
</syntaxhighlight>
These properties must be public.
===Default values===
You can set default values in your data model:
<source lang="c#">
<syntaxhighlight lang="c#">
class ModConfig
public sealed class ModConfig
{
{
public bool ExampleBoolean { get; set; } = true;
public bool ExampleBoolean { get; set; } = true;
public float ExampleFloat { get; set; } = 0.5f;
public int ExampleNumber { get; set; } = 5;
}
}
</source>
</syntaxhighlight>
...or set defaults with a constructor:
...or set defaults with a constructor:
<source lang="c#">
<syntaxhighlight lang="c#">
class ModConfig
public sealed class ModConfig
{
{
public bool ExampleBoolean { get; set; }
public bool ExampleBoolean { get; set; }
public float ExampleFloat { get; set; }
public int ExampleNumber { get; set; }
public ModConfig()
public ModConfig()
{
{
this.ExampleBoolean = true;
this.ExampleBoolean = true;
this.ExampleFloat = 0.5f;
this.ExampleNumber = 5;
}
}
}
}
</source></li>
</syntaxhighlight>
<li>Here's how you can access the config values in your <tt>ModEntry</tt> class:
<source lang="c#">
==Using the config file==
To read the <samp>config.json</samp> (SMAPI will create it automatically):
<ol>
<li>Create your [[#Config model|config model]].</li>
<li>Access the config values in your <samp>ModEntry</samp> class:
<syntaxhighlight lang="c#">
/// <summary>The main entry point for the mod.</summary>
/// <summary>The main entry point for the mod.</summary>
internal sealed class ModEntry : Mod
{
{
/*********
/*********
}
}
}
}
</source>
</syntaxhighlight>
</li>
</li>
</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(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>.
Note that <samp>ReadConfig</samp> will raise an exception if the user does not provide a valid JSON.
==Keybind settings==
// read file
: {{main article|Modding:Modder Guide/APIs/Input}}
// save file (if needed)
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#">
</ol>
class ModConfig
{
public KeybindList ToggleKey { get; set; } = KeybindList.Parse("LeftShift + F2, LeftTrigger");
}
</syntaxhighlight>
The value is automatically written/parsed in the <samp>config.json</samp> file as a string:
The above example just uses <tt>"data.json"</tt>, but you can use any valid file name. If you specify a path relative to your mod folder (like <tt>data/some-file.json</tt>), SMAPI will create the folders automatically if needed.
<syntaxhighlight lang="json">
{
"ToggleKey": "LeftShift + F2, LeftTrigger"
}
</syntaxhighlight>
<source lang="c#">
</source>