Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods (obsolete): standardise summaries and statuses)
Line 4,651: Line 4,651:
 
   |github  = CJBok/SDV-Mods
 
   |github  = CJBok/SDV-Mods
 
   |broke in = Stardew Valley 1.2
 
   |broke in = Stardew Valley 1.2
−
   |status  = workaround
+
   |status  = abandoned
−
   |summary  = no longer maintained; use [[#Automate|Automate]] instead.
+
   |summary  = remove this mod (no longer maintained; use [[#Automate|Automate]] instead).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,661: Line 4,661:
 
   |github  = spacechase0/Cobalt
 
   |github  = spacechase0/Cobalt
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
−
   |summary  = no longer maintained; use [[#Prismatic Tools|Prismatic Tools]] instead.
+
  |status  = abandoned
 +
   |summary  = remove this mod (no longer maintained; use [[#Prismatic Tools|Prismatic Tools]] instead).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,699: Line 4,700:
 
   |github  = spacechase0/CustomCrops
 
   |github  = spacechase0/CustomCrops
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
−
   |summary  = no longer maintained; use [[#Json Assets|Json Assets]] instead.
+
  |status  = abandoned
 +
   |summary  = remove this mod (no longer maintained; use [[#Json Assets|Json Assets]] instead).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,708: Line 4,710:
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
−
   |status  = workaround
+
   |status  = abandoned
−
   |summary  = use [[#PyTK|PyTK]] instead.
+
   |summary  = remove this mod (no longer maintained; use [[#PyTK|PyTK]] instead).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,719: Line 4,721:
 
   |github  = spacechase0/CustomFarmTypes
 
   |github  = spacechase0/CustomFarmTypes
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
−
   |summary  = no longer maintained; use [[#MTN|MTN]] instead.
+
  |status  = abandoned
 +
   |summary  = remove this mod (no longer maintained; use [[#MTN|MTN]] instead).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,728: Line 4,731:
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
−
   |status  = workaround
+
   |status  = abandoned
−
   |summary  = use [[#PyTK|PyTK]] instead.
+
   |summary  = remove this mod (no longer maintained; use [[#PyTK|PyTK]] instead).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,738: Line 4,741:
 
   |github  =  
 
   |github  =  
 
   |broke in = Stardew Valley 1.2
 
   |broke in = Stardew Valley 1.2
−
   |status  = workaround
+
   |status  = abandoned
−
   |summary  = use [[#Fast Animations|Fast Animations]] instead.
+
   |summary  = remove this mod (no longer maintained; use [[#Fast Animations|Fast Animations]] instead).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,828: Line 4,831:
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
−
   |status  = workaround
+
   |status  = abandoned
−
   |summary  = use [[#TMX Loader|TMX Loader]] instead.
+
   |summary  = remove this mod (no longer maintained; use [[#TMX Loader|TMX Loader]] instead).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,875: Line 4,878:
 
   |github  = spacechase0/ShipAnywhere
 
   |github  = spacechase0/ShipAnywhere
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
−
   |summary  = no longer maintained; use [[#Chests Anywhere|Chests Anywhere]] instead.
+
  |status  = abandoned
 +
   |summary  = remove this mod (no longer maintained; use [[#Chests Anywhere|Chests Anywhere]] instead).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,883: Line 4,887:
 
   |nexus id = 175
 
   |nexus id = 175
 
   |github  = cantorsdust/StardewMods
 
   |github  = cantorsdust/StardewMods
−
   |status  = workaround
+
   |status  = abandoned
−
   |summary  = use [[#Skull Cavern Elevator|Skull Cavern Elevator]] instead.
+
   |summary  = remove this mod (no longer maintained; use [[#Skull Cavern Elevator|Skull Cavern Elevator]] instead).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,893: Line 4,897:
 
   |github  = JohnsonNicholas/SDVMods
 
   |github  = JohnsonNicholas/SDVMods
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
−
   |status  = workaround
+
   |status  = abandoned
−
   |summary  = use [[#Lunar Disturbances|Lunar Disturbances]] instead.
+
   |summary  = remove this mod (no longer maintained; use [[#Lunar Disturbances|Lunar Disturbances]] instead).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,913: Line 4,917:
 
   |github  =  
 
   |github  =  
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
−
   |status  = workaround
+
   |status  = abandoned
−
   |summary  = use [[#Activate Sprinklers|Activate Sprinklers]] instead.
+
   |summary  = remove this mod (no longer maintained; use [[#Activate Sprinklers|Activate Sprinklers]] instead).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,940: Line 4,944:
 
   |github  = pathoschild/StardewMods
 
   |github  = pathoschild/StardewMods
 
   |broke in = Stardew Valley 1.3.20
 
   |broke in = Stardew Valley 1.3.20
−
   |status  = workaround
+
   |status  = abandoned
−
   |summary  = use [[#Night Owl|Night Owl]] instead.
+
   |summary  = remove this mod (no longer maintained; use [[#Night Owl|Night Owl]] instead).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,950: Line 4,954:
 
   |github  =  
 
   |github  =  
 
   |status  = abandoned
 
   |status  = abandoned
−
  |summary  =
 
 
   |broke in = Stardew Valley 1.1
 
   |broke in = Stardew Valley 1.1
 
}}
 
}}

Revision as of 05:25, 20 November 2018

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.

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.

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

 
 55% are compatible or have a working alternative.
 
 26% have an update coming soon.
 
 19% 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 2.30 2.31 2.32 2.33 2.34 2.35 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').
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Mod_compatibility&oldid=78247"