模组:制作指南/APIs/Config

制作SMAPI模组

---

• 入门
• 游戏基本架构
• 测试和疑难解答
• 发布
• SMAPI中的API

  基本API：

  • Mod structure
  • Manifest
  • Events
  • Configuration
  • Load & edit content
  • Data
  • Input
  • Logging
  • Reflection
  • Multiplayer
  • Translation
  • Update checks
  • Utilities

  进阶API:

  • Content packs
  • Mod console commands
  • Mod integrations
  • Harmony patching

• 更多指南

← 模组:目录

“ “我这里还有很多事情需要处理。” — 罗宾 不完整的翻译 本文或部分尚未完全翻译成中文。 欢迎您通过编辑帮助其建设。 最后编辑Candybear于2024-09-08 14:48:17.

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

配置模型

创建配置模型

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).
这是一个简单的配置模型:

public sealed class ModConfig
{
   public bool ExampleBoolean { get; set; }
   public int ExampleNumber { get; set; }
}

这个模型将会保存到config.json中，内容如下：

{
   "ExampleBoolean": false,
   "ExampleNumber": 0
}

这个属性必须是公开的。

默认值

你可以在数据模型中设置默认值：

public sealed class ModConfig
{
   public bool ExampleBoolean { get; set; } = true;
   public int ExampleNumber { get; set; } = 5;
}

...or set defaults with a constructor:

public sealed class ModConfig
{
   public bool ExampleBoolean { get; set; }
   public int ExampleNumber { get; set; }

   public ModConfig()
   {
      this.ExampleBoolean = true;
      this.ExampleNumber = 5;
   }
}

Using the config file

To read the config.json (SMAPI will create it automatically):

1. Create your config model.
2. Access the config values in your ModEntry class:

   /// <summary>The main entry point for the mod.</summary>
   internal sealed class ModEntry : Mod
   {
       /*********
       ** Properties
       *********/
       /// <summary>The mod configuration from the player.</summary>
       private ModConfig Config;
   
   
       /*********
       ** Public methods
       *********/
       /// <summary>The mod entry point, called after the mod is first loaded.</summary>
       /// <param name="helper">Provides simplified APIs for writing mods.</param>
       public override void Entry(IModHelper helper)
       {
           this.Config = this.Helper.ReadConfig<ModConfig>();
           bool exampleBool = this.Config.ExampleBoolean;
       }
   }
   

That's it! When the player launches the game, SMAPI will create the config.json 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 this.Helper.WriteConfig(this.Config).

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

Keybind settings

主要文章：模组:制作指南/APIs/Input

You can use SMAPI's KeybindList in your model to let users configure keybinds. This automatically supports multi-key or alternative bindings (e.g., to support split-screen mode):

class ModConfig
{
   public KeybindList ToggleKey { get; set; } = KeybindList.Parse("LeftShift + F2, LeftTrigger");
}

The value is automatically written/parsed in the config.json file as a string:

{
   "ToggleKey": "LeftShift + F2, LeftTrigger"
}