Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎C# mods: update unofficial version for Enemy Health Bars)
(Add unofficial version of Expert Sitting)
 
(22 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 
{{modding player guide header}}
 
{{modding player guide header}}
[[File:SMAPI compatibility.png|thumb|SMAPI mod compatibility, July 2017 to March 2021. See [[:File:SMAPI compatibility.png#Notable events|notable events which affect this chart]].<br />
+
[[File:SMAPI compatibility.png|thumb|SMAPI mod compatibility, July 2017 to June 2024. See [[:File:SMAPI compatibility.png#Notable events|notable events which affect this chart]].<br />
 
<span style="background: #cc0000;">&emsp;</span> broken (proprietary)<br />
 
<span style="background: #cc0000;">&emsp;</span> broken (proprietary)<br />
 
<span style="background: #e69138;">&emsp;</span> broken (open-source)<br />
 
<span style="background: #e69138;">&emsp;</span> broken (open-source)<br />
Line 7: Line 7:
 
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.
 
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.
  
 +
==Instructions==
 +
===For players===
 +
'''See [https://smapi.io/mods smapi.io/mods] for a more user-friendly view of this page.'''
  
 +
To update your mods:
 +
# For each mod you have installed, follow the instructions in the list below. If it's not listed, try updating to its latest version.
 +
# If a mod is still failing, post a message in the [https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/ coordination thread] (with [[Modding:Player Guide/Troubleshooting#The basics|your SMAPI log]] attached) and we'll help.
  
'''Players: see [https://smapi.io/mods smapi.io/mods] for a more user-friendly view of this page.'''
+
===For mod authors===
 +
Feel free to update the lists below! See [[Modding:Mod compatibility/entry#Usage|instructions for editing the template]].
  
==For players==
+
Notes for the mod status:
===What to do===
+
* Only mark a mod <samp>abandoned</samp> or <samp>obsolete</samp> if (a) the mod author has explicitly abandoned the mod, or (b) they've hidden or deleted the mod page, or (c) it's been superseded by an equivalent game feature. A mod is not considered abandoned just because it hasn't been updated for a while.
# For each mod you have installed, follow the instructions in the list below. If it's not listed, try updating to its latest version.
+
* Only mark a mod <samp>broken</samp> if it's ''incompatible''. This isn't the place to track general mod bugs, unless they impact compatibility. In rare cases where a non-compatibility bug is severe enough to note here (e.g. game crashes on some platforms), you can use the <samp>warnings</samp> field.
# If a mod is still failing, post a message in the [https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/ coordination thread] (with [[Modding:Player Guide/Troubleshooting#The basics|your SMAPI log]] attached) and we'll help.
 
  
 +
==Compatibility list==
 
===C# mods===
 
===C# mods===
 +
This includes every known C# SMAPI mod. It's updated for new/updated mods on CurseForge/ModDrop/Nexus periodically with the help of {{github|Pathoschild/StardewScripts/tree/main/mod-dump|semi-automated scripts}}, but feel free to make corrections as needed!
 +
 
<!--
 
<!--
  
Line 24: Line 33:
  
 
-->
 
-->
* '''Players:''' See [https://smapi.io/mods smapi.io/mods] for a more user-friendly list.
 
* '''Modders:''' feel free to update this list! (See [[Modding:Mod compatibility/entry#Usage|instructions]].) Note that only SMAPI mods should be listed, not [[Modding:Using XNB mods|XNB mods]] or content packs.
 
 
 
{{#invoke:SMAPI compatibility|header}}
 
{{#invoke:SMAPI compatibility|header}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 627: Line 633:
 
   |name    = Always On Server for Multiplayer
 
   |name    = Always On Server for Multiplayer
 
   |author  = funny-snek and Zuberii
 
   |author  = funny-snek and Zuberii
   |id      = funny-snek.Always_On_Server
+
   |id      = mikko.Always_On_Server<!--changed in 1.20.3-unofficial.2-->, funny-snek.Always_On_Server
 
   |nexus  = 2677
 
   |nexus  = 2677
 
   |github  = funny-snek/Always-On-Server-for-Multiplayer
 
   |github  = funny-snek/Always-On-Server-for-Multiplayer
Line 1,857: Line 1,863:
  
 
   |broke in          = Stardew Valley 1.6
 
   |broke in          = Stardew Valley 1.6
   |unofficial version = 0.2.1-unofficial.1-mouahrara
+
   |unofficial version = 0.2.1-unofficial.3-mouahrara
 
   |unofficial url    = {{github|mouahrara/aedenthorn}}#BeePaths
 
   |unofficial url    = {{github|mouahrara/aedenthorn}}#BeePaths
 
}}
 
}}
Line 2,445: Line 2,451:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
  |unofficial version = 1.0.8-unofficial.1-Sandman53
 +
  |unofficial url    = {{github|Sandman534/StardewValleyMods/releases/tag/release}}
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 2,918: Line 2,926:
  
 
   |broke in          = Stardew Valley 1.6
 
   |broke in          = Stardew Valley 1.6
   |unofficial version = 0.6.1-unofficial.3-mouahrara
+
   |unofficial version = 0.6.1-unofficial.5-mouahrara
 
   |unofficial url    = {{github|mouahrara/aedenthorn}}#BuffFramework
 
   |unofficial url    = {{github|mouahrara/aedenthorn}}#BuffFramework
 
}}
 
}}
Line 3,775: Line 3,783:
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 
   |status  = abandoned
 
   |status  = abandoned
   |summary  = remove this mod (no longer maintained; use [[#Never Ending Adventure - NPC Mateo|Never Ending Adventure - NPC Mateo]] instead).
+
   |summary  = remove this mod (no longer maintained; use [[#Never Ending Adventure and Circle of Thorns|Never Ending Adventure and Circle of Thorns]] instead).
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 4,520: Line 4,528:
 
   |name    = Craftable Terrarium, Terrarium
 
   |name    = Craftable Terrarium, Terrarium
 
   |author  = aedenthorn, Erinthe
 
   |author  = aedenthorn, Erinthe
   |id      = aedenthorn.Terrarium
+
   |id      = aedenthorn.CraftableTerrarium<!--changed in 0.1.3-unofficial.1-->, aedenthorn.Terrarium
 
   |nexus  = 8031
 
   |nexus  = 8031
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
  
   |broke in = Stardew Valley 1.6
+
   |broke in           = Stardew Valley 1.6
 +
  |unofficial version = 0.1.3-unofficial.1-mouahrara
 +
  |unofficial url    = {{github|mouahrara/aedenthorn}}#CraftableTerrarium
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 4,795: Line 4,805:
 
   |nexus  = 2594
 
   |nexus  = 2594
 
   |github  = Digus/StardewValleyMods
 
   |github  = Digus/StardewValleyMods
 
  |broke in = Stardew Valley 1.6
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 6,020: Line 6,028:
 
   |moddrop = 624395
 
   |moddrop = 624395
 
   |github  = MissCoriel/Dear-Diary
 
   |github  = MissCoriel/Dear-Diary
 
  |broke in = Stardew Valley 1.6
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 6,623: Line 6,629:
 
   |nexus  = 9684
 
   |nexus  = 9684
 
   |github  = AHilyard/DwarvishMattock
 
   |github  = AHilyard/DwarvishMattock
 
  |broke in = Stardew Valley 1.6
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 7,543: Line 7,547:
 
   |nexus  = 7435
 
   |nexus  = 7435
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
 +
 +
  |broke in          = SMAPI 4.0.8
 +
  |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/page-216#post-130566
 +
  |unofficial version = 0.6.8
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 8,136: Line 8,144:
 
   |nexus  = 7413
 
   |nexus  = 7413
 
   |github  =
 
   |github  =
 +
 +
  |broke in = Stardew Valley 1.6.4
 +
  |status  = broken
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 8,207: Line 8,218:
  
 
   |status  = abandoned
 
   |status  = abandoned
  |summary = remove this mod (merged into [[#Modular Gameplay Overhaul|Modular Gameplay Overhaul]]).
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 8,463: Line 8,473:
  
 
   |broke in          = Stardew Valley 1.6<!--@retest-after Advanced Loot Framework-->
 
   |broke in          = Stardew Valley 1.6<!--@retest-after Advanced Loot Framework-->
   |unofficial version = 0.4.3-unofficial.1-mouahrara
+
   |unofficial version = 0.4.3-unofficial.2-mouahrara
 
   |unofficial url    = {{github|mouahrara/aedenthorn}}#FishingChestsExpanded
 
   |unofficial url    = {{github|mouahrara/aedenthorn}}#FishingChestsExpanded
 
}}
 
}}
Line 8,549: Line 8,559:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
}}
 
{{#invoke:SMAPI compatibility|entry
 
  |name    = Fishing Rod Recolor, Grandpa's Tools
 
  |author  = Stashek
 
  |id      = Stashek.FishingRodRecolor
 
  |nexus  = 8835
 
  |github  =
 
 
  |broke in = SMAPI 4.0.8
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 8,947: Line 8,948:
 
   |nexus  = 17126
 
   |nexus  = 17126
 
   |github  = Enteligenz/StardewMods
 
   |github  = Enteligenz/StardewMods
 
  |broke in = Stardew Valley 1.6<!--@retest-after Quest Framework-->
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 10,413: Line 10,412:
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
  
   |broke in = Stardew Valley 1.6
+
   |broke in           = Stardew Valley 1.6
 +
  |unofficial version = 0.4.1-unofficial.1-mouahrara
 +
  |unofficial url    = {{github|mouahrara/aedenthorn}}#HereFishy
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 10,725: Line 10,726:
 
   |nexus  = 9052
 
   |nexus  = 9052
 
   |github  =
 
   |github  =
 
  |broke in = Stardew Valley 1.6
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 11,590: Line 11,589:
  
 
   |broke in          = Stardew Valley 1.6
 
   |broke in          = Stardew Valley 1.6
   |unofficial version = 1.5.0-unofficial.ALPHA6-Hackswell
+
   |unofficial version = 1.5.0-unofficial.7-Hackswell
 
   |unofficial url    = {{github|Hackswell/JoysOfEfficiency}}/releases
 
   |unofficial url    = {{github|Hackswell/JoysOfEfficiency}}/releases
 
}}
 
}}
Line 12,348: Line 12,347:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
  |status  = workaround
 +
  |summary  = use [[#Longer Seasons - Continued|Longer Seasons - Continued]] instead.
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Longer Seasons - Continued
 +
  |author  = aedenthorn and FlyingTNT
 +
  |id      = FlyingTNT.LongerSeasons
 +
  |nexus  = 25164
 +
  |github  = FlyingTNT/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 13,046: Line 13,054:
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
   |name    = Miss Coriel's Unique Courtship Response Core
+
   |name    = Miss Coriel's Unique Courtship Response Core, Unique Response Core
 
   |author  = MissCoriel
 
   |author  = MissCoriel
 
   |id      = misscoriel.UCRFix
 
   |id      = misscoriel.UCRFix
Line 13,182: Line 13,190:
 
   |name    = Modify This
 
   |name    = Modify This
 
   |author  = aedenthorn, Erinthe
 
   |author  = aedenthorn, Erinthe
   |id      = aedenthorn.ModThis
+
   |id      = aedenthorn.ModifyThis<!--changed in 0.9.1-unofficial.1-->, aedenthorn.ModThis
 
   |nexus  = 7814
 
   |nexus  = 7814
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
  
   |broke in = Stardew Valley 1.6
+
   |broke in           = Stardew Valley 1.6
 +
  |unofficial version = 0.9.1-unofficial.1-mouahrara
 +
  |unofficial url    = {{github|mouahrara/aedenthorn}}#ModifyThis
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 13,219: Line 13,229:
 
   |author  = DaLion
 
   |author  = DaLion
 
   |id      = DaLion.Overhaul
 
   |id      = DaLion.Overhaul
   |nexus  =
+
   |nexus  = 14470
   |github  = daleao/modular-overhaul
+
   |github  =
  
 +
  |status  = abandoned
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 
}}
 
}}
Line 13,777: Line 13,788:
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
  
   |broke in = Stardew Valley 1.6
+
   |broke in           = Stardew Valley 1.6
 +
  |unofficial version = 0.2.1-unofficial.2-mouahrara
 +
  |unofficial url    = {{github|mouahrara/aedenthorn}}#MoveableMailbox
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 14,345: Line 14,358:
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
   |name    = Never Ending Adventure - NPC Mateo<!--Nexus-->, Never Ending Adventure - Code<!--manifest-->
+
   |name    = Never Ending Adventure and Circle of Thorns<!--Nexus-->, NEA & COT<!--manifest changed cira 1.10.0-->, Never Ending Adventure - Code<!--manifest before 1.10.0-->
 
   |author  = DestyNova
 
   |author  = DestyNova
   |id      = DestyNova.NEACode
+
   |id      = KCC.SnS<!--changed circa 1.10.0-->, DestyNova.NEACode
 
   |nexus  = 12369
 
   |nexus  = 12369
 
   |github  =
 
   |github  =
Line 15,580: Line 15,593:
 
   |nexus  = 5326
 
   |nexus  = 5326
 
   |github  = strobel1ght/Personal-Anvil
 
   |github  = strobel1ght/Personal-Anvil
 
  |broke in = Stardew Valley 1.6
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 16,035: Line 16,046:
 
   |nexus  = 12065
 
   |nexus  = 12065
 
   |github  =
 
   |github  =
 
  |broke in = Stardew Valley 1.6
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 16,764: Line 16,773:
  
 
   |status  = abandoned
 
   |status  = abandoned
  |summary = remove this mod (merged into [[#Modular Gameplay Overhaul|Modular Gameplay Overhaul]]).
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 18,875: Line 18,883:
 
   |nexus  =
 
   |nexus  =
 
   |github  = Enaium-StardewValleyMods/SimpleHUD
 
   |github  = Enaium-StardewValleyMods/SimpleHUD
 +
 +
  |broke in = Stardew Valley 1.6
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 19,555: Line 19,565:
 
   |nexus  = 12311
 
   |nexus  = 12311
 
   |github  = Floogen/SolidFoundations
 
   |github  = Floogen/SolidFoundations
 +
 +
  |broke in = Solid Foundations 2.0.2?
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 21,783: Line 21,795:
  
 
   |status  = abandoned
 
   |status  = abandoned
  |summary = remove this mod (merged into [[#Modular Gameplay Overhaul|Modular Gameplay Overhaul]]).
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 22,190: Line 22,201:
 
   |github  =
 
   |github  =
  
 +
  |status  = abandoned
 
   |broke in = SMAPI 3.0
 
   |broke in = SMAPI 3.0
 
}}
 
}}
Line 22,869: Line 22,881:
 
   |nexus  = 2374
 
   |nexus  = 2374
 
   |github  = Digus/StardewValleyMods
 
   |github  = Digus/StardewValleyMods
 
  |broke in = Stardew Valley 1.6
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 22,949: Line 22,959:
 
   |name    = Weather Totem
 
   |name    = Weather Totem
 
   |author  = aedenthorn, Erinthe
 
   |author  = aedenthorn, Erinthe
   |id      = aedenthorn.WeatherTotems
+
   |id      = aedenthorn.WeatherTotem<!--changed in 0.1.1-unofficial.1-->, aedenthorn.WeatherTotems
 
   |nexus  = 16455
 
   |nexus  = 16455
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
  
   |broke in = Stardew Valley 1.6
+
   |broke in           = Stardew Valley 1.6
 +
  |unofficial version = 0.1.1-unofficial.1-mouahrara
 +
  |unofficial url    = {{github|mouahrara/aedenthorn}}#WeatherTotem
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 23,311: Line 23,323:
 
   |nexus  = 8196
 
   |nexus  = 8196
 
   |github  = vincebel7/YearRoundCrops
 
   |github  = vincebel7/YearRoundCrops
 
  |broke in = Stardew Valley 1.6
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 23,667: Line 23,677:
 
===XNB mods===
 
===XNB mods===
 
See [[Modding:Using XNB mods]].
 
See [[Modding:Using XNB mods]].
 +
<!--
 +
 +
Do not list XNB mods here.
 +
 +
-->
  
 
==Mod data overrides==
 
==Mod data overrides==

Latest revision as of 14:00, 17 June 2024

SMAPI mod compatibility, July 2017 to June 2024. 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.

Instructions

For players

See smapi.io/mods for a more user-friendly view of this page.

To update your mods:

  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.

For mod authors

Feel free to update the lists below! See instructions for editing the template.

Notes for the mod status:

  • Only mark a mod abandoned or obsolete if (a) the mod author has explicitly abandoned the mod, or (b) they've hidden or deleted the mod page, or (c) it's been superseded by an equivalent game feature. A mod is not considered abandoned just because it hasn't been updated for a while.
  • Only mark a mod broken if it's incompatible. This isn't the place to track general mod bugs, unless they impact compatibility. In rare cases where a non-compatibility bug is severe enough to note here (e.g. game crashes on some platforms), you can use the warnings field.

Compatibility list

C# mods

This includes every known C# SMAPI mod. It's updated for new/updated mods on CurseForge/ModDrop/Nexus periodically with the help of semi-automated scripts, but feel free to make corrections as needed!

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