translators
8,404
edits
Changes
Modding:Migrate to Stardew Valley 1.5.5 (view source)
Revision as of 03:40, 12 August 2021
, 03:40, 12 August 2021→For SMAPI mods: split compatibility branch into its own section, expand
==For SMAPI mods==
==For SMAPI mods==
===Stardew Valley compatibility branch===
Stardew Valley 1.5.5 is available in two branches on each OS (with identical content for players): the ''main branch'' which is installed by default, and an optional ''compatibility branch'' for [https://www.stardewvalley.net/compatibility older systems]. These have identical content for players, but use different technologies:
{| class="wikitable"
|-
! branch
! OS
! game framework
! runtime
|- style="color: #090;"
|rowspan="2"| main
| Linux/macOS
| MonoGame 3.8
| 64-bit .NET 5
|- style="color: #090;"
| Windows
| MonoGame 3.8
| 64-bit .NET 5
|- style="color: #900;"
|rowspan="2"| compatibility
| Linux/macOS
| MonoGame 3.5.1
| 64-bit Mono 4.5
|- style="color: #900;"
| Windows
| XNA Framework 4.0
| 32-bit .NET Framework 4.5
|}
Unfortunately '''SMAPI only supports the main branch of the game.''' There are formidable difficulties across all mods in supporting all three variations, the [https://store.steampowered.com/hwsurvey Steam hardware stats] show that ≈99.69% of players have 64-bit, and 32-bit imposes significant restrictions on what mods can do.
===64-bit MonoGame and .NET 5===
===64-bit MonoGame and .NET 5===
Stardew Valley 1.5.5 is available in two branches (with identical content for players): the '''main branch''' uses 64-bit MonoGame + .NET 5 across all platforms; and the '''compatibility branch''' uses 32-bit XNA Framework + .NET Framework 4.5 on Windows, and 64-bit MonoGame + Mono 4.5 on Linux/macOS. The compatibility branch is only meant to support players with old systems (i.e. 32-bit Windows or macOS 10.12 "Sierra" or earlier), and the vast majority of players will be using the default main branch.
Stardew Valley 1.5.5 migrates to 64-bit MonoGame and .NET 5 on all platforms. SMAPI rewrites mods so they should mostly still work, but posting an update for every C# mod is strongly recommended to avoid edge cases.
To update your C# mod code:
To update your C# mod code: