Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎For players: merge "C# mods" and "C# mods (obsolete)" sections to simplify maintenance)
(→‎C# mods: update Bulk Staircases (Nexus page deleted and recreated), add CurseForge IDs (Auto Animal Doors, Chest Displays, Data Layers, Debug Mode, Distant Lands, Enchanted Galaxy and Infinity Weapons, Horse Flute Anywhere, Love Festival, Multi Save - Continued, Noclip Mode, Range Highlight, Schedule Viewer, Shopping Show, Skip Intro, Stardew Voices, To-Dew))
Line 1,237: Line 1,237:
 
   |author  = taggartaa, Aaron Taggart
 
   |author  = taggartaa, Aaron Taggart
 
   |id      = AaronTaggart.AutoAnimalDoors
 
   |id      = AaronTaggart.AutoAnimalDoors
 +
  |curse  = 1002753
 
   |nexus  = 1019
 
   |nexus  = 1019
 
   |github  = taggartaa/AutoAnimalDoors
 
   |github  = taggartaa/AutoAnimalDoors
Line 2,947: Line 2,948:
 
   |author  = BananaFruit
 
   |author  = BananaFruit
 
   |id      = BananaFruit.BulkStaircases
 
   |id      = BananaFruit.BulkStaircases
   |nexus  = 10622
+
   |nexus  = 23482
 
   |moddrop = 1084873
 
   |moddrop = 1084873
 
   |github  = BananaFruit1492/BulkStaircases
 
   |github  = BananaFruit1492/BulkStaircases
Line 3,499: Line 3,500:
 
   |author  = MindMeltMax
 
   |author  = MindMeltMax
 
   |id      = MindMeltMax.ChestDisplays
 
   |id      = MindMeltMax.ChestDisplays
 +
  |curse  = 997977
 
   |nexus  = 7644
 
   |nexus  = 7644
 
   |moddrop = 1135692
 
   |moddrop = 1135692
Line 5,848: Line 5,850:
 
   |author  = Pathoschild
 
   |author  = Pathoschild
 
   |id      = Pathoschild.DataLayers, Pathoschild.DataMaps<!--changed in 1.4-->
 
   |id      = Pathoschild.DataLayers, Pathoschild.DataMaps<!--changed in 1.4-->
 +
  |curse  = 1000628
 
   |nexus  = 1691
 
   |nexus  = 1691
 
   |moddrop = 606646
 
   |moddrop = 606646
Line 5,885: Line 5,888:
 
   |author  = Pathoschild
 
   |author  = Pathoschild
 
   |id      = Pathoschild.DebugMode, Pathoschild.Stardew.DebugMode<!--changed in 1.4-->
 
   |id      = Pathoschild.DebugMode, Pathoschild.Stardew.DebugMode<!--changed in 1.4-->
 +
  |curse  = 1000634
 
   |nexus  = 679
 
   |nexus  = 679
 
   |moddrop = 606608
 
   |moddrop = 606608
Line 6,269: Line 6,273:
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
   |name    = Distant Lands - A Small Witch Swamp Expansion, Aimons Witch Swamp Overhaul Patches
+
   |name    = Distant Lands - A Small Witch Swamp Expansion, Aimons Witch Swamp Overhaul Patches
 
   |author  = Aimon111
 
   |author  = Aimon111
 
   |id      = AimonsWitchSwampOverhaulPatches
 
   |id      = AimonsWitchSwampOverhaulPatches
 +
  |curse  = 1010281
 
   |nexus  = 18109
 
   |nexus  = 18109
 
   |github  = SimonK1122/WitchSwampOverhaulPatches
 
   |github  = SimonK1122/WitchSwampOverhaulPatches
Line 7,005: Line 7,010:
 
   |author  = NamelessTo
 
   |author  = NamelessTo
 
   |id      = NamelessTo.EnchantedGalaxyWeapons
 
   |id      = NamelessTo.EnchantedGalaxyWeapons
 +
  |curse  = 1001630
 
   |nexus  = 21904
 
   |nexus  = 21904
 
   |github  = namelessto/EnchantedGalaxyWeapons
 
   |github  = namelessto/EnchantedGalaxyWeapons
Line 10,229: Line 10,235:
 
   |author  = Pathoschild
 
   |author  = Pathoschild
 
   |id      = Pathoschild.HorseFluteAnywhere
 
   |id      = Pathoschild.HorseFluteAnywhere
 +
  |curse  = 1000620
 
   |nexus  = 7500
 
   |nexus  = 7500
 
   |github  = Pathoschild/StardewMods
 
   |github  = Pathoschild/StardewMods
Line 12,080: Line 12,087:
 
   |author  = AvalonMFX
 
   |author  = AvalonMFX
 
   |id      = AvalonMFX.LoveFestival
 
   |id      = AvalonMFX.LoveFestival
 +
  |curse  = 1016375
 
   |nexus  = 17819
 
   |nexus  = 17819
 
   |github  =
 
   |github  =
Line 13,703: Line 13,711:
 
   |author  = recon88
 
   |author  = recon88
 
   |id      = recon88.MultiSave
 
   |id      = recon88.MultiSave
 +
  |curse  = 1018922
 
   |nexus  = 22953
 
   |nexus  = 22953
 
   |github  = recon88/Multi-Save-Continued
 
   |github  = recon88/Multi-Save-Continued
Line 14,055: Line 14,064:
 
   |author  = Pathoschild
 
   |author  = Pathoschild
 
   |id      = Pathoschild.NoclipMode
 
   |id      = Pathoschild.NoclipMode
 +
  |curse  = 1000622
 
   |nexus  = 3900
 
   |nexus  = 3900
 
   |moddrop = 691002
 
   |moddrop = 691002
Line 16,634: Line 16,644:
 
   |author  = Jamie Taylor
 
   |author  = Jamie Taylor
 
   |id      = jltaylor-us.RangeHighlight
 
   |id      = jltaylor-us.RangeHighlight
 +
  |curse  = 997096
 
   |nexus  = 6752
 
   |nexus  = 6752
 
   |github  = jltaylor-us/StardewRangeHighlight
 
   |github  = jltaylor-us/StardewRangeHighlight
Line 17,487: Line 17,498:
 
   |author  = BinaryLip
 
   |author  = BinaryLip
 
   |id      = BinaryLip.ScheduleViewer
 
   |id      = BinaryLip.ScheduleViewer
 +
  |curse  = 1020728
 
   |nexus  = 19305
 
   |nexus  = 19305
 
   |github  = BinaryLip/ScheduleViewer
 
   |github  = BinaryLip/ScheduleViewer
Line 18,139: Line 18,151:
 
   |author  = AvalonMFX
 
   |author  = AvalonMFX
 
   |id      = AvalonMFX.ShoppingShow
 
   |id      = AvalonMFX.ShoppingShow
 +
  |curse  = 1016429
 
   |nexus  = 18445
 
   |nexus  = 18445
 
   |github  =
 
   |github  =
Line 18,573: Line 18,586:
 
   |author  = Pathoschild
 
   |author  = Pathoschild
 
   |id      = Pathoschild.SkipIntro, SkipIntro<!--changed in 1.4-->
 
   |id      = Pathoschild.SkipIntro, SkipIntro<!--changed in 1.4-->
 +
  |curse  = 1000635
 
   |nexus  = 533
 
   |nexus  = 533
 
   |moddrop = 606601
 
   |moddrop = 606601
Line 19,894: Line 19,908:
 
   |author  = Shannon Hobby
 
   |author  = Shannon Hobby
 
   |id      = shobby.StardewVoices
 
   |id      = shobby.StardewVoices
 +
  |curse  = 1010539
 
   |nexus  = 22550
 
   |nexus  = 22550
 
   |github  =
 
   |github  =
Line 20,954: Line 20,969:
 
   |author  = Jamie Taylor
 
   |author  = Jamie Taylor
 
   |id      = jltaylor-us.ToDew
 
   |id      = jltaylor-us.ToDew
 +
  |curse  = 997100
 
   |nexus  = 7409
 
   |nexus  = 7409
 
   |github  = jltaylor-us/StardewToDew
 
   |github  = jltaylor-us/StardewToDew

Revision as of 20:20, 29 May 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.

C# 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.

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