Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(Add Seed Information - Continued)
(added workaround for Always On Server for Multiplayer, Joys of Efficiency and added 2nd workaround for Adventurer's Guild)
(11 intermediate revisions by 5 users not shown)
Line 342: Line 342:
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
   |name    = Adventurer's Guild Expanded (CP)
+
   |name    = Adventurer's Guild Expanded
 
   |author  = SUPERT
 
   |author  = SUPERT
 
   |id      = supert.adventureguildexpanded
 
   |id      = supert.adventureguildexpanded
Line 351: Line 351:
  
 
   |unofficial version = 1.1.0-unofficial.2-femtohound
 
   |unofficial version = 1.1.0-unofficial.2-femtohound
   |summary = Community-patched version [https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/page-200#post-126783 here]. Unstable. Use at your own risk.
+
   |summary = either use [[#Adventurer's Guild Expanded - Unofficial Update for 1.6|Adventurer's Guild Expanded - Unofficial Update for 1.6]] or the Community-patched version Community-patched version [https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/page-200#post-126783 here]. Unstable. Use at your own risk.
 
}}
 
}}
 +
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
   |name   = Adventurer's Guild Expanded (JA)
+
   |name     = Adventurer's Guild Expanded - Unofficial Update for 1.6
   |author = SUPERT
+
   |author   = underanesthesia
   |id     = supert.guildexpandedja
+
   |id       = supert.adventureguildexpanded
   |nexus   = 12102
+
   |nexus   = 22591
  |github  =
 
 
 
  |broke in = Stardew Valley 1.6
 
 
 
  |unofficial version = 1.1.0-unofficial.2-femtohound
 
  |summary  = Community-patched version [https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/page-200#post-126783 here]. Unstable. Use at your own risk.
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 531: Line 526:
  
 
   |broke in = Stardew Valley 1.4
 
   |broke in = Stardew Valley 1.4
<!--
+
   |unofficial version = 1.20.3
   |unofficial version = 1.20.2-unofficial.2-elizo
+
   |unofficial url    = {{github|perkmi/Always-On-Server-for-Multiplayer}}
   |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/page-47#post-29677
 
-->
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 4,599: Line 4,592:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Cuter slimes
 +
  |author  = Amaryn
 +
  |id      = Amaryn.CuterSlimes
 +
  |nexus  = 6073
 +
 +
  |broke in = Stardew Valley 1.6
 +
  |status  = workaround
 +
  |summary  = use [[#Cuter slimes refreshed|Cuter slimes refreshed]] instead.
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Cuter slimes refreshed
 +
  |author  = Amaryn & JennaJuffuffles
 +
  |id      = jennajuffuffles.cuterslimesrefreshed
 +
  |nexus  = 21889
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 9,351: Line 9,360:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
  |unofficial version = 1.5.0-unofficial.3-Hackswell
 +
  |unofficial url    = {{github|Hackswell/JoysOfEfficiency}}
 
}}
 
}}
 +
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Json Assets
 
   |name    = Json Assets
Line 13,590: Line 13,602:
 
   |github  = Traktori7/StardewValleyMods
 
   |github  = Traktori7/StardewValleyMods
  
   |broke in = Stardew Valley 1.6<!--@retest-linked-->
+
   |broke in = Stardew Valley 1.6
 +
  |status  = workaround
 +
  |summary  = use [[#Quality Conversion Engine|Quality Conversion Engine]] instead.
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 13,600: Line 13,614:
  
 
   |broke in = Stardew Valley 1.6<!--@retest-after Quality Scrubber-->
 
   |broke in = Stardew Valley 1.6<!--@retest-after Quality Scrubber-->
 +
  |status  = workaround
 +
  |summary  = use [[#Quality Conversion Engine|Quality Conversion Engine]] instead.
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 13,607: Line 13,623:
 
   |nexus  = 7907
 
   |nexus  = 7907
 
   |github  = jn84/QualitySmash
 
   |github  = jn84/QualitySmash
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Quality Conversion Engine
 +
  |author  = WoosterUK
 +
  |id      = Wooster.CP.QualityConversionEngine
 +
  |nexus  = 20624
 +
  |gitlab  = stardew_valley/quality_conversion_engine
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 13,827: Line 13,850:
 
   |nexus  = 18850
 
   |nexus  = 18850
 
   |github  =
 
   |github  =
 
  |broke in = Stardew Valley 1.6
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 13,971: Line 13,992:
 
   |id      = thimadera.Realclock
 
   |id      = thimadera.Realclock
 
   |nexus  = 21726
 
   |nexus  = 21726
   |github  = thimadera/StardewMods/tree/master/RealClock
+
   |github  = thimadera/StardewMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 14,361: Line 14,382:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
  |status  = workaround
 +
  |summary  = use [[#Resource Storage - Continued|Resource Storage - Continued]] instead.
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Resource Storage - Continued
 +
  |author  = aedenthorn and FlyingTNT
 +
  |id      = FlyingTNT.ResourceStorage
 +
  |nexus  = 22539
 +
  |github  = FlyingTNT/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 15,777: Line 15,807:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
  |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/page-150#post-122362
 +
  |unofficial version = 1.3.4-unofficial.1-LikeFrogs
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 15,952: Line 15,984:
 
   |author  = PeacefulEnd
 
   |author  = PeacefulEnd
 
   |id      = PeacefulEnd.SolidFoundationsAutomate
 
   |id      = PeacefulEnd.SolidFoundationsAutomate
   |nexus  = 12311
+
   |nexus  = 12311@Automate
 
   |github  = Floogen/SolidFoundations
 
   |github  = Floogen/SolidFoundations
 
}}
 
}}
Line 16,346: Line 16,378:
 
   |broke in = Stardew Valley 1.5
 
   |broke in = Stardew Valley 1.5
 
   |status  = workaround
 
   |status  = workaround
   |summary  = use [[#Stack Everything Redux|Stack Everything Redux]] instead.
+
   |summary  = use [[#Stack Everything Redux|thimadera's Stack Everything Redux]] instead.
 
<!--
 
<!--
 
   |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/post-41713
 
   |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/post-41713
Line 16,375: Line 16,407:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
  |status  = workaround
 +
  |summary  = use [[#Stack Everything Redux|thimadera's Stack Everything Redux]] instead.
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 17,406: Line 17,440:
 
   |nexus  = 20796
 
   |nexus  = 20796
 
   |github  = lucaskfreitas/ImmersiveSprinklers
 
   |github  = lucaskfreitas/ImmersiveSprinklers
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Immersive Spouses
 +
  |author  = someguy363
 +
  |id      = iss.immersivespouses
 +
  |nexus  = 5117
 +
  |broke in = Stardew Valley 1.6
 +
  |status  = workaround
 +
  |summary  = use [[#Immersive Spouses 1.6|Immersive Spouses 1.6]] instead.
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Immersive Spouses 1.6
 +
  |author  = SuperMonkey1308
 +
  |id      = iss.immersivespouses
 +
  |nexus  = 22538
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry

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