Jump to content

Modding:Mod compatibility: Difference between revisions

From Stardew Valley Wiki
imported>Pathoschild
→SMAPI mods: update mods broken in Stardew Valley 1.5.5 beta (24h Clock, Activate Sprinklers, Add to Workbench Chests, Adopt 'n Skin, Allow Beach Sprinklers, Animal Patting, Animated Portrait Framework, Anything Ponds, Artifact Digger, A Tapper's Dream, Audio Devices, Auto Animal Doors, Auto Farm Screenshot, Auto Load Game, AutoShaker, Auto Stacker, Deep Woods Seasonal Obelisk, Entoarox Framework, Industrial Furnace + Industrial Furnace for Automate) and workarounds (24 Hour Format)
imported>Pathoschild
→SMAPI mods: update mods broken by Stardew Valley 1.5.5 beta (Auto Watering by stellarashes, Basic Sprinker Improved, Befriend Marlon and Gunther, Better RNG, Better Sort, Boss Creatures, Breed Like Rabbits 2: Procreation Boogaloo, Bus Locations, Buy Cooking Recipes, Cacti Hurt You, Calendar Anywhere, Catalogues Anywhere, Cat Gifts, Cats and Dogs, CCRMAutomate, Chat Commands, Chef Helper, Chill in Your Farmhouse, Clean Farm, Coal Regen, Item AutoTrasher)
Line 842: Line 842:
   |broke in = SMAPI 2.0
   |broke in = SMAPI 2.0
   |status  = workaround
   |status  = workaround
   |summary  = use [[#Auto Water|Auto Water]], [[#Auto Watering (stellarashes)|Auto Watering (by stellarashes)]], or [[#CJB Cheats Menu|CJB Cheats Menu]] instead.
   |summary  = use [[#Auto Water|Auto Water]] or [[#CJB Cheats Menu|CJB Cheats Menu]] instead.
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 850: Line 850:
   |nexus id = 5463
   |nexus id = 5463
   |github  = stellarashes/SDVMods
   |github  = stellarashes/SDVMods
  |beta broke in = Stardew Valley 1.5.5
  |beta status  = workaround
  |beta summary  = use [[#Auto Water|Auto Water]], [[Auto Watering (aurnj)|Auto Watering (aurnj)]], or [[#CJB Cheats Menu|CJB Cheats Menu]] instead.
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 897: Line 901:
   |nexus id = 833
   |nexus id = 833
   |github  = littleraskol/Basic-Sprinkler-Improved
   |github  = littleraskol/Basic-Sprinkler-Improved
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 929: Line 935:
   |nexus id = 2569
   |nexus id = 2569
   |github  = yoshimax2/Befriend-Marlon-and-Gunther
   |github  = yoshimax2/Befriend-Marlon-and-Gunther
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 936: Line 944:
   |nexus id = 5219
   |nexus id = 5219
   |github  =  
   |github  =  
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 1,169: Line 1,179:
   |url      = https://github.com/Zoryn4163/SMAPI-Mods/releases
   |url      = https://github.com/Zoryn4163/SMAPI-Mods/releases
   |github  = Zoryn4163/SMAPI-Mods
   |github  = Zoryn4163/SMAPI-Mods
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 1,223: Line 1,235:
   |nexus id = 1992
   |nexus id = 1992
   |github  =  
   |github  =  
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 1,405: Line 1,419:
   |nexus id = 5864
   |nexus id = 5864
   |github  = aedenthorn/StardewValleyMods
   |github  = aedenthorn/StardewValleyMods
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 1,429: Line 1,445:


   |broke in = Stardew Valley 1.3
   |broke in = Stardew Valley 1.3
<!--@retest-after Breed Like Rabbits 2: Procreation Boogaloo
   |status  = workaround
   |status  = workaround
   |summary  = use [[#Breed Like Rabbits 2: Procreation Boogaloo|Breed Like Rabbits 2: Procreation Boogaloo]] instead.
   |summary  = use [[#Breed Like Rabbits 2: Procreation Boogaloo|Breed Like Rabbits 2: Procreation Boogaloo]] instead.
-->
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 1,438: Line 1,456:
   |nexus id = 3429
   |nexus id = 3429
   |github  =  
   |github  =  
  |beta broke in = Stardew Valley 1.5.5<!--@retest-linked-->
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 1,491: Line 1,511:
   |nexus id = 2905
   |nexus id = 2905
   |github  = hootless/StardewMods
   |github  = hootless/StardewMods
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 1,512: Line 1,534:
   |nexus id = 1126
   |nexus id = 1126
   |github  = Denifia/StardewMods
   |github  = Denifia/StardewMods
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 1,527: Line 1,551:
   |moddrop id = 833562
   |moddrop id = 833562
   |github  = danvolchek/StardewMods
   |github  = danvolchek/StardewMods
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 1,535: Line 1,561:
   |url      = https://github.com/Zoryn4163/SMAPI-Mods/releases
   |url      = https://github.com/Zoryn4163/SMAPI-Mods/releases
   |github  = Zoryn4163/SMAPI-Mods
   |github  = Zoryn4163/SMAPI-Mods
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 1,602: Line 1,630:
   |moddrop id = 716382
   |moddrop id = 716382
   |github  = ChroniclerCherry/stardew-valley-mods
   |github  = ChroniclerCherry/stardew-valley-mods
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 1,624: Line 1,654:
   |nexus id = 2132
   |nexus id = 2132
   |github  = skuldomg/catGifts
   |github  = skuldomg/catGifts
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 1,631: Line 1,663:
   |nexus id = 7407
   |nexus id = 7407
   |github  =
   |github  =
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 1,725: Line 1,759:
   |moddrop id = 833554
   |moddrop id = 833554
   |github  = danvolchek/StardewMods
   |github  = danvolchek/StardewMods
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 1,739: Line 1,775:
   |nexus id = 5606
   |nexus id = 5606
   |github  = ChristinaEd/ChefHelperAddToFridges
   |github  = ChristinaEd/ChefHelperAddToFridges
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 1,874: Line 1,912:
   |nexus id = 1768
   |nexus id = 1768
   |github  = Husky110/ChillInYourFarmHouse
   |github  = Husky110/ChillInYourFarmHouse
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 1,940: Line 1,980:
   |nexus id = 794
   |nexus id = 794
   |github  = tstaples/CleanFarm
   |github  = tstaples/CleanFarm
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 1,971: Line 2,013:
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/page-65#post-3331467
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/page-65#post-3331467
   |pull request      = https://github.com/AbbyNode/StardewValley-CoalRegen/pull/1
   |pull request      = https://github.com/AbbyNode/StardewValley-CoalRegen/pull/1
  |beta status = broken
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 5,277: Line 5,321:
   |nexus id = 5140
   |nexus id = 5140
   |github  = S1mmyy/StardewMods
   |github  = S1mmyy/StardewMods
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry

Revision as of 04:26, 28 August 2021

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.

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