Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
Line 3,482: Line 3,482:
 
{{/entry
 
{{/entry
 
   |name    = Custom Farming
 
   |name    = Custom Farming
   |name    = Custom Farming Redux
+
   |name2    = Custom Farming Redux
 
   |author  = Platonymous
 
   |author  = Platonymous
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/991
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/991
Line 3,571: Line 3,571:
 
   |source  = https://github.com/danvolchek/StardewMods
 
   |source  = https://github.com/danvolchek/StardewMods
 
   |status  = soon
 
   |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Daily Luck Message
 +
  |author  = Schematix
 +
  |author2  = Schmtx
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1327
 +
  |source  =
 +
  |status  = broken
 
   |summary  =  
 
   |summary  =  
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
Line 3,583: Line 3,593:
 
   |summary  = no longer supported or available, <s>use [[#Stardew Notification|Stardew Notification]] instead</s>.
 
   |summary  = no longer supported or available, <s>use [[#Stardew Notification|Stardew Notification]] instead</s>.
 
   |broke in = Stardew Valley 1.2?
 
   |broke in = Stardew Valley 1.2?
 +
}}
 +
{{/entry
 +
  |name    = Daily Tasks Report
 +
  |author  = GuiNoya
 +
  |author2  = Yesst
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1624
 +
  |source  = https://github.com/GuiNoya/SVMods
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Data Maps
 +
  |author  = Pathoschild
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1691
 +
  |source  = https://github.com/Pathoschild/StardewMods
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Debug Mode
 +
  |author  = Pathoschild
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/679
 +
  |source  = https://github.com/Pathoschild/StardewMods
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Desert Obelisk
 +
  |author  = CatCattyCat
 +
  |author2  = Cat
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/2021
 +
  |source  = https://github.com/danvolchek/StardewMods
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Did You Water Your Crops
 +
  |author  = Nishtra
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1583
 +
  |source  =
 +
  |status  = broken
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Don't Eat That
 +
  |author  = Pyrohead37
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1951
 +
  |source  =
 +
  |status  = broken
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Durable Fences
 +
  |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    = Dynamic Checklist
 +
  |author  = gunnargolf
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1145
 +
  |source  = https://github.com/gunnargolf/DynamicChecklist
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = SMAPI 2.0
 +
  |links    = https://github.com/gunnargolf/DynamicChecklist/pull/4
 +
}}
 +
{{/entry
 +
  |name    = Dynamic Horses
 +
  |author  = Bpendragon
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/874
 +
  |source  =
 +
  |status  = broken
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 3,593: Line 3,687:
 
   |summary  =  
 
   |summary  =  
 
   |broke in = SMAPI 2.0
 
   |broke in = SMAPI 2.0
 +
}}
 +
{{/entry
 +
  |name    = DynamicNPCSprites
 +
  |author  = BashNinja
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1183
 +
  |source  = https://github.com/miketweaver/DynamicNPCSprites
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Easier Farming
 +
  |author  = Cautious Waffle
 +
  |author2  = skulmuk
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1426
 +
  |source  =
 +
  |status  = broken
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Emotes
 +
  |author  = aurnj
 +
  |author2  = Roy Li
 +
  |url      = https://community.playstarbound.com/threads/emotes.129159
 +
  |source  =
 +
  |status  = broken
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Empty Hands
 +
  |author  = Oblitus
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1176
 +
  |source  = https://github.com/quicksilverfox/StardewMods
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = SMAPI 2.0
 +
  |links    = https://github.com/quicksilverfox/StardewMods/pull/1
 +
}}
 +
{{/entry
 +
  |name    = Enemy Health Bars
 +
  |name2    = Health Bars
 +
  |author  = OrSpeeder
 +
  |author2  = Mauricio Gomes
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/193
 +
  |source  = https://gitlab.com/speeder1/SMAPIHealthbarMod
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.2
 +
  |links    = https://gitlab.com/speeder1/SMAPIHealthbarMod/merge_requests/1
 +
}}
 +
{{/entry
 +
  |name    = Enhanced Relationships
 +
  |author  = Mizzion
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1927
 +
  |source  = https://github.com/Mizzion/EnhancedRelationships
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 3,599: Line 3,753:
 
   |url      = https://community.playstarbound.com/resources/4228
 
   |url      = https://community.playstarbound.com/resources/4228
 
   |source  = https://github.com/Entoarox/StardewMods
 
   |source  = https://github.com/Entoarox/StardewMods
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Equivalent Exchange
 +
  |author  = MercuriusXeno
 +
  |author2  = x3n0ph0b3
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1656
 +
  |source  = https://github.com/MercuriusXeno/EquivalentExchange
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Even More Crops
 +
  |author  = TenkoKuugen
 +
  |url      = https://community.playstarbound.com/threads/129349
 +
  |source  =
 +
  |status  = broken
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.2
 +
  |links    = https://community.playstarbound.com/threads/129349/page-5#post-3151557
 +
}}
 +
{{/entry
 +
  |name    = Expanded Fridge
 +
  |name2    = Dynamic Expanded Fridge
 +
  |author  = Lodukas
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1191
 +
  |source  =
 +
  |status  = broken
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Experience Bars
 +
  |author  = spacechase0
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/509
 +
  |source  = https://github.com/spacechase0/ExperienceBars
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Extended BusSystem
 +
  |author  = Tondorian
 +
  |url      = https://community.playstarbound.com/resources/smapi-extended-bussystem.4373
 +
  |source  =
 +
  |status  = broken
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Extended Fridge
 +
  |author  = Crystalmir
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/485
 +
  |source  = https://github.com/Mystra007/ExtendedFridgeSMAPI
 +
  |status  = broken
 +
  |summary  = <s>use [https://www.nexusmods.com/stardewvalley/mods/1191 Expanded Fridge] or [https://www.nexusmods.com/stardewvalley/mods/1030 Chefs Closet] instead</s>.
 +
  |broke in = Stardew Valley 1.2
 +
  |links    = https://github.com/Mystra007/ExtendedFridgeSMAPI/pull/1
 +
}}
 +
{{/entry
 +
  |name    = Extended Minecart
 +
  |author  = Entoarox
 +
  |url      = https://community.playstarbound.com/resources/smapi-extended-minecart.4359
 +
  |source  = https://github.com/Entoarox/StardewMods
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Extended Reach
 +
  |author  = spacechase0
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1493
 +
  |source  = https://github.com/spacechase0/ExtendedReach
 
   |status  = soon
 
   |status  = soon
 
   |summary  =  
 
   |summary  =  
Line 4,107: Line 4,337:
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/1378
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/1378
 
   |source  = https://github.com/janavarro95/Stardew_Valley_Mods
 
   |source  = https://github.com/janavarro95/Stardew_Valley_Mods
}}<!---
 
 
 
 
-->
 
{{/entry
 
  |name    = Daily Luck Message
 
  |author  = Schematix
 
  |author2  = Schmtx
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1327
 
  |source  =
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,124: Line 4,343:
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/1141
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/1141
 
   |source  = https://github.com/miketweaver/DailyNews
 
   |source  = https://github.com/miketweaver/DailyNews
}}
 
{{/entry
 
  |name    = Daily Tasks Report
 
  |author  = GuiNoya
 
  |author2  = Yesst
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1624
 
  |source  = https://github.com/GuiNoya/SVMods
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,138: Line 4,350:
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/513
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/513
 
   |source  = https://github.com/janavarro95/Stardew_Valley_Mods
 
   |source  = https://github.com/janavarro95/Stardew_Valley_Mods
}}
 
{{/entry
 
  |name    = Data Maps
 
  |author  = Pathoschild
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1691
 
  |source  = https://github.com/Pathoschild/StardewMods
 
}}
 
{{/entry
 
  |name    = Debug Mode
 
  |author  = Pathoschild
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/679
 
  |source  = https://github.com/Pathoschild/StardewMods
 
}}
 
{{/entry
 
  |name    = Desert Obelisk
 
  |author  = CatCattyCat
 
  |author2  = Cat
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/2021
 
  |source  = https://github.com/danvolchek/StardewMods
 
}}
 
{{/entry
 
  |name    = Did You Water Your Crops
 
  |author  = Nishtra
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1583
 
  |source  =
 
}}
 
{{/entry
 
  |name    = Don't Eat That
 
  |author  = Pyrohead37
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1951
 
  |source  = https://github.com/Zoryn4163/SMAPI-Mods
 
}}
 
{{/entry
 
  |name    = Durable Fences
 
  |author  = Zoryn
 
  |url      = https://github.com/Zoryn4163/SMAPI-Mods/releases
 
  |source  = https://github.com/Zoryn4163/SMAPI-Mods
 
}}
 
{{/entry
 
  |name    = Dynamic Checklist
 
  |author  = gunnargolf
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1145
 
  |source  = https://github.com/gunnargolf/DynamicChecklist
 
  |status  = workaround
 
  |summary  = use [https://community.playstarbound.com/attachments/dynamicchecklist-1-0-1-pathoschild-update-zip.190844 unofficial update] (<small>1.0.1-pathoschild-update</small>).
 
  |links    = https://github.com/gunnargolf/DynamicChecklist/pull/4
 
  |broke in = SMAPI 2.0
 
}}
 
{{/entry
 
  |name    = Dynamic Horses
 
  |author  = Bpendragon
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/874
 
  |source  =
 
}}
 
{{/entry
 
  |name    = DynamicNPCSprites
 
  |author  = BashNinja
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1183
 
  |source  = https://github.com/miketweaver/DynamicNPCSprites
 
}}
 
{{/entry
 
  |name    = Easier Farming
 
  |author  = Cautious Waffle
 
  |author2  = skulmuk
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1426
 
  |source  =
 
}}
 
{{/entry
 
  |name    = Emotes
 
  |author  = aurnj
 
  |author2  = Roy Li
 
  |url      = https://community.playstarbound.com/threads/emotes.129159
 
  |source  =
 
}}
 
{{/entry
 
  |name    = Empty Hands
 
  |author  = Oblitus
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1176
 
  |source  = https://github.com/quicksilverfox/StardewMods
 
  |status  = workaround
 
  |summary  = use [https://community.playstarbound.com/attachments/emptyhands-1-0-1-pathoschild-update-zip.190883 unofficial update] (<small>1.0.1-pathoschild-update</small>).
 
  |links    = https://github.com/quicksilverfox/StardewMods/pull/1
 
  |broke in = SMAPI 2.0
 
}}
 
{{/entry
 
  |name    = Enemy Health Bars
 
  |name2    = Health Bars
 
  |author  = OrSpeeder
 
  |author2  = Mauricio Gomes
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/193
 
  |source  = https://gitlab.com/speeder1/SMAPIHealthbarMod
 
  |status  = workaround
 
  |summary  = use [https://community.playstarbound.com/attachments/180467 unofficial update] (<small>1.7.1-pathoschild-update</small>).
 
  |links    = https://gitlab.com/speeder1/SMAPIHealthbarMod/merge_requests/1
 
  |broke in = Stardew Valley 1.2
 
}}
 
{{/entry
 
  |name    = Enhanced Relationships
 
  |author  = Mizzion
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1927
 
  |source  = https://github.com/Mizzion/EnhancedRelationships
 
}}
 
{{/entry
 
  |name    = Equivalent Exchange
 
  |author  = MercuriusXeno
 
  |author2  = x3n0ph0b3
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1656
 
  |source  = https://github.com/MercuriusXeno/EquivalentExchange
 
}}
 
{{/entry
 
  |name    = Even More Crops
 
  |author  = TenkoKuugen
 
  |url      = https://community.playstarbound.com/threads/129349
 
  |source  =
 
  |status  = workaround
 
  |summary  = use [https://community.playstarbound.com/threads/129349/page-6#post-3154045 unofficial update] (<small>MysticTempest 2017-06-03</small>).
 
  |links    = https://community.playstarbound.com/threads/129349/page-5#post-3151557
 
  |broke in = Stardew Valley 1.2
 
}}
 
{{/entry
 
  |name    = Expanded Fridge
 
  |name2    = Dynamic Expanded Fridge
 
  |author  = Lodukas
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1191
 
  |source  =
 
}}
 
{{/entry
 
  |name    = Experience Bars
 
  |author  = spacechase0
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/509
 
  |source  = https://github.com/spacechase0/ExperienceBars
 
}}
 
{{/entry
 
  |name    = Extended BusSystem
 
  |author  = Tondorian
 
  |url      = https://community.playstarbound.com/resources/smapi-extended-bussystem.4373
 
  |source  =
 
}}
 
{{/entry
 
  |name    = Extended Fridge
 
  |author  = Crystalmir
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/485
 
  |source  = https://github.com/Mystra007/ExtendedFridgeSMAPI
 
  |status  = workaround
 
  |summary  = use [https://community.playstarbound.com/attachments/extendedfridge-1-0-1-pathoschild-update-zip.186214 unofficial update], [https://www.nexusmods.com/stardewvalley/mods/1191 Expanded Fridge], or [https://www.nexusmods.com/stardewvalley/mods/1030 Chefs Closet].
 
  |links    = https://github.com/Mystra007/ExtendedFridgeSMAPI/pull/1
 
  |broke in = Stardew Valley 1.2
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,292: Line 4,357:
 
   |source  =  
 
   |source  =  
 
}}
 
}}
{{/entry
+
<!--
  |name    = Extended Minecart
+
 
  |author  = Entoarox
+
 
  |url      = https://community.playstarbound.com/resources/smapi-extended-minecart.4359
+
 
  |source  = https://github.com/Entoarox/StardewMods
+
-->
}}
 
{{/entry
 
  |name    = Extended Reach
 
  |author  = spacechase0
 
  |url      = https://www.nexusmods.com/stardewvalley/mods/1493
 
  |source  = https://github.com/spacechase0/ExtendedReach
 
}}
 
 
{{/entry
 
{{/entry
 
   |name    = Fall 28 Snow Day
 
   |name    = Fall 28 Snow Day

Revision as of 23:45, 15 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