Jump to content

Modding:Mod compatibility: Difference between revisions

From Stardew Valley Wiki
← Older editNewer edit →
imported>Pathoschild
→SMAPI mods: fix entries where '3.0 ready' and 'beta broke in' don't match
imported>Pathoschild
→SMAPI mods: remove '3.0 ready = no' fields
Line 121: Line 121:
   |cf id    = 3619
   |cf id    = 3619
   |github  = Entoarox/StardewMods
   |github  = Entoarox/StardewMods
  |3.0 ready= no


   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->
   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->
Line 148: Line 147:
   |nexus id = 2983
   |nexus id = 2983
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 265: Line 263:
   |nexus id = 4011
   |nexus id = 4011
   |github  =  
   |github  =  
  |3.0 ready= no<!-- broken by Entoarox Framework -->


   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->
   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->
Line 393: Line 390:
   |nexus id = 2387
   |nexus id = 2387
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 516: Line 512:
   |nexus id = 2307
   |nexus id = 2307
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 881: Line 876:
   |id      = KathrynHazuka.BirthdayMail
   |id      = KathrynHazuka.BirthdayMail
   |nexus id = 276
   |nexus id = 276
   |github  = KathrynHazuka/StardewValley_BirthdayMail
   |github  = KathrynHazuka/StardewValley_BirthdayMail <!--author ignored previous pull requests-->
  |3.0 ready= no<!--author ignored previous pull requests-->


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 907: Line 901:
   |nexus id = 2820
   |nexus id = 2820
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 939: Line 932:
   |nexus id = 3144
   |nexus id = 3144
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 949: Line 941:
   |nexus id = 2178
   |nexus id = 2178
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = Stardew Valley 1.4
   |beta broke in = Stardew Valley 1.4
Line 1,511: Line 1,502:
   |id      = Sabera.CraftAnything
   |id      = Sabera.CraftAnything
   |nexus id = 2524
   |nexus id = 2524
   |github  = ebehar/CraftAnything
   |github  = ebehar/CraftAnything <!--GitHub repo outdated: https://github.com/ebehar/CraftAnything/issues/1-->
  |3.0 ready= no<!--GitHub repo outdated: https://github.com/ebehar/CraftAnything/issues/1-->


   |beta broke in = Stardew Valley 1.4
   |beta broke in = Stardew Valley 1.4
Line 1,577: Line 1,567:
   |nexus id = 4028
   |nexus id = 4028
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 1,662: Line 1,651:
   |nexus id = 1254
   |nexus id = 1254
   |github  = Platonymous/Stardew-Valley-Mods
   |github  = Platonymous/Stardew-Valley-Mods
  |3.0 ready= no <!-- broken due to Entoarox Framework, Furniture Anywhere -->


   |beta broke in = SMAPI 3.0<!--possibly due to PyTK, Entoarox Framework-->
   |beta broke in = SMAPI 3.0<!--possibly due to PyTK, Entoarox Framework-->
Line 1,715: Line 1,703:
   |nexus id = 1027
   |nexus id = 1027
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 1,751: Line 1,738:
   |cf id    = 5234
   |cf id    = 5234
   |github  = Entoarox/StardewMods
   |github  = Entoarox/StardewMods
  |3.0 ready= no <!-- broken due to Entoarox Framework -->


   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->
   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->
Line 1,853: Line 1,839:
   |nexus id = 2287
   |nexus id = 2287
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 2,049: Line 2,034:
   |github  =  
   |github  =  
   |status = optional
   |status = optional
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 2,059: Line 2,043:
   |nexus id = 2724
   |nexus id = 2724
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 2,086: Line 2,069:
   |nexus id = 3071
   |nexus id = 3071
   |github  =  
   |github  =  
  |3.0 ready= no<!--entry DLL capitalisation-->


   |beta broke in  = SMAPI 3.0
   |beta broke in  = SMAPI 3.0
Line 2,131: Line 2,113:
   |cf id    = 4228
   |cf id    = 4228
   |github  = Entoarox/StardewMods
   |github  = Entoarox/StardewMods
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 2,185: Line 2,166:
   |cf id    = 4373
   |cf id    = 4373
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->
   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->
Line 2,210: Line 2,190:
   |cf id    = 4359
   |cf id    = 4359
   |github  = Entoarox/StardewMods
   |github  = Entoarox/StardewMods
  |3.0 ready= no <!-- broken due to Entoarox Framework -->


   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->
   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->
Line 2,244: Line 2,223:
   |nexus id = 2618
   |nexus id = 2618
   |github  =  
   |github  =  
  |3.0 ready= no <!-- just need to change EntryDll from 'farmageddon.dll' to 'Farmageddon.dll' -->


   |beta broke in = Stardew Valley 1.4
   |beta broke in = Stardew Valley 1.4
