Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
m (Updated Pelican Fiber unofficial version)
(→‎SMAPI mods: various corrections and updates; remove Eight Corners (not a SMAPI mod))
Line 217: Line 217:
 
   |github  = funny-snek/Always-On-Server-for-Multiplayer
 
   |github  = funny-snek/Always-On-Server-for-Multiplayer
  
−
   |broke in   = Stardew Valley 1.4
+
   |broke in           = Stardew Valley 1.4
 
   |unofficial version = 1.20.2-unofficial.1-slamerz
 
   |unofficial version = 1.20.2-unofficial.1-slamerz
−
   |unofficial url    = https://community.playstarbound.com/attachments/always-on-server-1-20-2-unofficial-1-slamerz-zip.216461/
+
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-20#post-3353880
 
   |links              = https://github.com/funny-snek/Always-On-Server-for-Multiplayer/pull/5
 
   |links              = https://github.com/funny-snek/Always-On-Server-for-Multiplayer/pull/5
 
   |link labels        = PR
 
   |link labels        = PR
Line 309: Line 309:
 
   |chucklefish id = 5658
 
   |chucklefish id = 5658
 
   |moddrop id = 568430
 
   |moddrop id = 568430
−
  |url      = https://spacechase0.com/mods/stardew-valley/another-hunger-mod/
 
 
   |github  = spacechase0/AnotherHungerMod
 
   |github  = spacechase0/AnotherHungerMod
 +
 +
  |summary  = get [https://spacechase0.com/mods/stardew-valley/another-hunger-mod/ latest version from author's website].
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 319: Line 320:
 
   |github  = funny-snek/anticheat-and-servercode
 
   |github  = funny-snek/anticheat-and-servercode
 
}}
 
}}
−
{{/entry  
+
{{/entry
 
   |name    = Anything Ponds
 
   |name    = Anything Ponds
 
   |author  = MouseyPounds
 
   |author  = MouseyPounds
Line 541: Line 542:
 
   |github  = danvolchek/StardewMods
 
   |github  = danvolchek/StardewMods
  
−
   |broke in = Stardew Valley 1.4
+
   |broke in           = Stardew Valley 1.4
 
   |unofficial version = 1.3.0-unofficial.1-slamerz
 
   |unofficial version = 1.3.0-unofficial.1-slamerz
−
   |unofficial url    = https://community.playstarbound.com/attachments/autostacker-1-3-0-unofficial-1-slamerz-zip.216518/
+
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-25#post-3354209
 
   |links              = https://github.com/danvolchek/StardewMods/pull/14
 
   |links              = https://github.com/danvolchek/StardewMods/pull/14
 
   |link labels        = PR
 
   |link labels        = PR
Line 660: Line 661:
 
   |nexus id = 3605
 
   |nexus id = 3605
 
   |github  = EpicBellyFlop45/StardewMods
 
   |github  = EpicBellyFlop45/StardewMods
−
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 713: Line 713:
 
   |github  = danvolchek/StardewMods
 
   |github  = danvolchek/StardewMods
  
−
   |broke in = Stardew Valley 1.4
+
   |broke in           = Stardew Valley 1.4
 
   |unofficial version = 1.0.1-unofficial.1-slamerz
 
   |unofficial version = 1.0.1-unofficial.1-slamerz
−
   |unofficial url    = https://community.playstarbound.com/attachments/betterdoors-1-0-1-unofficial-1-slamerz-zip.216519/
+
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-25#post-3354209
 
   |links              = https://github.com/danvolchek/StardewMods/pull/13
 
   |links              = https://github.com/danvolchek/StardewMods/pull/13
 
   |link labels        = PR
 
   |link labels        = PR
Line 735: Line 735:
 
   |id      = AairTheGreat.BetterGarbageCans
 
   |id      = AairTheGreat.BetterGarbageCans
 
   |nexus id = 4171
 
   |nexus id = 4171
−
   |github  = AairTheGreat/StardewValleyMods
+
   |github  = AairTheGreat/StardewValleyMods
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,212: Line 1,212:
 
   |github  = danvolchek/StardewMods
 
   |github  = danvolchek/StardewMods
  
−
   |broke in = Stardew Valley 1.4
+
   |broke in           = Stardew Valley 1.4
 
   |unofficial version = 1.13.0-unofficial.1-slamerz
 
   |unofficial version = 1.13.0-unofficial.1-slamerz
−
   |unofficial url    = https://community.playstarbound.com/attachments/chatcommands-1-13-0-unofficial-1-slamerz-zip.216520/
+
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-25#post-3354209
 
   |links              = https://github.com/danvolchek/StardewMods/pull/12
 
   |links              = https://github.com/danvolchek/StardewMods/pull/12
 
   |link labels        = PR
 
   |link labels        = PR
Line 1,237: Line 1,237:
 
   |nexus id = 3976
 
   |nexus id = 3976
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
−
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,245: Line 1,244:
 
   |nexus id = 4180
 
   |nexus id = 4180
 
   |github  = berkayylmao/ChestEx
 
   |github  = berkayylmao/ChestEx
−
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,583: Line 1,581:
 
   |chucklefish id = 4054
 
   |chucklefish id = 4054
 
   |moddrop id = 127277
 
   |moddrop id = 127277
−
  |url      = https://spacechase0.com/mods/stardew-valley/cooking-skill/
 
 
   |github  = spacechase0/CookingSkill
 
   |github  = spacechase0/CookingSkill
 +
 +
  |summary  = get [https://spacechase0.com/mods/stardew-valley/cooking-skill/ latest version from author's website].
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,719: Line 1,718:
 
   |github  = spacechase0/CustomCritters
 
   |github  = spacechase0/CustomCritters
  
−
   |broke in = Stardew Valley 1.4.0.1
+
   |broke in           = Stardew Valley 1.4.0.1
 
   |unofficial version = 1.2.7-unofficial.1-slamerz
 
   |unofficial version = 1.2.7-unofficial.1-slamerz
−
   |unofficial url    = https://community.playstarbound.com/attachments/customcritters-1-2-7-unofficial-1-slamerz-zip.216552/
+
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-27#post-3354372
 
   |links              = https://github.com/spacechase0/CustomCritters/pull/8
 
   |links              = https://github.com/spacechase0/CustomCritters/pull/8
 
   |link labels        = PR
 
   |link labels        = PR
  
−
   |map remote versions = 1.2.7-unofficial.1-slamerz → 1.2.8-unofficial.1-slamerz
+
   |map remote versions = 1.2.7-unofficial.1-slamerz → 1.2.8-unofficial.1-slamerz<!--needed due to the official version being later but broken, and not in the repo-->
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,743: Line 1,742:
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
  
−
   |broke in = Stardew Valley 1.4.2
+
   |broke in           = Stardew Valley 1.4.2
−
   |dev note = updated due to conflicts with Json Assets
+
   |dev note           = updated due to conflicts with Json Assets
 
   |unofficial version = 2.12.9-unofficial.1-minervamaga
 
   |unofficial version = 2.12.9-unofficial.1-minervamaga
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-26#post-3354284
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-26#post-3354284
Line 1,936: Line 1,935:
 
   |github  = danvolchek/StardewMods
 
   |github  = danvolchek/StardewMods
  
−
   |broke in = Stardew Valley 1.4
+
   |broke in           = Stardew Valley 1.4
 
   |unofficial version = 1.3.1-unofficial-1-slamerz
 
   |unofficial version = 1.3.1-unofficial-1-slamerz
−
   |unofficial url    = https://community.playstarbound.com/attachments/customwarplocations-1-3-1-unofficial-1-slamerz-zip.216521/
+
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-25#post-3354209
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,973: Line 1,972:
 
   |nexus id = 4779
 
   |nexus id = 4779
 
   |chucklefish id = 5907
 
   |chucklefish id = 5907
−
   |moddrop id = 677025
+
   |moddrop id     = 677025
 
   |curseforge id  = 353698
 
   |curseforge id  = 353698
 
   |curseforge key = daily-screenshot
 
   |curseforge key = daily-screenshot
Line 2,214: Line 2,213:
 
   |status  = workaround
 
   |status  = workaround
 
   |summary  = use [[#Fishing Mod|Fishing Mod]] instead.
 
   |summary  = use [[#Fishing Mod|Fishing Mod]] instead.
−
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,248: Line 2,246:
  
 
   |broke in = SMAPI 3.0
 
   |broke in = SMAPI 3.0
−
}}
 
−
{{/entry
 
−
  |name    = EightCorners
 
−
  |author  = prazon99
 
−
  |id      = prazon99.EightCorners
 
−
  |nexus id = 4850
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 3,154: Line 3,146:
 
   |github  = danvolchek/StardewMods
 
   |github  = danvolchek/StardewMods
  
−
   |broke in = Stardew Valley 1.4
+
   |broke in           = Stardew Valley 1.4
 
   |unofficial version = 1.3.0-unofficial.1-slamerz
 
   |unofficial version = 1.3.0-unofficial.1-slamerz
−
   |unofficial url    = https://community.playstarbound.com/attachments/holdtobreakgeodes-1-3-0-unofficial-1-slamerz-zip.216522/
+
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-25#post-3354209
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 3,682: Line 3,674:
 
   |chucklefish id = 4053
 
   |chucklefish id = 4053
 
   |moddrop id = 127279
 
   |moddrop id = 127279
−
  |url      = https://spacechase0.com/mods/stardew-valley/luck-skill/
 
 
   |github  = spacechase0/LuckSkill
 
   |github  = spacechase0/LuckSkill
 +
 +
  |summary  = get [https://spacechase0.com/mods/stardew-valley/luck-skill/ latest version from author's website].
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 3,707: Line 3,700:
 
   |nexus id = 2007
 
   |nexus id = 2007
 
   |chucklefish id = 5242
 
   |chucklefish id = 5242
−
  |url      = https://spacechase0.com/mods/stardew-valley/magic/
 
 
   |github  = spacechase0/Magic
 
   |github  = spacechase0/Magic
 +
 +
  |summary  = get [https://spacechase0.com/mods/stardew-valley/magic/ latest version from author's website].
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 3,914: Line 3,908:
 
{{/entry
 
{{/entry
 
   |name    = More Barn and Coop Animals  
 
   |name    = More Barn and Coop Animals  
−
   |author  = AairTheGreat, Aair, AairTheGreat
+
   |author  = AairTheGreat, Aair
 
   |id      = AairTheGreat.MoreBarnCoopAnimals
 
   |id      = AairTheGreat.MoreBarnCoopAnimals
−
   |nexus id = 4869
+
   |nexus id = 4869
 +
  |github  =
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,762: Line 4,757:
 
   |unofficial version = 1.0.8-unofficial.1-ResidentDonna
 
   |unofficial version = 1.0.8-unofficial.1-ResidentDonna
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-18#post-3353768
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-18#post-3353768
−
  |dev note = official loads but does not function properly
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,886: Line 4,880:
  
 
   |broke in    = Stardew Valley 1.4
 
   |broke in    = Stardew Valley 1.4
−
 
+
 
−
   |unofficial version = 2.1.4-unofficial.7-mizzion
+
   |unofficial version = 2.1.3-unofficial.7-mizzion
−
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-30#post-3354650
+
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-36#post-3355148
−
   |links       = https://github.com/silentoak/StardewMods/pull/3
+
   |links             = https://github.com/silentoak/StardewMods/pull/3
−
   |link labels = PR
+
   |link labels       = PR
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,900: Line 4,894:
  
 
   |broke in    = Stardew Valley 1.4
 
   |broke in    = Stardew Valley 1.4
−
 
+
 
−
   |unofficial version = 2.1.4-unofficial.7-mizzion
+
   |unofficial version = 2.1.3-unofficial.7-mizzion
−
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-30#post-3354650
+
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-36#post-3355148
−
   |links       = https://github.com/silentoak/StardewMods/pull/3
+
   |links             = https://github.com/silentoak/StardewMods/pull/3
−
   |link labels = PR
+
   |link labels       = PR
 
}}
 
}}
 
{{/entry
 
{{/entry

Revision as of 04:18, 14 December 2019

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.
  2. ↑ 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=92485"