Modding:Mod compatibility

From Stardew Valley Wiki
Revision as of 02:49, 26 August 2018 by Pathoschild (talk | contribs) (header for 1.3.28, take two)
Jump to navigation Jump to search

Modding:Player Guide/header

This page is for Stardew Valley 1.3.28 stable. If you opted in to the beta channel, see compatibility for Stardew Valley 1.3.29 beta instead.
SMAPI mod compatibility, July 2017 to present. This spans Stardew Valley 1.2 in July 2017 (just before the chart starts), and 1.3 in April 2018 (the big dropoff).

Sometimes a mod will stop working due to a major game update; SMAPI automatically disables incompatible mods. This page lists known SMAPI mods and their compatibility with the latest versions, and explains how to fix broken mods if possible.

For players

What to do

  1. For each mod you have installed, follow the instructions in the list below. If it's not listed, try updating to its latest version.
  2. If a mod is still failing, post a message in the coordination thread (with your SMAPI log attached) and we'll help.

SMAPI mods

  • Players: Here's a list of mods tested with SMAPI 2.6+ and Stardew Valley 1.3+. Content packs aren't listed unless incompatible. It's updated periodically for new mod releases.
  • Modders: feel free to update this list! (See instructions.)

SMAPI mods (obsolete)

These mods are either obsolete, or have been abandoned by their authors and probably won't be updated unofficially. These will likely never be updated again.

XNB mods

See Modding:Using XNB mods.

For mod developers

Updating a mod

See migration guides. You can...

Creating an unofficial update

To avoid conflicting with official updates, here's the recommended way to create an unofficial update. This assumes you're creating a basic update (not a continuation or reinvention), and the code is on GitHub (adjust the steps accordingly if it's elsewhere).

  1. Fork the code.
  2. Make your changes to that fork (see #updating a mod).
  3. Increase the version in manifest.json by 0.0.1 and add -unofficial.1-yourName.
    For example, if the current version is 1.0.0 and your name is SampleUser, change it to 1.0.1-unofficial.1-sampleUser. If you need to release a new unofficial update, just increment unofficial.1 to unofficial.2, etc. This ensures that official versions supersede unofficial ones (e.g. for update checks), and other users can release newer unofficial updates if needed.
  4. Push your changes to GitHub.
  5. Post a release package to the coordination thread with a link to your fork on GitHub.
    (If the mod uses the NuGet build package, there should be a release package named <mod name> <version>.zip in your bin folder.)
  6. Submit a pull request to the original author (if applicable).

Overall compatibility

 
 73% are compatible or have a working alternative.
 
 14% have an update coming soon.
 
 13% are broken and not open-source.¹

¹ Many of these broke due to a Stardew Valley update. Some may be updated by their authors later.

Footnotes

  1. ↑ 1.0 1.1 This only shows whether a mod is compatible; it may have bugs unrelated to SMAPI compatibility.
  2. ↑ 2.00 2.01 2.02 2.03 2.04 2.05 2.06 2.07 2.08 2.09 2.10 2.11 2.12 2.13 2.14 2.15 2.16 2.17 2.18 2.19 2.20 2.21 2.22 2.23 2.24 2.25 2.26 2.27 2.28 2.29 If a mod says "use optional download", its main version isn't compatible but there's an official optional update. If the mod is on Nexus, click "Files" on the mod page and check for a newer version (often under 'optional files').

Modding:Player Guide/footer

Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Mod_compatibility&oldid=74245"