Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
Line 4,095: Line 4,095:
 
   |summary  = <s>use [https://nexusmods.com/stardewvalley/mods/1597 Mood Guard] instead</s>.
 
   |summary  = <s>use [https://nexusmods.com/stardewvalley/mods/1597 Mood Guard] instead</s>.
 
   |broke in = SMAPI 2.0
 
   |broke in = SMAPI 2.0
 +
}}
 +
{{/entry
 +
  |name    = Happy Birthday
 +
  |author  = Omegasis
 +
  |author2  = Alpha_Omegasis
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/520
 +
  |source  = https://github.com/janavarro95/Stardew_Valley_Mods
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Happy Birthday
 +
  |author  = Oxyligen
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1064
 +
  |source  =
 +
  |status  = broken
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Hardcore Mines
 +
  |author  = kibbe
 +
  |author2  = lillvik
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1674
 +
  |source  = https://github.com/chaos234/StardewValleyMods
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Harp of Yoba Redux
 +
  |author  = Platonymous
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/914
 +
  |source  = https://github.com/Platonymous/Stardew-Valley-Mods
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Harvest Moon Witch Princess Mod
 +
  |name2    = WitchPrincess
 +
  |author  = Dounat2201
 +
  |author2  = Sasara
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1157
 +
  |source  = https://github.com/Sasara2201/WitchPrincess
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,105: Line 4,154:
 
   |broke in = SMAPI 2.0
 
   |broke in = SMAPI 2.0
 
}}
 
}}
 
