Stardew Valley Wiki

Modding:Mod compatibility

← Modding:Index
Player's guide to using mods SMAPI mascot.png
SMAPI mod compatibility, July 2017 to June 2024. See notable events which affect this chart.
  broken (proprietary)
  broken (open-source)
  compatible

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.

Instructions

For players

See smapi.io/mods for a more user-friendly view of this page.

To update your mods:

  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.

For mod authors

Feel free to update the lists below! See instructions for editing the template.

Notes for the mod status:

  • Only mark a mod abandoned or obsolete if (a) the mod author has explicitly abandoned the mod, or (b) they've hidden or deleted the mod page, or (c) it's been superseded by an equivalent game feature. A mod is not considered abandoned just because it hasn't been updated for a while.
  • Only mark a mod broken if it's incompatible. This isn't the place to track general mod bugs, unless they impact compatibility. In rare cases where a non-compatibility bug is severe enough to note here (e.g. game crashes on some platforms), you can use the warnings field.

Compatibility list

C# mods

This includes every known C# SMAPI mod. It's updated for new/updated mods on CurseForge/ModDrop/Nexus periodically with the help of semi-automated scripts, but feel free to make corrections as needed!

Content packs

This list shows broken content packs for SMAPI mods like Content Patcher. Only incompatible content packs are listed; working content packs are not listed (even if they have non-compatibility bugs). For legacy XNB mods, see #XNB mods.

XNB mods

See Modding:Using XNB mods.

Mod data overrides

This section overrides the data specified in mods' manifest.json files or mod pages for SMAPI's update checks. This is a specialized section; in most cases it's better to correct the mod instead. See the format description when editing this section.

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. Change the version in manifest.json to the official version number plus 0.0.1, with -unofficial.1-yourName at the end.
    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).
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Mod_compatibility&oldid=171899"