Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: add CurseForge IDs (Better Shipping Bin, Easy Island Puzzle, Hay Collection, Ladder Locator, Locked Chests, Many Enchantments, Market Town, Multi-User Chests, Multiplayer Info, Quality Bait, Small Beach Farm, Trading, Winter Pigs), add ModDrop Ids (Geode Preview, Hay Collection, Toolbar Icons), update for mod rename (Better Horse Flute to Iridium Horse Flute), update mod ID (Mouse Move Mode, Polyamory Sweet))
Line 1,704: Line 1,704:
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
   |name    = Better Horse Flute
+
   |name    = Iridium Horse Flute<!--changed in 2.0.0-->, Better Horse Flute
 
   |author  = Anthony Maciel, maciel310
 
   |author  = Anthony Maciel, maciel310
   |id      = AnthonyMaciel.BetterHorseFlute
+
   |id      = AnthonyMaciel.IridiumHorseFlute<!--changed in 2.0.0-->, AnthonyMaciel.BetterHorseFlute
 
   |nexus  = 15285
 
   |nexus  = 15285
 
   |github  =
 
   |github  =
Line 1,885: Line 1,885:
 
   |author  = MindMeltMax
 
   |author  = MindMeltMax
 
   |id      = MindMeltMax.BetterShipping
 
   |id      = MindMeltMax.BetterShipping
   |moddrop = 004479
+
  |curse  = 1004479
 +
   |moddrop = 1135742
 
   |nexus  = 10487
 
   |nexus  = 10487
  |moddrop = 1135742
 
 
   |github  = MindMeltMax/Stardew-Valley-Mods
 
   |github  = MindMeltMax/Stardew-Valley-Mods
 
}}
 
}}
Line 5,418: Line 5,418:
 
   |author  = MindMeltMax
 
   |author  = MindMeltMax
 
   |id      = MindMeltMax.EasyIslandPuzzle
 
   |id      = MindMeltMax.EasyIslandPuzzle
 +
  |curse  = 1004494
 
   |nexus  = 22642
 
   |nexus  = 22642
 
   |github  = MindMeltMax/Stardew-Valley-Mods
 
   |github  = MindMeltMax/Stardew-Valley-Mods
Line 7,669: Line 7,670:
 
   |id      = MindMeltMax.GeodePreview
 
   |id      = MindMeltMax.GeodePreview
 
   |curse  = 1004493
 
   |curse  = 1004493
 +
  |moddrop = 1555057
 
   |nexus  = 21009
 
   |nexus  = 21009
 
   |github  = MindMeltMax/Stardew-Valley-Mods
 
   |github  = MindMeltMax/Stardew-Valley-Mods
Line 8,242: Line 8,244:
 
   |author  = MindMeltMax
 
   |author  = MindMeltMax
 
   |id      = MindMeltMax.HayCollection
 
   |id      = MindMeltMax.HayCollection
 +
  |curse  = 1004492
 +
  |moddrop = 1555056
 
   |nexus  = 21008
 
   |nexus  = 21008
 
   |github  = MindMeltMax/Stardew-Valley-Mods
 
   |github  = MindMeltMax/Stardew-Valley-Mods
Line 9,608: Line 9,612:
 
   |author  = ChaosEnergy
 
   |author  = ChaosEnergy
 
   |id      = ChaosEnergy.LadderLocator
 
   |id      = ChaosEnergy.LadderLocator
 +
  |curse  = 989910
 
   |nexus  = 3094
 
   |nexus  = 3094
 
   |github  = yuri-moens/LadderLocator
 
   |github  = yuri-moens/LadderLocator
Line 9,885: Line 9,890:
 
   |author  = MindMeltMax
 
   |author  = MindMeltMax
 
   |id      = MindMeltMax.LockedChests
 
   |id      = MindMeltMax.LockedChests
 +
  |curse  = 1004481
 
   |moddrop = 1179603
 
   |moddrop = 1179603
 
   |nexus  = 12452
 
   |nexus  = 12452
Line 10,254: Line 10,260:
 
   |author  = Stari
 
   |author  = Stari
 
   |id      = Stari.ManyEnchantments
 
   |id      = Stari.ManyEnchantments
 +
  |curse  = 1004483
 
   |nexus  = 8824
 
   |nexus  = 8824
 
   |github  = SlivaStari/ManyEnchantments
 
   |github  = SlivaStari/ManyEnchantments
Line 10,326: Line 10,333:
 
   |author  = d5a1lamdtd, HaPyke
 
   |author  = d5a1lamdtd, HaPyke
 
   |id      = d5a1lamdtd.MarketTown<!--changed in 3.0.0-->, d5a1lamdtd.FoodStore
 
   |id      = d5a1lamdtd.MarketTown<!--changed in 3.0.0-->, d5a1lamdtd.FoodStore
 +
  |curse  = 994458
 
   |moddrop = 1480763
 
   |moddrop = 1480763
 
   |nexus  = 19309
 
   |nexus  = 19309
