Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods (obsolete): fix recent changes, fix inconsistent field order)
(→‎SMAPI mods: fix recent changes)
Line 29: Line 29:
 
! source
 
! source
 
! metadata
 
! metadata
−
|-
 
 
{{/entry
 
{{/entry
 
   |name    = 24h Clock
 
   |name    = 24h Clock
Line 335: Line 334:
 
   |curseforge key = arcade-2048
 
   |curseforge key = arcade-2048
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
−
  |dev note = updated due to conflicts with Json Assets
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 352: Line 350:
 
   |curseforge key = arcade-snake
 
   |curseforge key = arcade-snake
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
−
  |dev note          = updated due to conflicts with Json Assets
 
 
}}
 
}}
  
Line 436: Line 433:
  
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
−
   |status       = workaround
+
   |status   = workaround
 
   |summary  = use [[#CJB Cheats Menu|CJB Cheats Menu]] instead.
 
   |summary  = use [[#CJB Cheats Menu|CJB Cheats Menu]] instead.
 
}}
 
}}
Line 560: Line 557:
  
 
   |broke in = SMAPI 2.0
 
   |broke in = SMAPI 2.0
−
   |status       = workaround
+
   |status   = workaround
 
   |summary  = use [[#CJB Cheats Menu|CJB Cheats Menu]] instead.
 
   |summary  = use [[#CJB Cheats Menu|CJB Cheats Menu]] instead.
 
}}
 
}}
Line 592: Line 589:
  
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
−
   |status       = workaround
+
   |status   = workaround