Line 2,333: Line 2,311:
   |nexus id = 1772
   |nexus id = 1772
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 2,343: Line 2,320:
   |nexus id = 2791
   |nexus id = 2791
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 2,354: Line 2,330:
   |cf id    = 3641
   |cf id    = 3641
   |github  = Entoarox/StardewMods
   |github  = Entoarox/StardewMods
  |3.0 ready= no <!-- broken due to Entoarox Framework -->


   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->
   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->
Line 2,517: Line 2,492:
   |nexus id = 3019
   |nexus id = 3019
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 2,551: Line 2,525:
   |nexus id = 2520
   |nexus id = 2520
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = Stardew Valley 1.4
   |beta broke in = Stardew Valley 1.4
Line 2,585: Line 2,558:
   |cf id    = 4324
   |cf id    = 4324
   |github  = Entoarox/StardewMods
   |github  = Entoarox/StardewMods
  |3.0 ready= no <!-- broken due to Entoarox Framework -->


   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->
   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->
Line 2,603: Line 2,575:
   |nexus id = 2463
   |nexus id = 2463
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 2,686: Line 2,657:
   |nexus id = 2195
   |nexus id = 2195
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 2,720: Line 2,690:
   |nexus id = 2662
   |nexus id = 2662
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 2,730: Line 2,699:
   |nexus id = 1735
   |nexus id = 1735
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = Stardew Valley 1.4
   |beta broke in = Stardew Valley 1.4
Line 2,803: Line 2,771:
   |nexus id = 4024
   |nexus id = 4024
   |github  = ninthworld/HDSprites
   |github  = ninthworld/HDSprites
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 2,875: Line 2,842:
   |nexus id = 1736
   |nexus id = 1736
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 2,979: Line 2,945:
   |nexus id = 2823
   |nexus id = 2823
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = Stardew Valley 1.4
   |beta broke in = Stardew Valley 1.4
Line 3,159: Line 3,124:
   |nexus id = 3147
   |nexus id = 3147
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 3,207: Line 3,171:
   |id      = DevinLematty.LevelExtender, Devin Lematty.Level Extender<!--changed in 1.3-->
   |id      = DevinLematty.LevelExtender, Devin Lematty.Level Extender<!--changed in 1.3-->
   |nexus id = 1471
   |nexus id = 1471
   |github  = unidarkshin/Stardew-Mods
   |github  = unidarkshin/Stardew-Mods <!--author ignored previous pull requests-->
  |3.0 ready= no<!--author ignored previous pull requests-->


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 3,221: Line 3,184:
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/page-4#post-3275733
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/page-4#post-3275733
   |unofficial version = 0.0.2-unofficial.1-pathoschild
   |unofficial version = 0.0.2-unofficial.1-pathoschild
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 3,479: Line 3,441:
   |nexus id = 2830
   |nexus id = 2830
   |github  = F1r3w477/TheseModsAintLoyal
   |github  = F1r3w477/TheseModsAintLoyal
  |3.0 ready= no<!-- due to Level Extender -->


   |beta broke in = SMAPI 3.0<!--possibly due to Level Extender-->
   |beta broke in = SMAPI 3.0<!--possibly due to Level Extender-->
Line 3,506: Line 3,467:
   |cf id    = 4288
   |cf id    = 4288
   |github  = Entoarox/StardewMods
   |github  = Entoarox/StardewMods
  |3.0 ready= no <!-- broken due to Entoarox Framework -->


   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->
   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->
Line 3,663: Line 3,623:
   |nexus id = 2282
   |nexus id = 2282
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 3,701: Line 3,660:
   |nexus id = 2192
   |nexus id = 2192
   |github  =  
   |github  =  
   |source  = https://github.com/Kalthramis/StardewValley/tree/MPSpeechBubbles<!--uses a separate branch-->
   |source  = https://github.com/Kalthramis/StardewValley/tree/MPSpeechBubbles<!--uses a separate branch; GitHub repo outdated: https://github.com/Kalthramis/StardewValley/issues/11-->
  |3.0 ready= no<!--GitHub repo outdated: https://github.com/Kalthramis/StardewValley/issues/11-->


   |beta broke in = Stardew Valley 1.4
   |beta broke in = Stardew Valley 1.4
Line 3,754: Line 3,712:
   |nexus id = 2818
   |nexus id = 2818
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = Stardew Valley 1.4
   |beta broke in = Stardew Valley 1.4
Line 4,095: Line 4,052:
   |nexus id = 1778
   |nexus id = 1778
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 4,148: Line 4,104:
   |nexus id = 2681
   |nexus id = 2681
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 4,210: Line 4,165:
   |nexus id = 2676
   |nexus id = 2676
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 4,237: Line 4,191:
   |nexus id = 3049
   |nexus id = 3049
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in  = Stardew Valley 1.4<!--possibly due to PyTK-->
   |beta broke in  = Stardew Valley 1.4<!--possibly due to PyTK-->
