Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: add new mods (Brighter Building Paint, Button's Extra Books, Catalogue Framework, Chaste Valley, Control Tree, Crafting Collections Page, Crowcalypse, Crystalline Junimo Chests, Custom Egg Amount to Win the Egg Festival, Custom Names, Custom Tapper Framework, Animal Skin Replacer, Demetrius Solo Dancing, Easy Crane Game, Eat Food In Backpack Instantly, Empty Jar Bubbles, Enchanted Galaxy and Infinity Weapons, Energy Protect, Energy Rework, Enough Sleep, Esc Dialogue Mod))
(→‎SMAPI mods: add new mods (Exp Control, Extra Machine Configs, Faster Trees, Field Harvest Redux, Filtered Chest Hopper, Food Poisoning, Fortunate Foot, Fruit Trees Unblocked, Full Fishing Bar, Genie Lamp Definitive Edition, Hats on Pets Plus, Health Rework, Heart Event Helper, Help Wanted Auto Accept, Industrialization Redux, Instant Animals 1.6, Instant Dialogues, Integrated Minecarts, Jack Be Thicc, Junimatic, Ladder Light, Lazy Mod, Level Forever); add new workaround (Instant Animals))
Line 6,246: Line 6,246:
 
   |nexus  = 7431
 
   |nexus  = 7431
 
   |github  = LeFauxMatt/StardewMods
 
   |github  = LeFauxMatt/StardewMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Exp Control
 +
  |author  = moonslime
 +
  |id      = moonslime.ExpControl
 +
  |nexus  = 23067
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 6,344: Line 6,351:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Extra Machine Configs
 +
  |author  = Selph, zombifier
 +
  |id      = selph.ExtraMachineConfig
 +
  |nexus  = 22256
 +
  |github  = zombifier/My_Stardew_Mods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 6,761: Line 6,775:
 
   |nexus  = 19584
 
   |nexus  = 19584
 
   |github  = DotSharkTeeth/StardewValleyMods
 
   |github  = DotSharkTeeth/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Faster Trees
 +
  |author  = Krutonium
 +
  |id      = ca.krutonium.fastertrees
 +
  |nexus  = 21952
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 6,912: Line 6,933:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Field Harvest Redux
 +
  |author  = Prism 99
 +
  |id      = prism99.aedenthorn.FieldHarvest
 +
  |nexus  = 21703
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 6,935: Line 6,963:
 
   |nexus  = 17553
 
   |nexus  = 17553
 
   |github  =
 
   |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Filtered Chest Hopper
 +
  |author  = Shivion
 +
  |id      = shivion.FilteredChestHopper
 +
  |nexus  = 21730
 +
  |github  = Shivion/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 7,471: Line 7,506:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Food Poisoning
 +
  |author  = seferoni
 +
  |id      = seferoni.FoodPoisoning
 +
  |nexus  = 22006
 +
  |github  = seferoni/FoodPoisoning
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 7,530: Line 7,572:
 
   |nexus  = 7541
 
   |nexus  = 7541
 
   |github  = GStefanowich/SDV-Forecaster
 
   |github  = GStefanowich/SDV-Forecaster
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Fortunate Foot
 +
  |author  = PurelyInZane
 +
  |id      = PurelyInZane.FortunateFoot
 +
  |nexus  = 22610
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 7,682: Line 7,731:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Fruit Trees Unblocked
 +
  |author  = dervalanana
 +
  |id      = dervalanana.FruitTreesUnblocked
 +
  |nexus  = 22976
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 7,698: Line 7,754:
 
   |nexus  = 21449
 
   |nexus  = 21449
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Full Fishing Bar
 +
  |author  = Jag3Dagster
 +
  |id      = HedgehogTechnologies.FullFishingBar
 +
  |curse  = 1007653
 +
  |nexus  = 23006
 +
  |github  = jag3dagster/AutoShaker
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 7,939: Line 8,003:
 
   |nexus  = 19794
 
   |nexus  = 19794
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Genie Lamp Definitive Edition, Genie Lamp
 +
  |author  = Kedidili
 +
  |id      = KediDili.GenieLamp
 +
  |nexus  = 22176
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 8,520: Line 8,591:
 
   |nexus  = 17280
 
   |nexus  = 17280
 
   |github  = Shockah/Stardew-Valley-Mods
 
   |github  = Shockah/Stardew-Valley-Mods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Hats on Pets Plus
 +
  |author  = Syma
 +
  |id      = Syma.HatsOnPetsPlus
 +
  |nexus  = 22631
 +
  |github  = SymaLoernn/Stardew_HatsOnPetsPlus
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 8,584: Line 8,662:
 
   |status  = workaround
 
   |status  = workaround
 
   |summary  = use [[#Enemy Health Bars|Enemy Health Bars]] (by OrSpeeder or by TheThor59) or [[#Health Bars|Health Bars]] (by Zoryn) instead.
 
   |summary  = use [[#Enemy Health Bars|Enemy Health Bars]] (by OrSpeeder or by TheThor59) or [[#Health Bars|Health Bars]] (by Zoryn) instead.
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Health Rework
 +
  |author  = seferoni
 +
  |id      = seferoni.HealthRework
 +
  |nexus  = 22223
 +
  |github  = seferoni/HealthRework
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 8,591: Line 8,676:
 
   |nexus  = 5941
 
   |nexus  = 5941
 
   |github  = embolden/Heartbeat
 
   |github  = embolden/Heartbeat
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Heart Event Helper
 +
  |author  = bungus
 +
  |id      = bungus.HeartEventHelper
 +
  |nexus  = 21924
 +
  |github  = BussinBungus/BungusSDVMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 8,634: Line 8,726:
 
   |status  = workaround
 
   |status  = workaround
 
   |summary  = use {{nexus mod|21766|Dialogue Display Framework Continued}} instead.
 
   |summary  = use {{nexus mod|21766|Dialogue Display Framework Continued}} instead.
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Help Wanted Auto Accept
 +
  |author  = Ruse82
 +
  |id      = Ruse82.HelpWantedAutoAccept
 +
  |nexus  = 22235
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 9,127: Line 9,226:
  
 
   |broke in = Stardew Valley 1.6<!--@retest-after Industrial Furnace-->
 
   |broke in = Stardew Valley 1.6<!--@retest-after Industrial Furnace-->
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Industrialization Redux
 +
  |author  = GaLaxY256 and kazuakisama
 +
  |id      = G256.IR.Code
 +
  |nexus  = 22351
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 9,250: Line 9,356:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
  |status  = workaround
 +
  |summary  = use [[#Instant Animals 1.6|Instant Animals 1.6]] instead.
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Instant Animals 1.6
 +
  |author  = Siweipancc
 +
  |id      = Siweipancc.Instantanimals
 +
  |nexus  = 21798
 +
  |github  = siweipancc/InstantAnimals
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 9,276: Line 9,391:
 
   |nexus  = 2070
 
   |nexus  = 2070
 
   |github  = bitwisejon/StardewValleyMods
 
   |github  = bitwisejon/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Instant Dialogues
 +
  |author  = idermailer
 +
  |id      = idermailer.InstantDialogues
 +
  |nexus  = 22468
 +
  |github  = idermailer/InstantDialogues
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 9,366: Line 9,488:
 
   |nexus  = 8918
 
   |nexus  = 8918
 
   |github  = Binarynova/MyStardewMods
 
   |github  = Binarynova/MyStardewMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Integrated Minecarts
 +
  |author  = Jibb
 +
  |id      = jibb.minecarts.C
 +
  |curse  = 988762
 +
  |nexus  = 11881
 +
  |github  = Jibblestein/StardewMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 9,557: Line 9,687:
 
   |nexus  = 13798
 
   |nexus  = 13798
 
   |github  =
 
   |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Jack Be Thicc
 +
  |author  = DeadRobotDev
 +
  |id      = DeadRobotDev.JackBeThicc
 +
  |nexus  = 21533
 +
  |github  = DeadRobotDev/StardewMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 9,690: Line 9,827:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Junimatic
 +
  |author  = NermNermNerm
 +
  |id      = NermNermNerm.Junimatic
 +
  |nexus  = 22672
 +
  |github  = NermNermNerm/Junimatic
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 9,896: Line 10,040:
  
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Ladder Light
 +
  |author  = Tocseoj
 +
  |id      = Tocseoj.LadderLight
 +
  |moddrop = 1549539
 +
  |nexus  =
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 9,940: Line 10,092:
 
   |nexus  = 14377
 
   |nexus  = 14377
 
   |github  = sophiesalacia/StardewMods
 
   |github  = sophiesalacia/StardewMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Lazy Mod
 +
  |author  = weizinai
 +
  |id      = weizinai.LazyMod
 +
  |nexus  = 22826
 +
  |github  = weizinai/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 10,028: Line 10,187:
  
 
   |broke in = Stardew Valley 1.6<!--@retest-linked-->
 
   |broke in = Stardew Valley 1.6<!--@retest-linked-->
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Level Forever
 +
  |author  = GoldstoneBosonMeadows, Parakee
 +
  |id      = GoldstoneBosonMeadows.LevelForever
 +
  |nexus  = 22920
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry

Revision as of 05:07, 25 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).