Line 11,155: Line 11,163:
 
   |name    = Mouse Move Mode, Right Click Move Mode
 
   |name    = Mouse Move Mode, Right Click Move Mode
 
   |author  = ylsama
 
   |author  = ylsama
   |id      = ylsama.MouseMoveMode<!--changed in 1.2.8-->, ylsama.RightClickMoveMode
+
   |id      = nghiango1.MouseMoveMode<!--changed in 1.2.9-->, ylsama.MouseMoveMode<!--changed in 1.2.8-->, ylsama.RightClickMoveMode
 
   |nexus  = 2614
 
   |nexus  = 2614
 
   |github  = ylsama/RightClickMoveMode
 
   |github  = ylsama/RightClickMoveMode
Line 11,303: Line 11,311:
 
   |author  = MindMeltMax
 
   |author  = MindMeltMax
 
   |id      = MindMeltMax.MPInfo
 
   |id      = MindMeltMax.MPInfo
 +
  |curse  = 1004488
 
   |moddrop = 1302776
 
   |moddrop = 1302776
 
   |nexus  = 15155
 
   |nexus  = 15155
Line 11,425: Line 11,434:
 
   |author  = MindMeltMax
 
   |author  = MindMeltMax
 
   |id      = MindMeltMax.MUC
 
   |id      = MindMeltMax.MUC
 +
  |curse  = 997982
 
   |nexus  = 9856
 
   |nexus  = 9856
 
   |moddrop = 1135731
 
   |moddrop = 1135731
Line 13,013: Line 13,023:
 
   |name    = Polyamory Sweet → Polyamory Kiss
 
   |name    = Polyamory Sweet → Polyamory Kiss
 
   |author  = ApryllForever
 
   |author  = ApryllForever
   |id      = ApryllForever.PolyamoryKiss
+
   |id      = ApryllForever.PolyamorySweetKiss<!--changed in 1.1.6-->, ApryllForever.PolyamoryKiss
 
   |nexus  = 20599
 
   |nexus  = 20599
 
   |github  = ApryllForever/PolyamorySweetLove
 
   |github  = ApryllForever/PolyamorySweetLove
Line 13,568: Line 13,578:
 
   |author  = MindMeltMax
 
   |author  = MindMeltMax
 
   |id      = MindMeltMax.QualityBait
 
   |id      = MindMeltMax.QualityBait
 +
  |curse  = 1004490
 
   |moddrop = 1443555
 
   |moddrop = 1443555
 
   |nexus  = 16832
 
   |nexus  = 16832
Line 15,845: Line 15,856:
 
   |author  = Pathoschild
 
   |author  = Pathoschild
 
   |id      = Pathoschild.SmallBeachFarm
 
   |id      = Pathoschild.SmallBeachFarm
 +
  |curse  = 1000624
 
   |nexus  = 3750
 
   |nexus  = 3750
 
   |moddrop = 606555
 
   |moddrop = 606555
Line 17,689: Line 17,701:
 
   |id      = furyx639.ToolbarIcons
 
   |id      = furyx639.ToolbarIcons
 
   |curse  = 871834
 
   |curse  = 871834
 +
  |moddrop = 1547451
 
   |nexus  = 11026
 
   |nexus  = 11026
 
   |github  = LeFauxMatt/StardewMods
 
   |github  = LeFauxMatt/StardewMods
Line 17,830: Line 17,843:
 
   |author  = MindMeltMax
 
   |author  = MindMeltMax
 
   |id      = MindMeltMax.Trading
 
   |id      = MindMeltMax.Trading
 +
  |curse  = 1004485
 
   |moddrop = 1214750
 
   |moddrop = 1214750
 
   |nexus  = 13293
 
   |nexus  = 13293
Line 18,957: Line 18,971:
 
   |author  = MindMeltMax
 
   |author  = MindMeltMax
 
   |id      = MindMeltMax.WinterPigs
 
   |id      = MindMeltMax.WinterPigs
 +
  |curse  = 1004491
 
   |moddrop = 1443556
 
   |moddrop = 1443556
 
   |nexus  = 16879
 
   |nexus  = 16879

Revision as of 05:39, 24 April 2024

SMAPI mod compatibility, July 2017 to March 2021. 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.


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

  • Players: See smapi.io/mods for a more user-friendly list.
  • Modders: feel free to update this list! (See instructions.) Note that only SMAPI mods should be listed, not XNB mods or content packs.

SMAPI mods (obsolete)

This list contains mods which...

  • have their mod pages hidden/deleted;
  • or have been replaced by a change in the base game;
  • or have been explicitly abandoned by the mod author (unless they're open-source and likely to 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.

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