Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(Updating status of my mods.)
(→‎SMAPI mods: clean up Android warnings (remove non-compatibility bugs, remove outdated note about TMX void bug, avoid commas which cause issues since field is comma-delimited))
Line 5,468: Line 5,468:
 
   |unofficial version = 3.1.1-unofficial.10-NateMcCloud
 
   |unofficial version = 3.1.1-unofficial.10-NateMcCloud
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-36#post-3355149
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-36#post-3355149
−
  |warnings = On Android, menu displays with visual glitches; also use Android close gesture to leave mod.
 
 
   |pull request      = https://github.com/jdusbabek/stardewvalley/pull/12
 
   |pull request      = https://github.com/jdusbabek/stardewvalley/pull/12
 +
 +
  |warnings = Works on Android with caveats (menu displays with visual glitches; use close gesture to leave mod).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,288: Line 6,289:
 
   |nexus id = 2545
 
   |nexus id = 2545
 
   |github  = SoapStuff/Remote-Fridge-Storage
 
   |github  = SoapStuff/Remote-Fridge-Storage
−
   |warnings = On Android, broken; loads but does not work, flipped-image resource is not in assets.
+
   |warnings = Broken on Android (loads but does not work).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,460: Line 6,461:
 
   |nexus id = 444
 
   |nexus id = 444
 
   |github  = janavarro95/Stardew_Valley_Mods
 
   |github  = janavarro95/Stardew_Valley_Mods
−
   |warnings = On Android, use the built-in autosave instead.
+
   |warnings = Broken on Android (use the built-in autosave instead).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,751: Line 6,752:
 
   |nexus id = 5299
 
   |nexus id = 5299
 
   |github  =
 
   |github  =
−
  |warnings = On Android, menu displays with visual glitches and touch areas don't align with shops.
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 7,731: Line 7,731:
 
   |moddrop id = 771913
 
   |moddrop id = 771913
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
−
  |warnings = On Android, some maps and custom spouse rooms may load as a black void (fixed in an upcoming SMAPI update).
 
 
}}
 
}}
 
{{/entry
 
{{/entry

Revision as of 20:58, 14 September 2020

Modding:Player Guide/header

SMAPI mod compatibility, July 2017 to present. See notable events which affect this chart.

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.



Players: see mods.smapi.io for a more user-friendly view of this page.



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

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.

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.

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 official 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).

Footnotes

  1. ↑ 1.0 1.1 1.2 This only shows whether a mod is compatible; it may have bugs unrelated to SMAPI compatibility.
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Mod_compatibility&oldid=103277"