Line 4,282: Line 4,235:
   |nexus id = 2255
   |nexus id = 2255
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 4,331: Line 4,283:
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/page-17#post-3289499
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/page-17#post-3289499
   |unofficial version = 1.0.1-unofficial.3.mizzion
   |unofficial version = 1.0.1-unofficial.3.mizzion
  |3.0 ready= no


   |beta broke in = Stardew Valley 1.4
   |beta broke in = Stardew Valley 1.4
Line 4,464: Line 4,415:
   |nexus id = 2332
   |nexus id = 2332
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 4,534: Line 4,484:
   |nexus id = 2481
   |nexus id = 2481
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 4,560: Line 4,509:
   |nexus id = 2130
   |nexus id = 2130
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = Stardew Valley 1.4
   |beta broke in = Stardew Valley 1.4
Line 4,634: Line 4,582:
   |unofficial url    = https://community.playstarbound.com/threads/how-to-update-mods-for-smapi-2-0.135000/page-5#post-3237772
   |unofficial url    = https://community.playstarbound.com/threads/how-to-update-mods-for-smapi-2-0.135000/page-5#post-3237772
   |unofficial version = 1.1.1-whisk-update
   |unofficial version = 1.1.1-whisk-update
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 4,748: Line 4,695:
   |nexus id = 2163
   |nexus id = 2163
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 4,768: Line 4,714:
   |nexus id = 1760
   |nexus id = 1760
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 4,861: Line 4,806:
   |nexus id = 3086
   |nexus id = 3086
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = Stardew Valley 1.4
   |beta broke in = Stardew Valley 1.4
Line 4,906: Line 4,850:
   |nexus id = 2042
   |nexus id = 2042
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 4,959: Line 4,902:
   |cf id    = 4381
   |cf id    = 4381
   |github  = Entoarox/StardewMods
   |github  = Entoarox/StardewMods
   |3.0 ready= no <!-- broken due to Entoarox Framework -->
    
 
   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->
   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->
}}
}}
Line 5,103: Line 5,045:
   |nexus id = 2697
   |nexus id = 2697
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = Stardew Valley 1.4
   |beta broke in = Stardew Valley 1.4
Line 5,465: Line 5,406:
   |nexus id = 1138
   |nexus id = 1138
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 5,616: Line 5,556:
   |nexus id = 2482
   |nexus id = 2482
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = Stardew Valley 1.4
   |beta broke in = Stardew Valley 1.4
Line 5,840: Line 5,779:
   |nexus id = 2833
   |nexus id = 2833
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 5,850: Line 5,788:
   |nexus id = 3070
   |nexus id = 3070
   |github  =  
   |github  =  
   |3.0 ready= no<!--entry DLL capitalisation-->
    
 
   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
}}
}}
Line 5,860: Line 5,797:
   |nexus id = 2942
   |nexus id = 2942
   |github  =  
   |github  =  
  |3.0 ready= no


   |beta broke in = SMAPI 3.0
   |beta broke in = SMAPI 3.0
Line 6,134: Line 6,070:
   |cf id    = 4506
   |cf id    = 4506
   |github  = Entoarox/StardewMods
   |github  = Entoarox/StardewMods
  |3.0 ready= no <!-- broken due to Entoarox Framework -->


   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->
   |beta broke in = SMAPI 3.0<!--possibly due to Entoarox Framework-->

Revision as of 06:48, 24 June 2019

Modding:Player Guide/header

SMAPI mod compatibility, July 2017 to present. See notable events which affect this chart.

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.



Players: see mods.smapi.io for a more user-friendly view of this page.



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

SMAPI mods

SMAPI mods (obsolete)

These mods are either obsolete, or have been abandoned by their authors and probably won't be updated unofficially. These will likely never be updated again.

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.

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. Increase the official version in manifest.json by 0.0.1 and add -unofficial.1-yourName.
    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).

Overall compatibility

 
 87% are compatible or have a working alternative.
 
 5% have an update coming soon.
 
 9% are broken and not open-source.¹

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

Footnotes

  1. ↑ 1.0 1.1 1.2 This only shows whether a mod is compatible; it may have bugs unrelated to SMAPI compatibility.
  2. ↑ 2.0 2.1 If a mod says "use optional download", its main version isn't compatible but there's an official optional update. If the mod is on Nexus, click "Files" on the mod page and check for a newer version (often under 'optional files').
Retrieved from "https://stardew.fastobject.net/index.php?title=Modding:Mod_compatibility&oldid=72892"