Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: updated: Quality Products + Auto Quality Patch)
(→‎For players: abandoned: Auto-Grabber Mod (mod page + repo deleted))
(4 intermediate revisions by the same user not shown)
Line 79: Line 79:
 
   |nexus id = 2631
 
   |nexus id = 2631
 
   |github  =  
 
   |github  =  
 +
 +
  |beta broke in = Stardew Valley 1.4
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 131: Line 133:
 
   |github  = Entoarox/StardewMods
 
   |github  = Entoarox/StardewMods
  
−
   |beta broke in = Stardew Valley 1.4
+
   |beta broke in           = Stardew Valley 1.4
 
   |beta unofficial version = 1.4.8-unofficial.2-pathoschild
 
   |beta unofficial version = 1.4.8-unofficial.2-pathoschild
−
   |beta unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/#post-3343690
+
   |beta unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/#post-3345830
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 356: Line 358:
  
 
   |beta broke in = Stardew Valley 1.4
 
   |beta broke in = Stardew Valley 1.4
 +
}}
 +
{{/entry
 +
  |name    = Artifact Digger
 +
  |author  = Mizzion
 +
  |id      = mizzion.artifactdigger
 +
  |nexus id = 4212
 +
  |github  = Mizzion/MyStardewMods
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 470: Line 479:
 
   |links              = https://github.com/StephenKairos/Teban100-StardewMods/pull/3
 
   |links              = https://github.com/StephenKairos/Teban100-StardewMods/pull/3
 
   |link labels        = PR
 
   |link labels        = PR
−
}}
 
