Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: update for Horse Whistle)
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
←[[Modding:Index|Index]]
 
←[[Modding:Index|Index]]
  
−
'''For players with SMAPI 1.15:''' all the updates below are compatible with SMAPI 1.15.<br />
+
SMAPI 2.0 enables new kinds of mods, but no longer supports deprecated APIs. Mods with deprecation warnings won't work in SMAPI 2.0.
−
'''For players with SMAPI 2.0:''' SMAPI 2.0 enables new kinds of mods, but no longer supports deprecated APIs. Mods with deprecation warnings won't work in SMAPI 2.0, which will release in Q4 2017.
 
  
 
==For players==
 
==For players==
Line 133: Line 132:
 
   |author2 = Aaron Taggart
 
   |author2 = Aaron Taggart
 
   |url    = http://www.nexusmods.com/stardewvalley/mods/1019
 
   |url    = http://www.nexusmods.com/stardewvalley/mods/1019
 +
  |status  = ok
 +
  |summary =
 +
  |source  =
 +
}}
 +
{{/entry
 +
  |name    = AutoCrop
 +
  |author  = aurnj
 +
  |author2 = Roy Li
 +
  |url    = https://community.playstarbound.com/threads/autocrop.129152/
 
   |status  = ok
 
   |status  = ok
 
   |summary =  
 
   |summary =  
Line 179: Line 187:
 
   |source  = https://github.com/janavarro95/Stardew_Valley_Mods
 
   |source  = https://github.com/janavarro95/Stardew_Valley_Mods
 
   |links  = https://github.com/janavarro95/Stardew_Valley_Mods/pull/14, https://github.com/janavarro95/Stardew_Valley_Mods/pull/16, https://github.com/janavarro95/Stardew_Valley_Mods/pull/17, https://github.com/janavarro95/Stardew_Valley_Mods/pull/18, https://github.com/janavarro95/Stardew_Valley_Mods/pull/20, https://github.com/janavarro95/Stardew_Valley_Mods/pull/24
 
   |links  = https://github.com/janavarro95/Stardew_Valley_Mods/pull/14, https://github.com/janavarro95/Stardew_Valley_Mods/pull/16, https://github.com/janavarro95/Stardew_Valley_Mods/pull/17, https://github.com/janavarro95/Stardew_Valley_Mods/pull/18, https://github.com/janavarro95/Stardew_Valley_Mods/pull/20, https://github.com/janavarro95/Stardew_Valley_Mods/pull/24
 +
}}
 +
{{/entry
 +
  |name    = Auto Watering
 +
  |author  = aurnj
 +
  |author2 = Roy Li
 +
  |url    = https://community.playstarbound.com/threads/auto-watering.129355
 +
  |status  = broken
 +
  |summary =
 +
  |source  =
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 267: Line 284:
 
   |summary = use [http://community.playstarbound.com/attachments/182461 unofficial update] (<small>1.2.3-pathoschild-update.2</small>).
 
   |summary = use [http://community.playstarbound.com/attachments/182461 unofficial update] (<small>1.2.3-pathoschild-update.2</small>).
 
   |links  = https://github.com/KathrynHazuka/StardewValley_BirthdayMail/pull/2
 
   |links  = https://github.com/KathrynHazuka/StardewValley_BirthdayMail/pull/2
 +
}}
 +
{{/entry
 +
  |name    = Blood Trail
 +
  |author  = aurnj
 +
  |author2 = Roy Li
 +
  |url    = https://community.playstarbound.com/threads/blood-trail.129308
 +
  |status  = broken
 +
  |summary =
 +
  |source  =
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 728: Line 754:
 
   |author2 = skulmuk
 
   |author2 = skulmuk
 
   |url    = http://www.nexusmods.com/stardewvalley/mods/1426
 
   |url    = http://www.nexusmods.com/stardewvalley/mods/1426
 +
  |status  = ok
 +
  |summary =
 +
  |source  =
 +
}}
 +
{{/entry
 +
  |name    = Emotes
 +
  |author  = aurnj
 +
  |author2 = Roy Li
 +
  |url    = https://community.playstarbound.com/threads/emotes.129159
 
   |status  = ok
 
   |status  = ok
 
   |summary =  
 
   |summary =  
Line 920: Line 955:
 
   |summary =  
 
   |summary =  
 
   |source  = https://github.com/DeathGameDev/SDV-FastTravel
 
   |source  = https://github.com/DeathGameDev/SDV-FastTravel
 +
}}
 +
{{/entry
 +
  |name    = Fireballs!
 +
  |author  = aurnj
 +
  |author2 = Roy Li
 +
  |url    = https://community.playstarbound.com/threads/fireballs.129346
 +
  |status  = broken
 +
  |summary =
 +
  |source  =
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,113: Line 1,157:
 
   |author  = icepuente
 
   |author  = icepuente
 
   |url    = http://www.nexusmods.com/stardewvalley/mods/1131
 
   |url    = http://www.nexusmods.com/stardewvalley/mods/1131
−
   |status  = ok
+
   |status  = workaround
−
   |summary =  
+
   |summary = use [https://community.playstarbound.com/attachments/horsewhistle-1-1-1-pathoschild-update-zip.191297 unofficial update] (<small>1.1.1-pathoschild-update</small>) on Linux/Mac; use [http://www.nexusmods.com/stardewvalley/mods/1131 official version] on Windows.
 
   |source  = https://github.com/icepuente/StardewValleyMods
 
   |source  = https://github.com/icepuente/StardewValleyMods
 +
  |links  = https://github.com/icepuente/StardewValleyMods/pull/1
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,122: Line 1,167:
 
   |hide-url= http://community.playstarbound.com/threads/calling-horse-with-key-press.111550
 
   |hide-url= http://community.playstarbound.com/threads/calling-horse-with-key-press.111550
 
   |status  = workaround
 
   |status  = workaround
−
   |summary = use [http://www.nexusmods.com/stardewvalley/mods/1131 Horse Whistle by icepuente].
+
   |summary = use [[#Horse_Whistle|Horse Whistle by icepuente]].
 
   |source  =  
 
   |source  =  
 
}}
 
}}
Line 1,166: Line 1,211:
 
   |links  = http://community.playstarbound.com/threads/127688/page-5#post-3161620,https://github.com/demiacle/QualityOfLifeMods/pull/1
 
   |links  = http://community.playstarbound.com/threads/127688/page-5#post-3161620,https://github.com/demiacle/QualityOfLifeMods/pull/1
 
   |source  = https://github.com/demiacle/QualityOfLifeMods
 
   |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
 +
  |status  = ok
 +
  |summary =
 +
  |source  =
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,227: Line 1,281:
 
   |source  = https://github.com/Platonymous/Stardew-Valley-Mods/
 
   |source  = https://github.com/Platonymous/Stardew-Valley-Mods/
 
   |links  = https://github.com/Platonymous/Stardew-Valley-Mods/pull/7
 
   |links  = https://github.com/Platonymous/Stardew-Valley-Mods/pull/7
 +
}}
 +
{{/entry
 +
  |name    = Kamikaze
 +
  |author  = aurnj
 +
  |author2 = Roy Li
 +
  |url    = https://community.playstarbound.com/threads/kamikaze-mod.129126
 +
  |status  = ok
 +
  |summary =
 +
  |source  =
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,326: Line 1,389:
 
   |author  = spacechase0
 
   |author  = spacechase0
 
   |url    = http://www.nexusmods.com/stardewvalley/mods/501
 
   |url    = http://www.nexusmods.com/stardewvalley/mods/501
−
   |status  = soon-official
+
   |status  = ok
 
   |summary =  
 
   |summary =  
 
   |source  = https://github.com/spacechase0/StardewValleyMP
 
   |source  = https://github.com/spacechase0/StardewValleyMP
Line 1,948: Line 2,011:
 
   |author2 = Alpha_Omegasis
 
   |author2 = Alpha_Omegasis
 
   |hide-url= http://www.nexusmods.com/stardewvalley/mods/1410
 
   |hide-url= http://www.nexusmods.com/stardewvalley/mods/1410
−
   |status  = workaround
+
   |status  = ok
−
   |summary = use [https://community.playstarbound.com/attachments/simplesoundmanager-1-0-1-pathoschild-update-zip.191192 unofficial update] (<small>1.0.1-pathoschild-update</small>).
+
   |summary =  
 
   |source  = https://github.com/janavarro95/Stardew_Valley_Mods
 
   |source  = https://github.com/janavarro95/Stardew_Valley_Mods
 
   |links  = https://github.com/janavarro95/Stardew_Valley_Mods/pull/24
 
   |links  = https://github.com/janavarro95/Stardew_Valley_Mods/pull/24
Line 2,021: Line 2,084:
 
   |summary =  
 
   |summary =  
 
   |source  = https://github.com/spacechase0/SleepyEye
 
   |source  = https://github.com/spacechase0/SleepyEye
 +
}}
 +
{{/entry
 +
  |name    = Slime Spawner
 +
  |author  = aurnj
 +
  |author2 = Roy Li
 +
  |url    = https://community.playstarbound.com/threads/slime-spawner.129326/
 +
  |status  = broken
 +
  |summary =
 +
  |source  =
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,303: Line 2,375:
 
   |author  = spacechase0
 
   |author  = spacechase0
 
   |hide-url= http://www.nexusmods.com/stardewvalley/mods/500
 
   |hide-url= http://www.nexusmods.com/stardewvalley/mods/500
−
   |status  = workaround
+
   |status  = ok
−
   |summary = use [https://community.playstarbound.com/attachments/threeheartdancepartner-1-0-2-pathoschild-update-zip.191212 unofficial update] (<small>1.0.2-pathoschild-update</small>)
+
   |summary =  
 
   |source  = https://github.com/spacechase0/ThreeHeartDancePartner
 
   |source  = https://github.com/spacechase0/ThreeHeartDancePartner
 
   |links  = https://github.com/spacechase0/ThreeHeartDancePartner/pull/1
 
   |links  = https://github.com/spacechase0/ThreeHeartDancePartner/pull/1
Line 2,536: Line 2,608:
 
Status of known SMAPI mods:
 
Status of known SMAPI mods:
 
{{/barchart
 
{{/barchart
−
   |ok        = 201
+
   |ok        = 207
−
   |workaround = 55
+
   |workaround = 54
−
   |soon      = 1
+
   |soon      = 0
−
   |broken    = 33
+
   |broken    = 37
−
   |total      = 290
+
   |total      = 298
 
}}
 
}}
−
 
−
===Update queue===
 
−
The following are open-source mods that need updates before SMAPI 2.0 is released (sorted by endorsements on Nexus).
 
−
 
−
{| class="wikitable plainlinks" id="mod-list"
 
−
|-
 
−
! mod name
 
−
! author
 
−
! endorsements
 
−
! (metadata)
 
−
|}
 
  
 
[[Category:Modding]]
 
[[Category:Modding]]

Revision as of 20:23, 14 October 2017

←Index

SMAPI 2.0 enables new kinds of mods, but no longer supports deprecated APIs. Mods with deprecation warnings won't work in SMAPI 2.0.

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 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.0. Please don't edit this list directly; post a message in the SMAPI 2.0 migration thread instead.

  1. ↑ This only shows whether a mod is compatible; it may have bugs unrelated to SMAPI 2.0. Many mods broke in Stardew Valley 1.1 and 1.2, so 'broken' doesn't necessarily mean broken by SMAPI 2.0 itself.

For mod developers

What to do

See how to update deprecated code. You can...

  • Add or update your mods in the list above (see format).
  • Post a message in the SMAPI 2.0 migration thread to ask questions or say when your mods are updated.
  • Chat or ask questions in #modding on Discord. (A preview version of SMAPI 2.0 is also pinned there to test your mods.)

When updating a mod, avoiding new SMAPI 2.0 APIs is strongly recommended. The new APIs are subject to change until 2.0 is officially released, and having mods only work in an unreleased version of SMAPI may confuse players. Instead, you should just fix deprecation warnings so your mods will work fine in both SMAPI 1.15 and 2.0.

Overall compatibility

Status of known SMAPI mods:

 
 88% are compatible or have a working alternative.
 
 0% have an update coming soon.
 
 12% are broken and not open-source.¹

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

Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Mod_compatibility&oldid=63198"