Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
m (→‎SMAPI mods: add table ID for scripting)
(reorganise page a bit)
Line 1: Line 1:
 
←[[Modding:Index|Index]]
 
←[[Modding:Index|Index]]
  
−
SMAPI 2.0 lets mods do much more, but it no longer supports old deprecated APIs. Any mods which still have deprecation warnings won't work in SMAPI 2.0, which will release in Q4 2017. '''Those mods will still work fine until then.'''
+
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. '''Those mods will work fine until then.'''
  
−
__TOC__
+
==For players==
−
==What to do==
+
===What to do===
−
# For each mod you have installed:
+
# 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 it's listed below, follow the instructions for that mod to update it.
+
# If a mod is still failing, post a message in the [http://community.playstarbound.com/threads/135000 SMAPI 2.0 migration thread] (with [[Modding:Player FAQs#SMAPI log|your SMAPI log]] attached) and we'll help.
−
#* Otherwise, update to its latest version.
 
−
# If a mod is still failing, post a message in the [http://community.playstarbound.com/threads/135000 SMAPI 2.0 migration thread] and we'll help. Make sure to attach [[Modding:Player FAQs#SMAPI log|your SMAPI log]] after trying the mod.
 
  
−
==SMAPI mods==
+
===SMAPI mods===
−
Here's a list of mods tested with SMAPI 2.0.
+
Here's a list of mods tested with SMAPI 2.0. Please don't edit this list directly; post a message in the [http://community.playstarbound.com/threads/135000 SMAPI 2.0 migration thread] instead.
−
 
 
−
* '''Players:''' please don't edit this list directly; post a message in the [http://community.playstarbound.com/threads/135000 SMAPI 2.0 migration thread] instead.
 
−
* '''Modders:''' feel free to add or update your mods below ([[/entry#Usage|see format]]), or post a message in the [http://community.playstarbound.com/threads/135000 SMAPI 2.0 migration thread].
 
  
 
{| class="wikitable plainlinks" id="mod-list"
 
{| class="wikitable plainlinks" id="mod-list"
Line 2,063: Line 2,058:
 
<div style="font-size: 0.8em;"><references /></div>
 
<div style="font-size: 0.8em;"><references /></div>
  
−
==What about mods not listed here?==
+
==For mod developers==
−
Most mods should work fine with SMAPI 2.0. Make sure you update to their latest version.
+
===What to do===
−
 
+
Feel free to add or update your mods in the list above ([[/entry#Usage|see format]]), post a message in the [http://community.playstarbound.com/threads/135000 SMAPI 2.0 migration thread], or ping @Pathoschild in [https://discord.gg/kH55QXP #modding on Discord]. A preview version of SMAPI 2.0 is also available in #modding to test your mods.
−
'''For players:''' If a mod stopped working and updating it didn't help, post a message in the [http://community.playstarbound.com/threads/135000 SMAPI 2.0 migration thread] and I'll help you figure it out. If the mod is incompatible, I'll let the author know, submit a pull request if the code is available, and possibly create an unofficial update if needed.
 
  
−
'''For mod authors:''' see [[Modding:Updating deprecated SMAPI code|how to update deprecated code]] or come chat in [https://discord.gg/kH55QXP #modding on Discord] (a preview version of SMAPI 2.0 is also available there to test your mods). Don't have time to update your mods? Post a message in the [http://community.playstarbound.com/threads/135000 SMAPI 2.0 migration thread] and I'll update them for you. :)
+
See [[Modding:Updating deprecated SMAPI code|how to update deprecated code]] or ask questions in [https://discord.gg/kH55QXP #modding on Discord]. If you don't have time to update your mods, post a message in the [http://community.playstarbound.com/threads/135000 SMAPI 2.0 migration thread] and we'll update them for you. :)
  
−
==Migration status==
+
===Overall compatibility===
 +
Status of known SMAPI mods:
 
{{/barchart
 
{{/barchart
 
   |ok        = 52
 
   |ok        = 52

Revision as of 03:25, 19 July 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, which will release in Q4 2017. Those mods will work fine until then.

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

Feel free to add or update your mods in the list above (see format), post a message in the SMAPI 2.0 migration thread, or ping @Pathoschild in #modding on Discord. A preview version of SMAPI 2.0 is also available in #modding to test your mods.

See how to update deprecated code or ask questions in #modding on Discord. If you don't have time to update your mods, post a message in the SMAPI 2.0 migration thread and we'll update them for you. :)

Overall compatibility

Status of known SMAPI mods:

<div style="display: inline-block; width: Division by zero.px; background: #9F9;">  Division by zero.% are compatible or have a working alternative.
<div style="display: inline-block; width: Division by zero.px; background: #FF9;">  Division by zero.% have an update coming soon.
<div style="display: inline-block; width: Division by zero.px; background: #F99;">  Division by zero.% 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=58103"