translators
8,445
edits
Changes
Jump to navigation
Jump to search
Line 365:
Line 365: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modding:Modder Guide/Tutorial Mod (view source)
Revision as of 00:20, 4 May 2017
, 00:20, 4 May 2017→Configuration: copy subpage from canimod.com with permission, dual-licensed CC BY-NC-SA for compatibility with wiki. Only author is Pathoschild.
* using a config wrapper for file I/O;
* using a config wrapper for file I/O;
* overriding JSON serialization.
* overriding JSON serialization.
<pre>
---
layout: default
title: Advanced SMAPI mod configuration
intro: >
This page explains more advanced ways to use JSON files through <code>this.Helper</code>.
This page is overkill for the vast majority of mods; see
<em><a href="creating-a-smapi-mod#configuration">creating a SMAPI mod</a></em>
for a simpler approach that is sufficient for most mods.
permalink: /for-devs/creating-a-smapi-mod-advanced-config
redirect_from:
- /guides/creating-a-smapi-mod-advanced-config
---
## Custom JSON files
Sometimes one `config.json` isn't enough, or you need to store data that's not meant to be edited
by the user. This is pretty easy using the `ModHelper`:
1. Create your model (see the main guide for more details):
```c#
class ModData
{
public bool ExampleBoolean { get; set; }
public float ExampleFloat { get; set; }
public ModData()
{
this.ExampleBoolean = true;
this.ExampleFloat = 0.5;
}
}
```
2. In your mod code, just use `this.Helper` to read and write to a named file:
```c#
// read file
var model = this.Helper.ReadJsonFile<ModData>("data.json") ?? new ModData();
// save file (if needed)
this.Helper.WriteJsonFile("data.json", model);
```
Note that `ReadJsonFile` will return `null` 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
`?? new ModData()` part.
## Per-save JSON files
You can also specify a directory path (relative to your mod directory) instead of just the file
name. The directories will be created automatically if needed. For example, here's how you'd use
per-save config files:
```c#
// read file
var model = this.Helper.ReadJsonFile<ModData>($"{Constants.SaveFolderName}/config.json") ?? new ModData();
// write file (if needed)
this.Helper.WriteJsonFile($"{Constants.SaveFolderName}/config.json", model);
```
</pre>
===Content===
===Content===