Jump to content

Modding:Mod compatibility: Difference between revisions

From Stardew Valley Wiki
← Older editNewer edit →
imported>Pathoschild
→SMAPI mods: update mods broken in Stardew Valley 1.5.5 (Line Sprinklers, Lockpicks, Lunar Disturbances, Notes, More TV Channel, NPC Path Displayer, Sailor Moon Hairstyles and Clothing, Sleep Worker, Spelldew Valley, Stardew Locations, Stardew Notifications, Stardew Symphony Remastered, Stay Up, Tailor Weapon Skins, Tilled Soil Decay, Time of the Prairie King, Time Multiplier, Time Reminder, Tool Charging, Train Whistle, Tree Spread) and workarounds (Daily Luck Message, Game Reminder)
imported>Pathoschild
→SMAPI mods: update mods broken in Stardew Valley 1.5.5 beta (Traveling Takes Time, Tree Shaker, Tree Transplant, Trick or Treat, UI Info Suite, Upgrade Empty Cabins, Variable Grass, Wallpaper Recycler, Warp Binder, Water Can Refiller, Water Pet Bowl, Wear More Rings, Weekly Break Reminder, Where's My Items?, Witcher Mod, Yet Another Harvest With Scythe Mod) and other (Time Before Harvest) and workarounds (Harvest With Scythe, Reusable Wallpapers and Floors, Scythe Harvesting)
Line 4,894: Line 4,894:
   |status  = workaround
   |status  = workaround
   |summary  = use [[#Yet Another Harvest With Scythe Mod|Yet Another Harvest With Scythe Mod]] instead.
   |summary  = use [[#Yet Another Harvest With Scythe Mod|Yet Another Harvest With Scythe Mod]] instead.
  |beta status = broken<!--@retest-after Yet Another Harvest With Scythe Mod-->
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 8,649: Line 8,651:
   |status  = workaround
   |status  = workaround
   |summary  = use [[#Wallpaper Recycler|Wallpaper Recycler]] instead.
   |summary  = use [[#Wallpaper Recycler|Wallpaper Recycler]] instead.
  |beta status = broken<!--@retest-after Wallpaper Recycler-->
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 8,828: Line 8,832:
   |status  = workaround
   |status  = workaround
   |summary  = use [[#Yet Another Harvest With Scythe Mod|Yet Another Harvest With Scythe Mod]] instead.
   |summary  = use [[#Yet Another Harvest With Scythe Mod|Yet Another Harvest With Scythe Mod]] instead.
  |beta status = broken<!--@retest-after Yet Another Harvest With Scythe Mod-->
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 10,451: Line 10,457:
   |nexus id = 5764
   |nexus id = 5764
   |github  =  
   |github  =  
  |status  = broken<!--implemented a SMAPI API interface and broke when new functionality was added to SMAPI-->
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 10,733: Line 10,741:
   |nexus id = 2159
   |nexus id = 2159
   |github  = TyoAtrosa/TreeShaker
   |github  = TyoAtrosa/TreeShaker
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 10,741: Line 10,751:
   |github  = bcmpinc/StardewHack
   |github  = bcmpinc/StardewHack


   |beta broke in = Stardew Valley 1.5.5
   |beta broke in = Stardew Valley 1.5.5<!--@retest-after Stardew Hack-->
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 10,751: Line 10,761:
   |chucklefish id = 5485
   |chucklefish id = 5485
   |github  = LeonBlade/TreeTransplant
   |github  = LeonBlade/TreeTransplant
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 10,765: Line 10,777:
   |nexus id = 8115
   |nexus id = 8115
   |github  =  
   |github  =  
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 10,812: Line 10,826:
   |github  = cdaragorn/Ui-Info-Suite
   |github  = cdaragorn/Ui-Info-Suite
   |warnings = Broken on Android.
   |warnings = Broken on Android.
  |beta broke in = Stardew Valley 1.5.5<!--@retest-linked-->
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 10,823: Line 10,839:
   |status  = workaround
   |status  = workaround
   |summary  = use [[#Ui Info Suite|Ui Info Suite]] instead.
   |summary  = use [[#Ui Info Suite|Ui Info Suite]] instead.
  |beta status = broken<!--@retest-after UI Info Suite-->
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 10,929: Line 10,947:
   |moddrop id = 720987
   |moddrop id = 720987
   |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 10,972: Line 10,992:
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/page-77#post-3343789
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/page-77#post-3343789
   |pull request      = https://github.com/dantheman999301/StardewMods/pull/2
   |pull request      = https://github.com/dantheman999301/StardewMods/pull/2
  |beta status = broken
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 11,065: Line 11,087:
   |moddrop id = 661354
   |moddrop id = 661354
   |github  = Mizzion/MyStardewMods
   |github  = Mizzion/MyStardewMods
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 11,079: Line 11,103:
   |nexus id = 6892
   |nexus id = 6892
   |github  =
   |github  =
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 11,152: Line 11,178:
   |moddrop id = 661368
   |moddrop id = 661368
   |github  = Mizzion/MyStardewMods
   |github  = Mizzion/MyStardewMods
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 11,169: Line 11,197:
   |moddrop id = 661365
   |moddrop id = 661365
   |github  = Mizzion/MyStardewMods
   |github  = Mizzion/MyStardewMods
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 11,205: Line 11,235:
   |github  = bcmpinc/StardewHack
   |github  = bcmpinc/StardewHack
   |warnings = Broken on Android.
   |warnings = Broken on Android.
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 11,242: Line 11,274:
   |nexus id = 8194
   |nexus id = 8194
   |github  =
   |github  =
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 11,276: Line 11,310:
   |nexus id = 2086
   |nexus id = 2086
   |github  =  
   |github  =  
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 11,319: Line 11,355:
   |nexus id = 5797
   |nexus id = 5797
   |github  = aedenthorn/StardewValleyMods
   |github  = aedenthorn/StardewValleyMods
  |beta broke in = Stardew Valley 1.5.5
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry
Line 11,385: Line 11,423:
   |author  = bcmpinc
   |author  = bcmpinc
   |github  = bcmpinc/StardewHack
   |github  = bcmpinc/StardewHack
  |beta broke in = Stardew Valley 1.5.5<!--@retest-linked, @retest-after Stardew Hack-->
}}
}}
{{#invoke:SMAPI compatibility|entry
{{#invoke:SMAPI compatibility|entry

Revision as of 23:42, 29 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=107011"