Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: remove mod repost (same author name + mod ID, original mod still works fine))
(→‎SMAPI mods: correct/normalize info (Connected Garden Pots, Crop Variation, Email App, Fellowship - Immersive Rings, Fix Categories in Recipes, Hibernation, Increased Fish Tank Capacity, Minecart Patcher, Missing Gift, Wall Televisions, Wiki Links))
Line 115: Line 115:
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
−
   |name    = Actually Lucky Rabbit
+
   |name    = Actually Lucky Rabbit<!--Nexus-->, Lucky Rabbits Foot<!--manifest-->
 
   |author  = Chelsea Bingiel
 
   |author  = Chelsea Bingiel
−
   |id      = cbingiel.ActuallyLuckyRabbit
+
   |id      = ChelseaBingiel.LuckyRabbitsFoot
 
   |nexus id = 11447
 
   |nexus id = 11447
−
   |github  =  
+
   |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 2,298: Line 2,298:
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
−
   |name    = Connected Garden Pot
+
   |name    = Connected Garden Pots
 
   |author  = aedenthorn
 
   |author  = aedenthorn
−
   |id      = aedenthorn.ConnectGardenPot
+
   |id      = aedenthorn.ConnectedGardenPots
 
   |nexus id = 11411
 
   |nexus id = 11411
−
   |github  = aedenthorn/StardewValleyMods/tree/master/ConnectedGardenPots
+
   |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 2,526: Line 2,526:
 
   |id      = aedenthorn.CropVariation
 
   |id      = aedenthorn.CropVariation
 
   |nexus id = 11467
 
   |nexus id = 11467
−
   |github  = aedenthorn/StardewValleyMods/tree/master/CropVariation
+
   |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 3,700: Line 3,700:
 
   |name    = Email App
 
   |name    = Email App
 
   |author  = aedenthorn
 
   |author  = aedenthorn
−
   |id      = aedenthorn.EmailApp
+
   |id      = aedenthorn.Email
 
   |nexus id = 11325
 
   |nexus id = 11325
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
Line 4,321: Line 4,321:
 
   |id      = DaLion.ImmersiveRings
 
   |id      = DaLion.ImmersiveRings
 
   |nexus id = 11380
 
   |nexus id = 11380
−
   |source  = https://gitlab.com/daleao/smapi-mods/-/tree/main/ImmersiveRings
+
   |source  = https://gitlab.com/daleao/smapi-mods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 4,588: Line 4,588:
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
−
   |name    = Fix Categories in Recipes
+
   |name    = Fix Categories in Recipes, Categories in Recipes
 
   |author  = Traktori
 
   |author  = Traktori
 
   |id      = Traktori.CategoriesInRecipes
 
   |id      = Traktori.CategoriesInRecipes
 
   |nexus id = 11400
 
   |nexus id = 11400
−
   |github  = Traktori7/StardewValleyMods/tree/master/CategoriesInRecipes
+
   |github  = Traktori7/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 5,434: Line 5,434:
 
   |id      = Shockah.Hibernation
 
   |id      = Shockah.Hibernation
 
   |nexus id = 11421
 
   |nexus id = 11421
−
   |github  = Shockah/Stardew-Valley-Mods/tree/master/Hibernation
+
   |github  = Shockah/Stardew-Valley-Mods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 5,709: Line 5,709:
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
−
   |name    = Increased Fish Tank Quality
+
   |name    = Increased Fish Tank Capacity<!--Nexus-->, Bigger Fish Tank Capacity<!--manifest-->
 
   |author  = shekurika
 
   |author  = shekurika
−
   |id      = shekurika.IncreasedFishTankQuality
+
   |id      = shekurika.fishtankCapacity
 
   |nexus id = 11388
 
   |nexus id = 11388
 
   |github  =  
 
   |github  =  
Line 6,742: Line 6,742:
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
−
   |name    = MinecartPatcher
+
   |name    = Minecart Patcher
 
   |author  = bwdy
 
   |author  = bwdy
 
   |id      = bwdymods.minecartpatcher
 
   |id      = bwdymods.minecartpatcher
 
   |nexus id = 11424
 
   |nexus id = 11424
−
   |github  = bwdy/SDVModding/tree/main/MinecartPatcher
+
   |github  = bwdy/SDVModding
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 6,823: Line 6,823:
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
−
   |name    = MissingGift
+
   |name    = Missing Gift
 
   |author  = ChiroxT
 
   |author  = ChiroxT
−
   |id      = ChiroxT.MissingGift
+
   |id      = treinke.missinggifts
 
   |nexus id = 11363
 
   |nexus id = 11363
 
   |github  =  
 
   |github  =  
Line 8,298: Line 8,298:
 
   |id      = Shockah.PleaseGiftMeInPerson
 
   |id      = Shockah.PleaseGiftMeInPerson
 
   |nexus id = 11217
 
   |nexus id = 11217
−
   |github  = Shockah/Stardew-Valley-Mods/tree/master/PleaseGiftMeInPerson
+
   |github  = Shockah/Stardew-Valley-Mods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 11,774: Line 11,774:
 
   |name    = Wall Televisions
 
   |name    = Wall Televisions
 
   |author  = aedenthorn
 
   |author  = aedenthorn
−
   |id      = aedenthorn.WallTelevisions
+
   |id      = aedenthorn.WallTelevision
 
   |nexus id = 11448
 
   |nexus id = 11448
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
Line 12,015: Line 12,015:
 
   |id      = aedenthorn.WikiLinks
 
   |id      = aedenthorn.WikiLinks
 
   |nexus id = 11476
 
   |nexus id = 11476
−
   |github  = aedenthorn/StardewValleyMods/tree/master/WikiLinks
+
   |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry

Revision as of 03:51, 31 March 2022

Modding:Player Guide/header

SMAPI mod compatibility, July 2017 to present. 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).
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Mod_compatibility&oldid=136348"