+
{{/entry
 +
  |name    = Health Bars
 +
  |author  = Zoryn
 +
  |url      = https://github.com/Zoryn4163/SMAPI-Mods/releases
 +
  |source  = https://github.com/Zoryn4163/SMAPI-Mods
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Hold to Break Geodes
 +
  |author  = CatCattyCat
 +
  |author2  = Cat
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1689
 +
  |source  = https://github.com/danvolchek/StardewMods
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Horse Whistle
 +
  |author  = icepuente
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1131
 +
  |source  = https://github.com/icepuente/StardewValleyMods
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Horse Whistle
 +
  |author  = nabuma
 +
  |url      = https://community.playstarbound.com/threads/calling-horse-with-key-press.111550
 +
  |source  =
 +
  |status  = broken
 +
  |summary  = <s>use [[#Horse Whistle|Horse Whistle by icepuente]].</s>
 +
  |broke in = SMAPI 2.0
 +
}}
 +
{{/entry
 +
  |name    = HP Bars
 +
  |author  = Ilyaki
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1736
 +
  |source  =
 +
  |status  = broken
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Hunger
 +
  |author  = Yyeahdude
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/613
 +
  |source  =
 +
}}
 
{{/entry
 
{{/entry
 
   |name    = Hunger for food
 
   |name    = Hunger for food
Line 4,115: Line 4,215:
 
   |summary  =  
 
   |summary  =  
 
   |broke in = SMAPI 2.0
 
   |broke in = SMAPI 2.0
 +
}}
 +
{{/entry
 +
  |name    = HungerMod
 +
  |author  = skn
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1127
 +
  |source  =
 +
  |status  = broken
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = IdlePause
 +
  |author  = Veleek
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1092
 +
  |source  = https://github.com/veleek/IdlePause
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Improved Mill
 +
  |author  = AustinYQM
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1748
 +
  |source  = https://github.com/AustinYQM/ImprovedMill
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Improved Quality of Life
 +
  |author  = Demiacle
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1025
 +
  |source  = https://github.com/demiacle/QualityOfLifeMods
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Instant Fishing
 +
  |author  = aurnj
 +
  |author2  = Roy Li
 +
  |url      = https://community.playstarbound.com/threads/instant-fishing-mod.129163
 +
  |source  =
 +
  |status  = broken
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,124: Line 4,270:
 
   |summary  = <s>use [https://www.nexusmods.com/stardewvalley/mods/1089 Fast Animations] instead</s>.
 
   |summary  = <s>use [https://www.nexusmods.com/stardewvalley/mods/1089 Fast Animations] instead</s>.
 
   |broke in = Stardew Valley 1.1
 
   |broke in = Stardew Valley 1.1
 +
}}
 +
{{/entry
 +
  |name    = Instant Grow Trees
 +
  |author  = cantorsdust & community
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/173
 +
  |source  = https://github.com/cantorsdust/StardewMods
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Interaction Helper
 +
  |author  = Hammurabi
 +
  |url      = https://community.playstarbound.com/resources/interaction-helper.4640
 +
  |source  = https://community.playstarbound.com/resources/interaction-helper.4640/updates
 +
  |status  = soon
 +
  |summary  =
 +
  |link    = https://community.playstarbound.com/threads/interaction-helper.131830/#post-3225129
 +
  |broke in = SMAPI 2.0
 +
}}
 +
{{/entry
 +
  |name    = Jiggly Junimo Bundles
 +
  |author  = Jonas Henriksson
 +
  |author2  = Greger
 +
  |url      = https://community.playstarbound.com/threads/smapi-0-39-2-jiggly-junimo-bundles.111789/
 +
  |source  = https://github.com/gr3ger/Stardew_JJB
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Jump Over
 +
  |author  = spacechase0
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1844
 +
  |source  = https://github.com/spacechase0/JumpOver
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Junimo Farm
 +
  |author  = Platonymous
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/984
 +
  |source  = https://github.com/Platonymous/Stardew-Valley-Mods
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Kamikaze
 +
  |author  = aurnj
 +
  |author2  = Roy Li
 +
  |url      = https://community.playstarbound.com/threads/kamikaze-mod.129126
 +
  |source  =
 +
  |status  = broken
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,135: Line 4,338:
 
   |broke in = SMAPI 2.0
 
   |broke in = SMAPI 2.0
 
}}
 
}}
 
 
{{/entry
 
{{/entry
 
   |name    = Mail Framework
 
   |name    = Mail Framework
Line 4,575: Line 4,777:
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/673
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/673
 
   |source  =  
 
   |source  =  
}}
 
<!--
 
 
 
 
-->
 
 
 
{{/entry
 
  |name    = Happy Birthday
 
  |author  = Omegasis
 
  |author2  = Alpha_Omegasis
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/520
 
  |source  = https://github.com/janavarro95/Stardew_Valley_Mods
 
}}
 
{{/entry
 
  |name    = Happy Birthday
 
  |author  = Oxyligen
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1064
 
  |source  =
 
}}
 
{{/entry
 
  |name    = Hardcore Mines
 
  |author  = kibbe
 
  |author2  = lillvik
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1674
 
  |source  = https://github.com/chaos234/StardewValleyMods
 
}}
 
{{/entry
 
  |name    = Harp of Yoba Redux
 
  |author  = Platonymous
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/914
 
  |source  = https://github.com/Platonymous/Stardew-Valley-Mods/
 
}}
 
{{/entry
 
  |name    = Harvest Moon Witch Princess Mod
 
  |name2    = WitchPrincess
 
  |author  = Dounat2201
 
  |author2  = Sasara
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1157
 
  |source  = https://github.com/Sasara2201/WitchPrincess
 
}}
 
{{/entry
 
  |name    = Health Bars
 
  |author  = Zoryn
 
  |url      = https://github.com/Zoryn4163/SMAPI-Mods/releases
 
  |source  = https://github.com/Zoryn4163/SMAPI-Mods
 
}}
 
{{/entry
 
  |name    = Hold to Break Geodes
 
  |author  = CatCattyCat
 
  |author2  = Cat
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1689
 
  |source  = https://github.com/danvolchek/StardewMods
 
}}
 
{{/entry
 
  |name    = Horse Whistle
 
  |author  = icepuente
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1131
 
  |source  = https://github.com/icepuente/StardewValleyMods
 
}}
 
{{/entry
 
  |name    = Horse Whistle
 
  |author  = nabuma
 
  |url      = https://community.playstarbound.com/threads/calling-horse-with-key-press.111550
 
  |source  =
 
  |status  = workaround
 
  |summary  = use [[#Horse Whistle|Horse Whistle by icepuente]].
 
  |broke in = SMAPI 2.0
 
}}
 
{{/entry
 
  |name    = HP Bars
 
  |author  = Ilyaki
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1736
 
  |source  =
 
}}
 
{{/entry
 
  |name    = Hunger
 
  |author  = Yyeahdude
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/613
 
  |source  =
 
}}
 
{{/entry
 
  |name    = HungerMod
 
  |author  = skn
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1127
 
  |source  =
 
}}
 
{{/entry
 
  |name    = IdlePause
 
  |author  = Veleek
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1092
 
  |source  = https://github.com/veleek/IdlePause
 
}}
 
{{/entry
 
  |name    = Improved Mill
 
  |author  = AustinYQM
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1748
 
  |source  = https://github.com/AustinYQM/ImprovedMill
 
}}
 
{{/entry
 
  |name    = Improved Quality of Life
 
  |author  = Demiacle
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1025
 
  |source  = https://github.com/demiacle/QualityOfLifeMods
 
}}
 
{{/entry
 
  |name    = Instant Fishing
 
  |author  = aurnj
 
  |author2  = Roy Li
 
  |url      = https://community.playstarbound.com/threads/instant-fishing-mod.129163
 
  |source  =
 
}}
 
{{/entry
 
  |name    = Instant Grow Trees
 
  |author  = cantorsdust & community
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/173
 
  |source  = https://github.com/cantorsdust/StardewMods
 
}}
 
{{/entry
 
  |name    = Interaction Helper
 
  |author  = Hammurabi
 
  |url      = https://community.playstarbound.com/resources/interaction-helper.4640
 
  |source  = https://community.playstarbound.com/resources/interaction-helper.4640/updates
 
  |status  = workaround
 
  |summary  = use [https://community.playstarbound.com/attachments/interactionhelper-1-0-4-pathoschild-update-zip.191198 unofficial update] (<small>1.0.4-pathoschild-update</small>).
 
  |link    = https://community.playstarbound.com/threads/interaction-helper.131830/#post-3225129
 
  |broke in = SMAPI 2.0
 
 
}}
 
}}
 
{{/entry
 
{{/entry
 
   |name    = Item Auto Stacker
 
   |name    = Item Auto Stacker
 +
  |name2    = Auto Stacker
 
   |author  = CatCattyCat
 
   |author  = CatCattyCat
 
   |author2  = Cat
 
   |author2  = Cat
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/1184
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/1184
 
   |source  = https://github.com/danvolchek/StardewMods
 
   |source  = https://github.com/danvolchek/StardewMods
}}
 
{{/entry
 
  |name    = Jiggly Junimo Bundles
 
  |author  = Jonas Henriksson
 
  |author2  = Greger
 
  |url      = https://community.playstarbound.com/threads/smapi-0-39-2-jiggly-junimo-bundles.111789/
 
  |source  = https://github.com/gr3ger/Stardew_JJB
 
}}
 
{{/entry
 
  |name    = Jump Over
 
  |author  = spacechase0
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1844
 
  |source  = https://github.com/spacechase0/JumpOver
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,730: Line 4,792:
 
   |source  = https://github.com/Zoryn4163/SMAPI-Mods
 
   |source  = https://github.com/Zoryn4163/SMAPI-Mods
 
}}
 
}}
{{/entry
+
<!--
  |name    = Junimo Farm
+
 
  |author  = Platonymous
+
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/984
+
 
  |source  = https://github.com/Platonymous/Stardew-Valley-Mods/
+
 
}}
+
-->
{{/entry
 
  |name    = Kamikaze
 
  |author  = aurnj
 
  |author2  = Roy Li
 
  |url      = https://community.playstarbound.com/threads/kamikaze-mod.129126
 
  |source  =
 
}}
 
 
{{/entry
 
{{/entry
 
   |name    = Level Extender
 
   |name    = Level Extender

Revision as of 02:50, 16 April 2018

Index

SMAPI updates almost never break mods, except when the major version changes (e.g. SMAPI 1.0 and 2.0). This page lists known SMAPI mods and their compatibility with the latest versions of SMAPI and Stardew Valley.

For players (Stardew Valley 1.2)

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 SMAPI 2.0 migration thread (with your SMAPI log attached) and we'll help.

SMAPI mods

Here's a list of mods tested with SMAPI 2.5+ and Stardew Valley 1.2.30+. Content packs aren't listed unless incompatible. It's updated periodically for new mod releases.

  1. This only shows whether a mod is compatible; it may have bugs unrelated to SMAPI compatibility.

For players (Stardew Valley 1.3 beta)

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

Here's a list of mods tested with SMAPI 2.5+ and Stardew Valley 1.2.30+. Content packs aren't listed unless incompatible. It's updated periodically for new mod releases.

This is list doesn't include all known mods yet.

  1. 1.0 1.1 This only shows whether a mod is compatible; it may have bugs unrelated to SMAPI compatibility.

For mod developers

Updating a mod

See how to update deprecated code. 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. Increase the version in manifest.json by 0.0.1-<yourname>-update.
    For example, if the current version is 1.0.0 and your username is SampleUser, you'd change the version to 1.0.1-sampleUser-update. If you need to release new versions of your update, add a number at the end like 1.0.1-sampleUser-update.2, 1.0.1-sampleUser-update.3, etc. This ensures that official versions will supersede unofficial ones (e.g. for update checks).
  4. Push your changes to GitHub.
  5. Post a release package to the SMAPI 2.0 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).

Overall compatibility

Status of known SMAPI mods for Stardew Valley 1.2:

 
94% are compatible or have a working alternative.
 
1% have an update coming soon.
 
6% are broken and not open-source.¹

¹ Many of these broke due to a Stardew Valley update. Some may be updated by their authors later.

Status of known SMAPI mods for Stardew Valley 1.3:
TBD