−
   |summary  = use [[#Basic Sprinklers|Basic Sprinklers]] instead.
+
   |summary  = use [[#Better Sprinklers|Better Sprinklers]] instead.
  
 
   |map local versions = 1.0.1-release → 1.0.2<!--manifest not updated-->
 
   |map local versions = 1.0.1-release → 1.0.2<!--manifest not updated-->
Line 788: Line 785:
 
   |nexus id = 935
 
   |nexus id = 935
 
   |github  = bmarquismarkail/SV_BetterQualityMoreSeeds
 
   |github  = bmarquismarkail/SV_BetterQualityMoreSeeds
−
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 796: Line 792:
 
   |nexus id = 771
 
   |nexus id = 771
 
   |github  =  
 
   |github  =  
 +
 +
  |broke in = Stardew Valley 1.4
 
   |status  = workaround
 
   |status  = workaround
−
  |broke in = Stardew Valley 1.4
+
   |summary  = use {{nexus mod|5170|Better Quarry Redux}} instead.
−
   |summary  = use [https://www.nexusmods.com/stardewvalley/mods/5170/ Better Quarry Redux instead].
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,392: Line 1,389:
  
 
   |broke in = Stardew Valley 1.3.29
 
   |broke in = Stardew Valley 1.3.29
−
|status       = workaround
+
  |status   = workaround
−
|summary  = use [[#Right Click Move Mode|Right Click Move Mode]] instead.
+
  |summary  = use [[#Right Click Move Mode|Right Click Move Mode]] instead.
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,489: Line 1,486:
  
 
   |broke in    = Stardew Valley 1.4
 
   |broke in    = Stardew Valley 1.4
−
   |status   = workaround
+
   |status       = workaround
−
   |summary = use [https://www.nexusmods.com/stardewvalley/mods/4582 NPC Adventures] instead.
+
   |summary     = use [[#NPC Adventures|NPC Adventures]] instead.
 +
  |pull request = https://github.com/EKomperud/StardewMods/pull/2
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,690: Line 1,688:
  
 
   |broke in = Stardew Valley 1.4
 
   |broke in = Stardew Valley 1.4
−
   |status       = workaround
+
   |status   = workaround
 
   |summary  = use [[#Lookup Anything|Lookup Anything]] instead.
 
   |summary  = use [[#Lookup Anything|Lookup Anything]] instead.
 
   |dev note = incompatibility possibly due to Bookcase
 
   |dev note = incompatibility possibly due to Bookcase
Line 1,709: Line 1,707:
  
 
   |broke in = SMAPI 3.0
 
   |broke in = SMAPI 3.0
−
   |status       = workaround
+
   |status   = workaround
 
   |summary  = use [[#Debug Mode|Debug Mode]] instead.
 
   |summary  = use [[#Debug Mode|Debug Mode]] instead.
 
}}
 
}}
Line 1,782: Line 1,780:
  
 
   |broke in          = Stardew Valley 1.4.4
 
   |broke in          = Stardew Valley 1.4.4
−
   |unofficial version = 2.12.10-unofficial.1-minervamaga
+
   |unofficial version = 2.12.10-unofficial.1-minervamaga<!--updated to prevent false update alerts-->
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-26#post-3354284
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-26#post-3354284
 
   |pull request      = https://github.com/Platonymous/Stardew-Valley-Mods/pull/81
 
   |pull request      = https://github.com/Platonymous/Stardew-Valley-Mods/pull/81
−
  |dev note = updated to prevent false update alerts
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,794: Line 1,791:
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
  
−
   |broke in          = Stardew Valley 1.4.4
+
   |broke in          = Automate 1.15
 
   |unofficial version = 2.12.10-unofficial.1-minervamaga
 
   |unofficial version = 2.12.10-unofficial.1-minervamaga
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-26#post-3354284
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-26#post-3354284
 
   |pull request      = https://github.com/Platonymous/Stardew-Valley-Mods/pull/81
 
   |pull request      = https://github.com/Platonymous/Stardew-Valley-Mods/pull/81
−
  |dev note = updated due to Automate update breaking bridge
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,808: Line 1,804:
 
   |curseforge key = custom-furniture
 
   |curseforge key = custom-furniture
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
−
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,816: Line 1,811:
 
   |nexus id = 1254
 
   |nexus id = 1254
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
−
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,871: Line 1,865:
  
 
   |summary  = get [https://spacechase0.com/mods/stardew-valley/customize-exterior/ latest version from author's website].
 
   |summary  = get [https://spacechase0.com/mods/stardew-valley/customize-exterior/ latest version from author's website].
−
}}
 
−
{{/entry
 
−
  |name    = Custom Chores
 
−
  |author  = furyx639
 
−
  |id      = furyx639.CustomChores
 
−
  |nexus id = 5315
 
−
  |github  = StardewValleyMod/CustomChores
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,921: Line 1,908:
  
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
−
   |status       = workaround
+
   |status   = workaround
−
|summary  = use [[#Content Patcher|Content Patcher]] instead.
+
  |summary  = use [[#Content Patcher|Content Patcher]] instead.
−
 
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,958: Line 1,944:
  
 
   |broke in = Stardew Valley 1.4
 
   |broke in = Stardew Valley 1.4
−
|status       = workaround
+
  |status   = workaround
−
|summary  = use [[#Json Assets|Json Assets]] instead.
+
  |summary  = use [[#Json Assets|Json Assets]] instead.
−
 
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,970: Line 1,955:
  
 
   |broke in    = Stardew Valley 1.4
 
   |broke in    = Stardew Valley 1.4
−
|status      = abandoned
+
  |status      = abandoned
−
|summary = use [[#Shop Tile Framework|Shop Tile Framework]] + [[#TMX Loader|TMX Loader]] instead.
+
  |summary     = use [[#Shop Tile Framework|Shop Tile Framework]] + [[#TMX Loader|TMX Loader]] instead.
−
  |pull request = https://github.com/janavarro95/Stardew_Valley_Mods/pull/50
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,128: Line 2,112:
 
   |nexus id = 5187
 
   |nexus id = 5187
 
   |github  = AxesOfEvil/SV_DeliveryService
 
   |github  = AxesOfEvil/SV_DeliveryService
−
}}{{/entry
+
}}
 +
{{/entry
 
   |name    = Deluxe Auto-Grabber, Coop Grabber
 
   |name    = Deluxe Auto-Grabber, Coop Grabber
 
   |author  = stokastic
 
   |author  = stokastic
Line 2,244: Line 2,229:
  
 
   |broke in = SMAPI 2.0
 
   |broke in = SMAPI 2.0
−
   |status       = workaround
+
   |status   = workaround
 
   |summary  = use [[#Configure Machine Outputs|Configure Machine Outputs]] instead.
 
   |summary  = use [[#Configure Machine Outputs|Configure Machine Outputs]] instead.
  
Line 2,265: Line 2,250:
  
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
−
|status       = workaround
+
  |status   = workaround
−
|summary  = use [[#Content Patcher|Content Patcher]] instead.
+
  |summary  = use [[#Content Patcher|Content Patcher]] instead.
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,305: Line 2,290:
  
 
   |broke in = Stardew Valley 1.4
 
   |broke in = Stardew Valley 1.4
−
|status       = workaround
+
  |status   = workaround
−
|summary  = use [[#Point and Plant|Point and Plant]] instead.
+
  |summary  = use [[#Point and Plant|Point and Plant]] instead.
−
 
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,355: Line 2,339:
  
 
   |broke in = SMAPI 3.0
 
   |broke in = SMAPI 3.0
−
   |status       = workaround
+
   |status   = workaround
 
   |summary  = use [[#Standardized Krobus|Standardized Krobus]] instead.
 
   |summary  = use [[#Standardized Krobus|Standardized Krobus]] instead.
 
}}
 
}}
Line 2,611: Line 2,595:
  
 
   |broke in = SMAPI 2.0
 
   |broke in = SMAPI 2.0
−
|status       = workaround
+
  |status   = workaround
−
|summary  = use [[#Farm Type Manager|Farm Type Manager]] instead.
+
  |summary  = use [[#Farm Type Manager|Farm Type Manager]] instead.
−
 
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,639: Line 2,622:
  
 
   |broke in = SMAPI 3.0
 
   |broke in = SMAPI 3.0
−
|status       = workaround
+
  |status   = workaround
−
|summary  = use [[#Grass Growth|Grass Growth]] instead.
+
  |summary  = use [[#Grass Growth|Grass Growth]] instead.
−
 
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,891: Line 2,873:
  
 
   |broke in = SMAPI 3.0
 
   |broke in = SMAPI 3.0
−
|status       = workaround
+
  |status   = workaround
−
|summary  = use [[#Three Heart Flower Festival Dance Partners, 3-heart Dance Partner|Three Heart Flower Festival Dance Partners, 3-heart Dance Partner]] instead.
+
  |summary  = use [[#Three Heart Flower Festival Dance Partners|Three Heart Flower Festival Dance Partners]] instead.
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,985: Line 2,967:
  
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
−
|status       = workaround
+
  |status   = workaround
−
|summary  = use [[#Stardew Notification|Stardew Notification]] instead.
+
  |summary  = use [[#Stardew Notification|Stardew Notification]] instead.
−
 
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,997: Line 2,978:
  
 
   |broke in = SMAPI 3.0
 
   |broke in = SMAPI 3.0
−
   |status       = workaround
+
   |status   = workaround
 
   |summary  = use [[#Auto Trash|Auto Trash]] instead.
 
   |summary  = use [[#Auto Trash|Auto Trash]] instead.
 
}}
 
}}
Line 3,016: Line 2,997:
  
 
   |broke in    = Stardew Valley 1.4
 
   |broke in    = Stardew Valley 1.4
−
|status      = workaround
+
  |status      = workaround
−
|summary = use [[#Auto Gate|Auto Gate]] instead.
+
  |summary     = use [[#Auto Gate|Auto Gate]] instead.
 
   |pull request = https://github.com/mralbobo/stardew-gate-opener/pull/5
 
   |pull request = https://github.com/mralbobo/stardew-gate-opener/pull/5
 
}}
 
}}
Line 3,357: Line 3,338:
  
 
   |broke in = SMAPI 3.0
 
   |broke in = SMAPI 3.0
−
|status  = workaround
+
  |status  = workaround
 
   |summary  = use [[#Health Bars|Health Bars by Zoryn]] instead.
 
   |summary  = use [[#Health Bars|Health Bars by Zoryn]] instead.
 
}}
 
}}
Line 3,890: Line 3,871:
  
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
−
|status       = workaround
+
  |status   = workaround
−
|summary  = use [[#Better Ranching|Better Ranching]] instead.
+
  |summary  = use [[#Better Ranching|Better Ranching]] instead.
−
 
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 3,933: Line 3,913:
  
 
   |broke in = Stardew Valley 1.3.29
 
   |broke in = Stardew Valley 1.3.29
−
|status       = workaround
+
  |status   = workaround
−
|summary  = use [[#Configure Machine Speed|Configure Machine Speed]] instead.
+
  |summary  = use [[#Configure Machine Speed|Configure Machine Speed]] instead.
−
 
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,251: Line 4,230:
  
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
−
|status       = workaround
+
  |status   = workaround
−
|summary  = use [[#One Silo Storage|One Silo Storage]] instead.
+
  |summary  = use [[#One Silo Storage|One Silo Storage]] instead.
−
 
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,605: Line 4,583:
 
   |curseforge key = notes
 
   |curseforge key = notes
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
−
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,738: Line 4,715:
 
   |github  = paritee/Paritee.StardewValley.Frameworks
 
   |github  = paritee/Paritee.StardewValley.Frameworks
  
−
   |broke in = Stardew Valley 1.4
+
   |broke in           = Stardew Valley 1.4
−
|unofficial version = 1.1.1-unofficial.1-Strobe
+
  |unofficial version = 1.1.1-unofficial.1-Strobe
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-54#post-3357614
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-54#post-3357614
 
}}
 
}}
Line 4,764: Line 4,741:
 
   |nexus id = 923
 
   |nexus id = 923
 
   |github  = bmarquismarkail/SV_PotC
 
   |github  = bmarquismarkail/SV_PotC
−
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,795: Line 4,771:
  
 
   |broke in = SMAPI 3.0
 
   |broke in = SMAPI 3.0
−
   |status       = workaround
+
   |status   = workaround
−
|summary  = use [[#Faster Paths|Faster Paths]] instead.
+
  |summary  = use [[#Faster Paths|Faster Paths]] instead.
−
 
 
−
 
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 5,089: Line 5,063:
  
 
   |broke in = SMAPI 3.0
 
   |broke in = SMAPI 3.0
−
|status  = workaround
+
  |status  = workaround
 
   |summary  = use [[#CJB Show Item Sell Price|CJB Show Item Sell Price]] instead.
 
   |summary  = use [[#CJB Show Item Sell Price|CJB Show Item Sell Price]] instead.
 
}}
 
}}
Line 5,672: Line 5,646:
 
   |curseforge key = seed-bag
 
   |curseforge key = seed-bag
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
−
 
−
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 5,784: Line 5,756:
  
 
   |broke in = Stardew Valley 1.4
 
   |broke in = Stardew Valley 1.4
−
|status  = workaround
+
  |status  = workaround
 
   |summary  = use [[#CJB Cheats Menu|CJB Cheats Menu]] instead.
 
   |summary  = use [[#CJB Cheats Menu|CJB Cheats Menu]] instead.
 
}}
 
}}
Line 6,264: Line 6,236:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = SpriteMaster, Sprite Master
+
   |name    = Sprite Master
 
   |author  = Ameise, Ameisen, mkukli
 
   |author  = Ameise, Ameisen, mkukli
 
   |id      = DigitalCarbide.SpriteMaster
 
   |id      = DigitalCarbide.SpriteMaster
Line 6,382: Line 6,354:
 
   |github  = BuildABuddha/StardewDailyPlanner
 
   |github  = BuildABuddha/StardewDailyPlanner
  
−
   |broke in = Stardew Valley 1.4
+
   |broke in           = Stardew Valley 1.4
 
   |unofficial version = 0.5.3-unofficial.1-Cherry
 
   |unofficial version = 0.5.3-unofficial.1-Cherry
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-58#post-3358615
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-58#post-3358615
 
   |pull request      = https://github.com/BuildABuddha/StardewDailyPlanner/pull/3
 
   |pull request      = https://github.com/BuildABuddha/StardewDailyPlanner/pull/3
−
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,642: Line 6,613:
 
   |nexus id = 3203
 
   |nexus id = 3203
 
   |github  =  
 
   |github  =  
−
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,825: Line 6,795:
  
 
   |broke in = SMAPI 3.0
 
   |broke in = SMAPI 3.0
−
|status       = workaround
+
  |status   = workaround
−
|summary  = use [[#Auto Trash|Auto Trash]] instead.
+
  |summary  = use [[#Auto Trash|Auto Trash]] instead.
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 7,003: Line 6,973:
 
   |nexus id = 943
 
   |nexus id = 943
 
   |github  = bmarquismarkail/SV_VerticalToolMenu
 
   |github  = bmarquismarkail/SV_VerticalToolMenu
−
 
 
}}
 
}}
 
{{/entry
 
{{/entry

Revision as of 02:27, 6 February 2020

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).

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. ↑ 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://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Mod_compatibility&oldid=96472"