Modding:Migrate to SMAPI 3.0

←Index

This is an internal draft page. SMAPI 3.0 is not ready and modders don't need to do anything yet.

This page is for modders. Players: see Modding:SMAPI compatibility instead.

This page explains how to update your mod code for compatibility with SMAPI 3.0 (release TBD).

Overview

What's changing?

SMAPI compatibility over time. The SMAPI 2.0 release in October 2017 appears as a small bump. The Stardew Valley 1.3 release in May 2018 appears as a sudden cliff.

Events are arguably the most important and most visible part of SMAPI, but they've stayed essentially unchanged since SMAPI 0.40. New events have been added organically since then, but the event system has always been separate from the rest of SMAPI — they're inconsistent, have some weird behaviours (like MenuEvents.MenuChanged not being raised when a menu is closed), aren't available through the same helper as every other API, and there are some glaring omissions in the available events.

SMAPI 3.0 is the release that fixes all that. This release...

• Completely rewrites the event engine to make events more efficient and enable events that weren't possible before.
• Makes events much more consistent: they're now fully compliant with the .NET design guidelines, have predictable and descriptive names, have consistent event handler signatures, and have clear documentation.
• All events are now accessible through helper.Events, so they're discoverable like any other SMAPI API.
• Weird behaviours and overlapping events have been eliminated.
• Many new events have been added.
• Every event now has relevant event arguments.

Is this the modapocalypse?

Nope. Although this is a major change, significant effort will be undertaken to minimise the impact:

• the old events will be supported for a long time with increasingly prominent warnings in the SMAPI console about their deprecation and removal;
• pull requests will be submitted to update affected open-source mods;
• unofficial updates will be created for mods which haven't updated officially by the time SMAPI 3.0 is released;
• the changes will be actively communicated and documented to modders.

In addition, the current target is at least 95% compatibility for open-source mods before SMAPI 3.0 is released. All of this means that the 3.0 release should have minimal impact on mod compatibility, despite the scope of the changes.

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:

1. Use the latest SMAPI for developers download. This will show deprecation messages in the console:
   
2. When you look at the code, you'll see a deprecation warning with a hint of how to fix it:
   
3. You can refer to the following sections on how to replace specific interfaces.

Major changes

Removed APIs

The following APIs were removed in SMAPI 3.0.

TODO

Event changes

The former events will be removed in SMAPI 3.0. Here's how to convert them to the new events under this.Helper.Events. This list does not cover new events in 3.0.

old event	new equivalent	conversion notes
ContentEvents.AfterLocaleChanged	TODO
ControlEvents.ControllerButtonPressed	TODO
ControlEvents.ControllerButtonReleased	TODO
ControlEvents.ControllerTriggerPressed	TODO
ControlEvents.ControllerTriggerReleased	TODO
ControlEvents.KeyboardChanged	TODO
ControlEvents.KeyPressed	TODO
ControlEvents.KeyReleased	TODO
ControlEvents.MouseChanged	TODO
GameEvents.EighthUpdateTick	TODO
GameEvents.FirstUpdateTick	TODO
GameEvents.FourthUpdateTick	TODO
GameEvents.HalfSecondTick	TODO
GameEvents.OneSecondTick	TODO
GameEvents.QuarterSecondTick	TODO
GameEvents.SecondUpdateTick	TODO
GameEvents.UpdateTick	TODO
GraphicsEvents.OnPostRenderEvent	TODO
GraphicsEvents.OnPostRenderGuiEvent	TODO
GraphicsEvents.OnPostRenderHudEvent	TODO
GraphicsEvents.OnPreRenderEvent	TODO
GraphicsEvents.OnPreRenderGuiEvent	TODO
GraphicsEvents.OnPreRenderHudEvent	TODO
GraphicsEvents.Resize	TODO
InputEvents.ButtonPressed	TODO
InputEvents.ButtonReleased	TODO
LocationEvents.BuildingsChanged	World.BuildingListChanged	Equivalent.
LocationEvents.LocationsChanged	World.LocationListChanged	Equivalent.
LocationEvents.ObjectsChanged	World.ObjectListChanged	Equivalent.
MenuEvents.MenuChanged	TODO
MenuEvents.MenuClosed	TODO
MineEvents.MineLevelChanged	TODO
MultiplayerEvents.AfterMainBroadcast	TODO
MultiplayerEvents.AfterMainSync	TODO
MultiplayerEvents.BeforeMainBroadcast	TODO
MultiplayerEvents.BeforeMainSync	TODO
PlayerEvents.InventoryChanged	TODO
PlayerEvents.LeveledUp	TODO
PlayerEvents.Warped	TODO
SaveEvents.AfterCreate	TODO
SaveEvents.AfterLoad	TODO
SaveEvents.AfterReturnToTitle	TODO
SaveEvents.AfterSave	TODO
SaveEvents.BeforeCreate	TODO
SaveEvents.BeforeSave	TODO
SpecialisedEvents.UnvalidatedUpdateTick	TODO
TimeEvents.AfterDayStarted	TODO
TimeEvents.TimeOfDayChanged	TODO