Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: correct info (Deluxe Auto-Grabber, Deluxe Grabber Redux, Last Day to Plant, Player Co-ordinate HUD, Year-Round Crops), add source links (Last Day to Plant, Quality Smash), remove non-SMAPI mod (Advanced Special Attacks))
Line 183: Line 183:
 
   |nexus id = 435
 
   |nexus id = 435
 
   |github  = janavarro95/Stardew_Valley_Mods
 
   |github  = janavarro95/Stardew_Valley_Mods
}}
 
{{#invoke:SMAPI compatibility|entry
 
  |name    = Advanced Special Attack
 
  |author  = aedenthorn
 
  |id      = aedenthorn.AdvancedSpecialAttack
 
  |nexus id = 7903
 
  |github  = aedenthorn/StardewValleyMods
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 359: Line 352:
 
   |broke in          = Stardew Valley 1.5
 
   |broke in          = Stardew Valley 1.5
 
   |unofficial version = 3.2.0-beta.1.7
 
   |unofficial version = 3.2.0-beta.1.7
   |unofficial url    = http://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/post-30983
+
   |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/post-30983
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 1,511: Line 1,504:
 
   |id      = theLion.AwesomeTools
 
   |id      = theLion.AwesomeTools
 
   |nexus id = 7965
 
   |nexus id = 7965
   |github  =
+
   |github  =  
 +
  |source  = https://gitlab.com/theLion/smapi-mods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 2,720: Line 2,714:
 
   |github  = stokastic/CoopGrabber
 
   |github  = stokastic/CoopGrabber
  
   |broke in           = Stardew Valley 1.3.29
+
   |broke in = Stardew Valley 1.3.29
   |summary           = use {{nexus mod|7920|Deluxe Grabber Redux}} instead or [https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/page-23#post-23408 unofficial version].
+
  |status  = workaround
 +
   |summary = use [[#Deluxe Grabber Redux|Deluxe Grabber Redux]] or [https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/page-23#post-23408 unofficial version] instead.
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 2,728: Line 2,723:
 
   |id      = ferdaber.DeluxeGrabberRedux
 
   |id      = ferdaber.DeluxeGrabberRedux
 
   |nexus id = 7920
 
   |nexus id = 7920
   |github  = ferdaber/sdv-mods/tree/master/DeluxeGrabberRedux
+
   |github  = ferdaber/sdv-mods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 3,101: Line 3,096:
 
   |moddrop id = 661356
 
   |moddrop id = 661356
 
   |github  = Mizzion/MyStardewMods
 
   |github  = Mizzion/MyStardewMods
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 4,951: Line 4,945:
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
   |name    = Last Day To Plant
+
   |name    = Last Day to Plant
 
   |author  = dmcrider57
 
   |author  = dmcrider57
   |id      = dmcrider57.LastDayToPlant
+
   |id      = com.dayloncrider.stardewvalley.lastdaytoplant
 
   |nexus id = 7917
 
   |nexus id = 7917
   |github  =
+
   |github  = dmcrider/LastDayToPlant
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 6,661: Line 6,655:
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
   |name    = Player Co-ordinate HUD
+
   |name    = Player Co-ordinate HUD, Player Position HUD and Logger
 
   |author  = DecidedlyHuman
 
   |author  = DecidedlyHuman
   |id      = DecidedlyHuman.PlayerCoordinate
+
   |id      = DecidedlyHuman.PlayerCoordinates
 
   |nexus id = 7969
 
   |nexus id = 7969
 
   |github  = DecidedlyHuman/DecidedlyHumanMods
 
   |github  = DecidedlyHuman/DecidedlyHumanMods
Line 7,060: Line 7,054:
 
   |id      = barfytheclown.QualitySmash
 
   |id      = barfytheclown.QualitySmash
 
   |nexus id = 7907
 
   |nexus id = 7907
   |github  =
+
   |github  = jn84/QualitySmash
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 7,995: Line 7,989:
 
   |name    = Shroom Spotter Redux
 
   |name    = Shroom Spotter Redux
 
   |author  = Strobe and TehPers
 
   |author  = Strobe and TehPers
   |id      = TehPers.ShroomSpotter
+
   |id      = ShroomSpotter
 
   |nexus id = 7934
 
   |nexus id = 7934
 
   |github  =  
 
   |github  =  
Line 9,932: Line 9,926:
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
   |name    = YearRoundCrops
+
   |name    = Year-Round Crops
 
   |author  = vincebel
 
   |author  = vincebel
 
   |id      = vincebel.YearRoundCrops
 
   |id      = vincebel.YearRoundCrops

Revision as of 05:22, 5 March 2021

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 smapi.io/mods 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).