Jump to content

Modding:Mod compatibility: Difference between revisions

From Stardew Valley Wiki
← Older editNewer edit →
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)
imported>Pathoschild
→SMAPI mods: update mods broken in Stardew Valley 1.5.5 beta (Configure Machine Speed, Context-Sensitive Gift Cursor, Control Valley, Convenient Chests, Crab Pot Loot Has Quality and Bait Effects, Crane Man Begone, Crop Color Combiner, Crop Fairy, Custom Crafting Stations, Custom Tracker, Custom Warp Locations, Customize Anywhere) and workarounds (Breed Like Rabbits, Categorize Chests, Chest Pooling, Machine Speed Change, Sorted Storages, Stack to Nearby Chests, Stash Items to Chest)
Line 1,445: 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.
-->
 
  |beta status = broken<!--@retest-after Breed Like Rabbits 2: Procreation Boogaloo-->
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 1,647: Line 1,647:
   |unofficial url    = https://community.playstarbound.com/attachments/categorizechests-1-4-3-unofficial-3-mizzion-zip.204116/
   |unofficial url    = https://community.playstarbound.com/attachments/categorizechests-1-4-3-unofficial-3-mizzion-zip.204116/
-->
-->
  |beta status = broken<!--@retest-after Convenient Chests-->
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 1,855: Line 1,857:
   |summary  = use [[#Convenient Chests|Convenient Chests]] instead.
   |summary  = use [[#Convenient Chests|Convenient Chests]] instead.
   |pull request = https://github.com/mralbobo/stardew-chest-pooling/pull/4
   |pull request = https://github.com/mralbobo/stardew-chest-pooling/pull/4
  |beta status = broken<!--@retest-after Convenient Chests-->
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 2,168: Line 2,172:
   |nexus id = 3519
   |nexus id = 3519
   |github  = BayesianBandit/ConfigureMachineSpeed
   |github  = BayesianBandit/ConfigureMachineSpeed
  |beta broke in = Stardew Valley 1.5.5<!--@retest-linked-->
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 2,229: Line 2,235:
   |nexus id = 6564
   |nexus id = 6564
   |github  =  
   |github  =  
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 2,236: Line 2,244:
   |nexus id = 8160
   |nexus id = 8160
   |github  = tesla1889tv/ControlValleyMod
   |github  = tesla1889tv/ControlValleyMod
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 2,249: Line 2,259:
   |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/post-28711
   |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/post-28711
   |unofficial version = 1.5.2-unofficial.2-borthain
   |unofficial version = 1.5.2-unofficial.2-borthain
  |beta status = broken<!--@retest-linked-->
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 2,293: Line 2,305:
   |nexus id = 7767
   |nexus id = 7767
   |github  = Goldenrevolver/Stardew-Valley-Mods
   |github  = Goldenrevolver/Stardew-Valley-Mods
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 2,330: Line 2,344:
   |nexus id = 4704
   |nexus id = 4704
   |github  = MouseyPounds/stardew-mods
   |github  = MouseyPounds/stardew-mods
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 2,353: Line 2,369:
   |nexus id = 3986
   |nexus id = 3986
   |github  = MouseyPounds/stardew-mods
   |github  = MouseyPounds/stardew-mods
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 2,370: Line 2,388:
   |nexus id = 4885
   |nexus id = 4885
   |github  =  
   |github  =  
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 2,502: Line 2,522:
   |nexus id = 6293
   |nexus id = 6293
   |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 2,620: Line 2,642:
   |moddrop id = 716356
   |moddrop id = 716356
   |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 2,790: Line 2,814:
   |github    = Esca-MMC/CustomTracker
   |github    = Esca-MMC/CustomTracker
   |moddrop id = 706059
   |moddrop id = 706059
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 2,823: Line 2,849:
   |moddrop id = 833544
   |moddrop id = 833544
   |github  = danvolchek/StardewMods
   |github  = danvolchek/StardewMods
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 5,820: Line 5,848:
   |status  = workaround
   |status  = workaround
   |summary  = use [[#Configure Machine Speed|Configure Machine Speed]] instead.
   |summary  = use [[#Configure Machine Speed|Configure Machine Speed]] instead.
  |beta status = broken<!--@retest-after Configure Machine Speed-->
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 9,210: Line 9,240:
   |status  = workaround
   |status  = workaround
   |summary  = use [[#Convenient Chests|Convenient Chests]] instead.
   |summary  = use [[#Convenient Chests|Convenient Chests]] instead.
  |beta status = broken<!--@retest-after Convenient Chests-->
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 9,453: Line 9,485:
   |status  = workaround
   |status  = workaround
   |summary  = use [[#Convenient Chests|Convenient Chests]] instead.
   |summary  = use [[#Convenient Chests|Convenient Chests]] instead.
  |beta status = broken<!--@retest-after Convenient Chests-->
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 9,665: Line 9,699:
   |status  = workaround
   |status  = workaround
   |summary  = use [[#Convenient Chests|Convenient Chests]] instead.
   |summary  = use [[#Convenient Chests|Convenient Chests]] instead.
  |beta status = broken<!--@retest-after Convenient Chests-->
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry

Revision as of 14:38, 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).
Retrieved from "https://stardew.fastobject.net/index.php?title=Modding:Mod_compatibility&oldid=106962"