Difference between revisions of "Modding:Migrate to SMAPI 2.0"
Margotbean (talk | contribs) (update link) |
Margotbean (talk | contribs) m (Text replacement - "tt>" to "samp>") |
||
(2 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
←[[Modding:Index|Index]] | ←[[Modding:Index|Index]] | ||
− | + | {{Modder compatibility header}} | |
− | |||
This page explains how to update your SMAPI mod code for compatibility with SMAPI 1.9 (released alongside Stardew Valley 1.2 in April 2017) and 2.0 (released in October 2017). | This page explains how to update your SMAPI mod code for compatibility with SMAPI 1.9 (released alongside Stardew Valley 1.2 in April 2017) and 2.0 (released in October 2017). | ||
Line 9: | Line 8: | ||
[[File:SMAPI compatibility.png|thumb|SMAPI compatibility over time. The SMAPI 2.0 release in October 2017 appears as a small bump.]] | [[File:SMAPI compatibility.png|thumb|SMAPI compatibility over time. The SMAPI 2.0 release in October 2017 appears as a small bump.]] | ||
− | The last major breaking change was in SMAPI 0.40 (April 2016). Since then 23 SMAPI releases were published with almost full backwards compatibility. SMAPI has matured significantly since version 0.40, and its APIs have converged towards better consistency. Older APIs have been [[wikipedia:Deprecation|deprecated]] with full support, but this introduces significant maintenance overhead. A few rarely-used APIs were dropped in SMAPI 1.9 (when Stardew Valley 1.2 broke many mods),and SMAPI 2.0 is the release which finally drops support for these old APIs. | + | The last major breaking change was in SMAPI 0.40 (April 2016). Since then 23 SMAPI releases were published with almost full backwards compatibility. SMAPI has matured significantly since version 0.40, and its APIs have converged towards better consistency. Older APIs have been [[wikipedia:Deprecation|deprecated]] with full support, but this introduces significant maintenance overhead. A few rarely-used APIs were dropped in SMAPI 1.9 (when Stardew Valley 1.2 broke many mods), and SMAPI 2.0 is the release which finally drops support for these old APIs. |
Although this is a major change, significant effort was undertaken to minimise the impact on mods: (a) the APIs were supported for a long time with increasingly prominent warnings in the SMAPI console about their deprecation and removal; (b) dozens of pull requests were submitted to update affected mods; (c) unofficial updates were created for mods which haven't updated officially yet; and (d) the changes were actively communicated and documented to modders. This means that SMAPI 2.0 has a minimal impact on mod compatibility (see chart on the right). | Although this is a major change, significant effort was undertaken to minimise the impact on mods: (a) the APIs were supported for a long time with increasingly prominent warnings in the SMAPI console about their deprecation and removal; (b) dozens of pull requests were submitted to update affected mods; (c) unofficial updates were created for mods which haven't updated officially yet; and (d) the changes were actively communicated and documented to modders. This means that SMAPI 2.0 has a minimal impact on mod compatibility (see chart on the right). | ||
Line 33: | Line 32: | ||
| 0.39.3 | | 0.39.3 | ||
| 1.9¹ | | 1.9¹ | ||
− | | < | + | | <samp>SObject</samp> class |
| reimplement if needed. | | reimplement if needed. | ||
|- | |- | ||
| 0.39.3 | | 0.39.3 | ||
| 1.9¹ | | 1.9¹ | ||
− | | < | + | | <samp>Extensions.ToSingular(…)</samp> |
− | | use < | + | | use <samp>string.Join</samp>. |
|- | |- | ||
| 1.0 | | 1.0 | ||
| 1.9¹ | | 1.9¹ | ||
− | | < | + | | <samp>Authour</samp> in <samp>manifest.json</samp> |
− | | use < | + | | use <samp>Author</samp>. |
|- | |- | ||
| 1.0 | | 1.0 | ||
| 1.9¹ | | 1.9¹ | ||
− | | < | + | | <samp>Extensions</samp> class |
| reimplement if needed, or use an extensions library. | | reimplement if needed, or use an extensions library. | ||
|- | |- | ||
| 1.0 | | 1.0 | ||
| 1.9¹ | | 1.9¹ | ||
− | | < | + | | <samp>LogWriter</samp> class |
− | | use < | + | | use <samp>this.Monitor.Log</samp>. |
|- | |- | ||
| 1.0 | | 1.0 | ||
| 1.9¹ | | 1.9¹ | ||
− | | < | + | | <samp>SPlayer</samp> class |
− | | use < | + | | use <samp>Game1.player</samp>. |
|- | |- | ||
| 1.0<br /><small><em>experimental API</em></small> | | 1.0<br /><small><em>experimental API</em></small> | ||
| 1.9¹ | | 1.9¹ | ||
− | | < | + | | <samp>IConfigFile</samp> and <samp>ConfigFile</samp> |
| reimplement if needed. | | reimplement if needed. | ||
|- | |- | ||
| 1.1 | | 1.1 | ||
| 1.9¹ | | 1.9¹ | ||
− | | < | + | | <samp>Command.CallCommand(string)</samp> |
− | | use < | + | | use <samp>this.Helper.ConsoleCommands</samp>. |
|- | |- | ||
| 1.1 | | 1.1 | ||
| 1.9¹ | | 1.9¹ | ||
− | | < | + | | <samp>Mod.Entry(ModHelper)</samp> |
− | | change < | + | | change <samp>ModHelper</samp> to <samp>IModHelper</samp>. |
|- | |- | ||
| 1.5 | | 1.5 | ||
| 1.9¹ | | 1.9¹ | ||
− | | < | + | | <samp>Version</samp> class |
− | | use < | + | | use <samp>SemanticVersion</samp>. |
|- | |- | ||
| 1.5 | | 1.5 | ||
| 1.9¹ | | 1.9¹ | ||
− | | < | + | | <samp>Mod.Manifest</samp> |
− | | use < | + | | use <samp>Mod.ModManifest</samp> <small>(changes type from <samp>Manifest</samp> to <samp>IManifest</samp>)</small>. |
|- | |- | ||
| 1.5 | | 1.5 | ||
| 1.9¹ | | 1.9¹ | ||
− | | < | + | | <samp>Constants.Version</samp> |
− | | use < | + | | use <samp>Constants.ApiVersion</samp> <small>(changes type from <samp>Version</samp> to <samp>ISemanticVersion</samp>)</small>. |
|- | |- | ||
| 1.0 | | 1.0 | ||
| 2.0 | | 2.0 | ||
− | | < | + | | <samp>Config</samp> class |
| see [[#Mod configuration|mod configuration]]. | | see [[#Mod configuration|mod configuration]]. | ||
|- | |- | ||
| 1.0 | | 1.0 | ||
| 2.0 | | 2.0 | ||
− | | < | + | | <samp>Mod.BaseConfigPath</samp> |
| see [[#Mod configuration|mod configuration]]. | | see [[#Mod configuration|mod configuration]]. | ||
|- | |- | ||
| 1.0 | | 1.0 | ||
| 2.0 | | 2.0 | ||
− | | < | + | | <samp>Mod.PathOnDisk</samp> |
− | | see [[#Mod configuration|mod configuration]] or use < | + | | see [[#Mod configuration|mod configuration]] or use <samp>this.Helper.DirectoryPath</samp>. |
|- | |- | ||
| 1.0 | | 1.0 | ||
| 2.0 | | 2.0 | ||
− | | < | + | | <samp>Mod.PerSaveConfigFolder</samp> |
| use [[Modding:Modder Guide/APIs/Config|per-save JSON files]] instead. | | use [[Modding:Modder Guide/APIs/Config|per-save JSON files]] instead. | ||
|- | |- | ||
| 1.0 | | 1.0 | ||
| 2.0 | | 2.0 | ||
− | | < | + | | <samp>Mod.PerSaveConfigPath</samp> |
| use [[Modding:Modder Guide/APIs/Config|per-save JSON files]] instead. | | use [[Modding:Modder Guide/APIs/Config|per-save JSON files]] instead. | ||
|- | |- | ||
| 1.0 | | 1.0 | ||
| 2.0 | | 2.0 | ||
− | | < | + | | <samp>Mod.Entry(object[])</samp> |
| see [[#Mod entry method|mod entry method]]. | | see [[#Mod entry method|mod entry method]]. | ||
|- | |- | ||
| 1.1 | | 1.1 | ||
| 2.0 | | 2.0 | ||
− | | < | + | | <samp>Log</samp> class |
− | | use the < | + | | use the <samp>this.Monitor.Log</samp> mod method. |
|- | |- | ||
| 1.6 | | 1.6 | ||
| 2.0 | | 2.0 | ||
− | | < | + | | <samp>PlayerEvents.FarmerChanged</samp> |
| serves no purpose. | | serves no purpose. | ||
|- | |- | ||
| 1.6 | | 1.6 | ||
| 2.0 | | 2.0 | ||
− | | < | + | | <samp>PlayerEvents.LoadedGame</samp> |
− | | use < | + | | use <samp>SaveEvents.AfterLoad</samp>. |
|- | |- | ||
| 1.6 | | 1.6 | ||
| 2.0 | | 2.0 | ||
− | | < | + | | <samp>TimeEvents.OnNewDay</samp> |
− | | unreliable and don't do what you think; use < | + | | unreliable and don't do what you think; use <samp>TimeEvents.AfterDayChanged</samp> or <samp>SaveEvents.BeforeSave</samp> instead. |
|- | |- | ||
| 1.9 | | 1.9 | ||
| 2.0 | | 2.0 | ||
− | | < | + | | <samp>Command</samp> class |
− | | use < | + | | use <samp>this.Helper.ConsoleCommands</samp>. |
|- | |- | ||
| 1.10 | | 1.10 | ||
| 2.0 | | 2.0 | ||
− | | < | + | | <samp>GameEvents.Initialize</samp><br /><samp>GameEvents.LoadContent</samp> |
− | | move any code into your < | + | | move any code into your <samp>Entry</samp> method. |
|- | |- | ||
| 1.13 | | 1.13 | ||
| 2.0 | | 2.0 | ||
− | | < | + | | <samp>GameEvents.GameLoaded</samp> |
− | | move any code into your < | + | | move any code into your <samp>Entry</samp> method. |
|- | |- | ||
| 1.14 | | 1.14 | ||
| 2.0 | | 2.0 | ||
− | | < | + | | <samp>TimeEvents.DayOfMonthChanged</samp><br /><samp>TimeEvents.SeasonOfYearChanged</samp><br /><samp>TimeEvents.YearOfGameChanged</samp> |
− | | unreliable and don't do what you think; use < | + | | unreliable and don't do what you think; use <samp>TimeEvents.AfterDayChanged</samp> or <samp>SaveEvents.BeforeSave</samp> instead. |
|} | |} | ||
Line 169: | Line 168: | ||
Change your mod's entry class from this: | Change your mod's entry class from this: | ||
− | < | + | <syntaxhighlight lang="c#"> |
/// <summary>Initialise the mod.</summary> | /// <summary>Initialise the mod.</summary> | ||
public override void Entry(params object[] objects) | public override void Entry(params object[] objects) | ||
Line 175: | Line 174: | ||
// your code | // your code | ||
} | } | ||
− | </ | + | </syntaxhighlight> |
to this: | to this: | ||
− | < | + | <syntaxhighlight lang="c#"> |
/// <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> | ||
/// <param name="helper">Provides simplified APIs for writing mods.</param> | /// <param name="helper">Provides simplified APIs for writing mods.</param> | ||
Line 186: | Line 185: | ||
// your code | // your code | ||
} | } | ||
− | </ | + | </syntaxhighlight> |
===Mod configuration=== | ===Mod configuration=== | ||
''For the latest documentation, see [[Modding:Modder Guide/APIs/Config]].'' | ''For the latest documentation, see [[Modding:Modder Guide/APIs/Config]].'' | ||
− | If you use < | + | If you use <samp>config.json</samp>, it's much easier in 1.0. |
<ol> | <ol> | ||
− | <li>Find your subclass of < | + | <li>Find your subclass of <samp>StardewModdingAPI.Config</samp>, which probably looks something like this: |
− | < | + | <syntaxhighlight lang="c#"> |
class SampleConfig : StardewModdingAPI.Config | class SampleConfig : StardewModdingAPI.Config | ||
{ | { | ||
Line 209: | Line 208: | ||
} | } | ||
} | } | ||
− | </ | + | </syntaxhighlight></li> |
<li>Edit this class as follows: | <li>Edit this class as follows: | ||
* Move default values into the constructor or property setters. | * Move default values into the constructor or property setters. | ||
− | * Remove < | + | * Remove <samp>StardewModdingAPI.Config</samp>. |
− | * Remove all < | + | * Remove all <samp>override</samp> methods. |
</li> | </li> | ||
<li>Your class should now look something like this: | <li>Your class should now look something like this: | ||
− | < | + | <syntaxhighlight lang="c#"> |
class SampleConfig | class SampleConfig | ||
{ | { | ||
Line 225: | Line 224: | ||
public float ExampleFloat { get; set; } = 0.5; | public float ExampleFloat { get; set; } = 0.5; | ||
} | } | ||
− | </ | + | </syntaxhighlight> |
or like this if you used a constructor: | or like this if you used a constructor: | ||
− | < | + | <syntaxhighlight lang="c#"> |
class SampleConfig | class SampleConfig | ||
{ | { | ||
Line 241: | Line 240: | ||
} | } | ||
} | } | ||
− | </ | + | </syntaxhighlight></li> |
− | <li>In your < | + | <li>In your <samp>Mod</samp> class, change anything that looks like this: |
− | < | + | <syntaxhighlight lang="c#"> |
var config = new SampleConfig().InitializeConfig(this.BaseConfigPath); | var config = new SampleConfig().InitializeConfig(this.BaseConfigPath); | ||
− | </ | + | </syntaxhighlight> |
to this: | to this: | ||
− | < | + | <syntaxhighlight lang="c#"> |
var config = helper.ReadConfig<SampleConfig>(); | var config = helper.ReadConfig<SampleConfig>(); | ||
− | </ | + | </syntaxhighlight></li> |
<li>If you use other methods, here's how to migrate them: | <li>If you use other methods, here's how to migrate them: | ||
Line 262: | Line 261: | ||
! after 1.0 | ! after 1.0 | ||
|- | |- | ||
− | | < | + | | <samp>new SampleConfig().GenerateDefaultConfig()</samp><br /><samp>new SampleConfig().Instance()</samp> |
− | | < | + | | <samp>new SampleConfig()</samp> |
|- | |- | ||
− | | < | + | | <samp>new SampleConfig().InitializeConfig(this.BaseConfigPath)</samp><br /><samp>config.UpdateConfig()</samp><br /><samp>config.LoadConfig(this.BaseConfigPath)</samp><br /><samp>config.ReloadConfig()</samp> |
− | | < | + | | <samp>helper.ReadConfig<SampleConfig>()</samp> |
|- | |- | ||
− | | < | + | | <samp>config.WriteConfig()</samp> |
− | | < | + | | <samp>helper.WriteConfig(config)</samp> |
|} | |} | ||
</li> | </li> |
Latest revision as of 18:48, 4 November 2021
This page is for mod authors. Players: see Modding:Mod compatibility instead.
This page explains how to update your SMAPI mod code for compatibility with SMAPI 1.9 (released alongside Stardew Valley 1.2 in April 2017) and 2.0 (released in October 2017).
Overview
What's changing and how much does it impact mods?
The last major breaking change was in SMAPI 0.40 (April 2016). Since then 23 SMAPI releases were published with almost full backwards compatibility. SMAPI has matured significantly since version 0.40, and its APIs have converged towards better consistency. Older APIs have been deprecated with full support, but this introduces significant maintenance overhead. A few rarely-used APIs were dropped in SMAPI 1.9 (when Stardew Valley 1.2 broke many mods), and SMAPI 2.0 is the release which finally drops support for these old APIs.
Although this is a major change, significant effort was undertaken to minimise the impact on mods: (a) the APIs were supported for a long time with increasingly prominent warnings in the SMAPI console about their deprecation and removal; (b) dozens of pull requests were submitted to update affected mods; (c) unofficial updates were created for mods which haven't updated officially yet; and (d) the changes were actively communicated and documented to modders. This means that SMAPI 2.0 has a minimal impact on mod compatibility (see chart on the right).
How to update your mod
You don't need to comb through your code manually. SMAPI can tell you if you're using a deprecated interface:
- Use the latest SMAPI for developers download. This will show deprecation messages in the console:
- When you look at the code, you'll see a deprecation warning with a hint of how to fix it:
- Optionally, you can refer to the following sections on how to replace specific interfaces.
Major changes
Removed APIs
The following APIs were removed in SMAPI 1.9 and 2.0.
deprecated | removed | old APIs | replacement |
---|---|---|---|
0.39.3 | 1.9¹ | SObject class | reimplement if needed. |
0.39.3 | 1.9¹ | Extensions.ToSingular(…) | use string.Join. |
1.0 | 1.9¹ | Authour in manifest.json | use Author. |
1.0 | 1.9¹ | Extensions class | reimplement if needed, or use an extensions library. |
1.0 | 1.9¹ | LogWriter class | use this.Monitor.Log. |
1.0 | 1.9¹ | SPlayer class | use Game1.player. |
1.0 experimental API |
1.9¹ | IConfigFile and ConfigFile | reimplement if needed. |
1.1 | 1.9¹ | Command.CallCommand(string) | use this.Helper.ConsoleCommands. |
1.1 | 1.9¹ | Mod.Entry(ModHelper) | change ModHelper to IModHelper. |
1.5 | 1.9¹ | Version class | use SemanticVersion. |
1.5 | 1.9¹ | Mod.Manifest | use Mod.ModManifest (changes type from Manifest to IManifest). |
1.5 | 1.9¹ | Constants.Version | use Constants.ApiVersion (changes type from Version to ISemanticVersion). |
1.0 | 2.0 | Config class | see mod configuration. |
1.0 | 2.0 | Mod.BaseConfigPath | see mod configuration. |
1.0 | 2.0 | Mod.PathOnDisk | see mod configuration or use this.Helper.DirectoryPath. |
1.0 | 2.0 | Mod.PerSaveConfigFolder | use per-save JSON files instead. |
1.0 | 2.0 | Mod.PerSaveConfigPath | use per-save JSON files instead. |
1.0 | 2.0 | Mod.Entry(object[]) | see mod entry method. |
1.1 | 2.0 | Log class | use the this.Monitor.Log mod method. |
1.6 | 2.0 | PlayerEvents.FarmerChanged | serves no purpose. |
1.6 | 2.0 | PlayerEvents.LoadedGame | use SaveEvents.AfterLoad. |
1.6 | 2.0 | TimeEvents.OnNewDay | unreliable and don't do what you think; use TimeEvents.AfterDayChanged or SaveEvents.BeforeSave instead. |
1.9 | 2.0 | Command class | use this.Helper.ConsoleCommands. |
1.10 | 2.0 | GameEvents.Initialize GameEvents.LoadContent |
move any code into your Entry method. |
1.13 | 2.0 | GameEvents.GameLoaded | move any code into your Entry method. |
1.14 | 2.0 | TimeEvents.DayOfMonthChanged TimeEvents.SeasonOfYearChanged TimeEvents.YearOfGameChanged |
unreliable and don't do what you think; use TimeEvents.AfterDayChanged or SaveEvents.BeforeSave instead. |
¹ Stardew Valley 1.2 broke many existing mods, so SMAPI 1.9 used the opportunity to remove the most rarely-used deprecated APIs.
Mod entry method
For the latest documentation, see Modding:Modder Guide/Get Started.
Change your mod's entry class from this:
/// <summary>Initialise the mod.</summary>
public override void Entry(params object[] objects)
{
// your code
}
to this:
/// <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)
{
// your code
}
Mod configuration
For the latest documentation, see Modding:Modder Guide/APIs/Config.
If you use config.json, it's much easier in 1.0.
- Find your subclass of StardewModdingAPI.Config, which probably looks something like this:
class SampleConfig : StardewModdingAPI.Config { public bool ExampleBoolean { get; set; } public float ExampleFloat { get; set; } public override T GenerateDefaultConfig<T>() { this.ExampleBoolean = true; this.ExampleFloat = 0.5; return this as T; } }
- Edit this class as follows:
- Move default values into the constructor or property setters.
- Remove StardewModdingAPI.Config.
- Remove all override methods.
- Your class should now look something like this:
class SampleConfig { public bool ExampleBoolean { get; set; } = true; public float ExampleFloat { get; set; } = 0.5; }
or like this if you used a constructor:
class SampleConfig { public bool ExampleBoolean { get; set; } public float ExampleFloat { get; set; } public SampleConfig() { this.ExampleBoolean = true; this.ExampleFloat = 0.5; } }
- In your Mod class, change anything that looks like this:
var config = new SampleConfig().InitializeConfig(this.BaseConfigPath);
to this:
var config = helper.ReadConfig<SampleConfig>();
- If you use other methods, here's how to migrate them:
before 1.0 after 1.0 new SampleConfig().GenerateDefaultConfig()
new SampleConfig().Instance()new SampleConfig() new SampleConfig().InitializeConfig(this.BaseConfigPath)
config.UpdateConfig()
config.LoadConfig(this.BaseConfigPath)
config.ReloadConfig()helper.ReadConfig<SampleConfig>() config.WriteConfig() helper.WriteConfig(config)
For more information, see Modding:Modder Guide/APIs/Config.