−
{{/entry
 
−
  |name    = Auto-Grabber Mod
 
−
  |author  = Jotser
 
−
  |id      = Jotser.AutoGrabberMod
 
−
  |nexus id = 2783
 
−
  |github  = jotser/StardewMods
 
−
 
−
  |beta broke in = Stardew Valley 1.4
 
−
  |links        = https://github.com/jotser/StardewMods/pull/8
 
−
  |link labels  = PR
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 819: Line 817:
 
   |nexus id = 859
 
   |nexus id = 859
 
   |github  = urbanyeti/stardew-better-ranching
 
   |github  = urbanyeti/stardew-better-ranching
 +
 +
  |beta broke in = Stardew Valley 1.4
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 895: Line 895:
 
   |links              = https://gitlab.com/speeder1/SMAPISprinklerMod/merge_requests/6
 
   |links              = https://gitlab.com/speeder1/SMAPISprinklerMod/merge_requests/6
 
   |link labels        = PR
 
   |link labels        = PR
 +
}}
 +
{{/entry
 +
  |name    = Better Train Loot
 +
  |author  = AairTheGreat, Aair, AairTheGreat
 +
  |id      = AairTheGreat.BetterTrainLoot
 +
  |nexus id = 4234
 +
  |github  = AairTheGreat/StardewValleyMods
 +
 +
  |beta broke in = Stardew Valley 1.4
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,129: Line 1,138:
 
   |links              = https://github.com/KabigonFirst/StardewValleyMods/pull/3
 
   |links              = https://github.com/KabigonFirst/StardewValleyMods/pull/3
 
   |link labels        = PR
 
   |link labels        = PR
−
 
−
  |beta broke in = Stardew Valley 1.4
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,231: Line 1,238:
 
   |nexus id = 1030
 
   |nexus id = 1030
 
   |github  = deLaDude/ChefsCloset
 
   |github  = deLaDude/ChefsCloset
 +
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
 
   |status  = workaround
 
   |status  = workaround
 
   |summary  = use [[#Remote Fridge Storage|Remote Fridge Storage]] instead.
 
   |summary  = use [[#Remote Fridge Storage|Remote Fridge Storage]] instead.
 +
 +
  |beta status = broken
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,396: Line 1,406:
 
   |nexus id = 3718
 
   |nexus id = 3718
 
   |github  =  
 
   |github  =  
 +
 +
  |beta broke in = Stardew Valley 1.4
 +
  |beta status  = workaround
 +
  |beta summary  = use [[#24h Clock|24h Clock]] by Lajna instead.
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,780: Line 1,794:
 
   |nexus id = 1402
 
   |nexus id = 1402
 
   |github  = JohnsonNicholas/SDVMods
 
   |github  = JohnsonNicholas/SDVMods
 +
 +
  |beta broke in = Stardew Valley 1.4
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,153: Line 2,169:
 
   | nexus id = 4029
 
   | nexus id = 4029
 
   | github  =  
 
   | github  =  
 +
 +
  |beta broke in = Stardew Valley 1.4
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,269: Line 2,287:
  
 
   |beta broke in          = Stardew Valley 1.4
 
   |beta broke in          = Stardew Valley 1.4
−
   |beta unofficial version = 2.4.3-unofficial.2-pathoschild
+
   |beta unofficial version = 2.4.7-unofficial.1-pathoschild
−
   |beta unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/#post-3343690
+
   |beta unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/#post-3345830
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,337: Line 2,355:
 
   |status  = workaround
 
   |status  = workaround
 
   |summary  = use [[#Remote Fridge Storage|Remote Fridge Storage]] instead.
 
   |summary  = use [[#Remote Fridge Storage|Remote Fridge Storage]] instead.
 +
 +
  |beta status = broken
 
<!--note: 1.1.1-unofficial.4 causes item loss.
 
<!--note: 1.1.1-unofficial.4 causes item loss.
 
   |unofficial url = https://community.playstarbound.com/attachments/extendedfridge-1-1-1-unofficial-4-mizzion-zip.202825/
 
   |unofficial url = https://community.playstarbound.com/attachments/extendedfridge-1-1-1-unofficial-4-mizzion-zip.202825/
Line 2,716: Line 2,736:
 
   |nexus id = 2206
 
   |nexus id = 2206
 
   |github  = skuldomg/freeDusty
 
   |github  = skuldomg/freeDusty
 +
 +
  |beta broke in = Stardew Valley 1.4
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 3,259: Line 3,281:
 
   |nexus id = 4023
 
   |nexus id = 4023
 
   |github  =  
 
   |github  =  
 +
 +
  |beta broke in = Stardew Valley 1.4
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,126: Line 4,150:
 
   |nexus id = 1084
 
   |nexus id = 1084
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
 +
 +
  |beta broke in = Stardew Valley 1.4
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,243: Line 4,269:
 
   |nexus id = 923
 
   |nexus id = 923
 
   |github  = bmarquismarkail/SV_PotC
 
   |github  = bmarquismarkail/SV_PotC
 +
 +
  |beta broke in = Stardew Valley 1.4
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,366: Line 4,394:
  
 
   |beta broke in = Stardew Valley 1.4
 
   |beta broke in = Stardew Valley 1.4
 +
  |beta status  = workaround
 +
  |beta summary  = use [[#Pet Interaction|Pet Interaction]] instead.
 
   |links        = https://github.com/jlfulmer/PetEnhancementMod/pull/2
 
   |links        = https://github.com/jlfulmer/PetEnhancementMod/pull/2
 
   |link labels  = PR
 
   |link labels  = PR
 +
}}
 +
{{/entry
 +
  |name    = Pet Interaction
 +
  |author  = jahangmar
 +
  |id      = jahangmar.PetInteraction
 +
  |nexus id = 4232
 +
  |github  = jahangmar/StardewValleyMods
 +
 +
  |beta broke in = Stardew Valley 1.4
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,384: Line 4,423:
 
   |nexus id = 2071
 
   |nexus id = 2071
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
 +
 +
  |beta broke in = Stardew Valley 1.4
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,799: Line 4,840:
 
   |nexus id = 2545
 
   |nexus id = 2545
 
   |github  = SoapStuff/Remote-Fridge-Storage
 
   |github  = SoapStuff/Remote-Fridge-Storage
 +
 +
  |beta broke in = Stardew Valley 1.4
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 5,601: Line 5,644:
 
   |nexus id = 2053
 
   |nexus id = 2053
 
   |github  = danvolchek/StardewMods
 
   |github  = danvolchek/StardewMods
 +
 +
  |beta broke in = Stardew Valley 1.4
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 5,727: Line 5,772:
 
   |nexus id = 3917
 
   |nexus id = 3917
 
   |github  = rei2hu/stardewvalley-esp
 
   |github  = rei2hu/stardewvalley-esp
−
 
−
  |beta broke in          = SMAPI 3.0
 
−
  |beta unofficial version = 1.1.1-unofficial.1-pathoschild
 
−
  |beta unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/page-79#post-3345252
 
−
  |links                  = https://github.com/rei2hu/stardewvalley-esp/pull/1
 
−
  |link labels            = PR
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 5,805: Line 5,844:
 
   |nexus id = 4014
 
   |nexus id = 4014
 
   |github  = Entoarox/StardewMods
 
   |github  = Entoarox/StardewMods
 +
 +
  |beta broke in = Stardew Valley 1.4
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,284: Line 6,325:
 
   |github  = Shalankwa/SDV_Mods
 
   |github  = Shalankwa/SDV_Mods
  
−
   |broke in          = Stardew Valley 1.3.29
+
   |broke in          = Stardew Valley 1.4
−
  |unofficial version = 1.1.1-unofficial.2-pathoschild
 
−
  |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/page-61#post-3329043
 
−
  |links              = https://github.com/Shalankwa/SDV_Mods/pull/5
 
−
  |link labels        = PR
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,531: Line 6,568:
 
   |status  = obsolete
 
   |status  = obsolete
 
   |summary  = remove this mod (only needed on the host now).
 
   |summary  = remove this mod (only needed on the host now).
 +
}}
 +
{{/entry
 +
  |name    = Auto-Grabber Mod
 +
  |author  = Jotser
 +
  |id      = Jotser.AutoGrabberMod
 +
  |nexus id = 2783
 +
  |github  = jotser/StardewMods
 +
  |status  = abandoned
 +
  |summary  = remove this mod (no longer maintained; use [[#Deluxe Auto-Grabber|Deluxe Auto-Grabber]] instead).
 
}}
 
}}
 
{{/entry
 
{{/entry

Revision as of 21:50, 22 July 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

 
 88% are compatible or have a working alternative.
 
 4% have an update coming soon.
 
 8% 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://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Mod_compatibility&oldid=85022"