Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: updated CFR and CF Automate)
(→‎SMAPI mods (obsolete): fix recent changes, fix inconsistent field order)
Line 7,300: Line 7,300:
 
!  
 
!  
 
|-
 
|-
−
{{/entry
 
−
  |name    = Emotes
 
−
  |author  = aurnj, Roy Li
 
−
  |id      = RuyiLi.Emotes
 
−
  |nexus id =
 
−
  |url      = https://community.playstarbound.com/threads/emotes.129159
 
−
  |github  =
 
−
  |status = obsolete
 
−
  |summary  = remove this mod (added in Stardew Valley 1.4).
 
−
 
−
  |broke in = Stardew Valley 1.3
 
−
}}
 
−
{{/entry
 
−
  |name    = Multiplayer Emotes
 
−
  |author  = FerMod
 
−
  |id      = FerMod.MultiplayerEmotes
 
−
  |nexus id = 2347
 
−
  |github  = FerMod/StardewMods
 
−
  |status = obsolete
 
−
  |broke in    = Stardew Valley 1.4
 
−
  |pull request = https://github.com/FerMod/StardewMods/pull/5
 
−
  |summary  = remove this mod (added in Stardew Valley 1.4).
 
−
}}
 
−
{{/entry
 
−
  |name    = Archaeology House Content Management Helper
 
−
  |author  = Felix-Dev
 
−
  |id      = Felix-Dev.ArchaeologyHouseContentManagementHelper
 
−
  |nexus id = 2804
 
−
  |github  = Felix-Dev/StardewMods
 
−
  |status = obsolete
 
−
  |broke in = Stardew Valley 1.4
 
−
 
−
}}
 
−
{{/entry
 
−
  |name    = Wallpaper Fix
 
−
  |author  = Travoos
 
−
  |id      =
 
−
  |nexus id =
 
−
  |curse id =
 
−
  |chucklefish id = 4211
 
−
  |github  =
 
−
  |broke in = SMAPI 2.0
 
−
  |status  = obsolete
 
−
  |summary  = use [[#Wallpaper Recycler|Wallpaper Recycler]] instead.
 
−
 
−
}}
 
−
{{/entry
 
−
  |name    = Auto Stack Items to Chest
 
−
  |author  = Chosimba
 
−
  |id      = Chosimba.AutoStackItemsToChest
 
−
  |nexus id = 2307
 
−
  |github  =
 
−
  |status = obsolete
 
−
|broke in = SMAPI 3.0
 
−
}}
 
 
{{/entry
 
{{/entry
 
   |name    = 4Leaf
 
   |name    = 4Leaf
Line 7,400: Line 7,345:
 
   |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    = Archaeology House Content Management Helper
 +
  |author  = Felix-Dev
 +
  |id      = Felix-Dev.ArchaeologyHouseContentManagementHelper
 +
  |nexus id = 2804
 +
  |github  = Felix-Dev/StardewMods
 +
  |broke in = Stardew Valley 1.4
 +
  |status  = obsolete
 +
  |summary  = remove this mod (added in Stardew Valley 1.4).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 7,409: Line 7,364:
 
   |status  = abandoned
 
   |status  = abandoned
 
   |summary  = remove this mod (no longer maintained; use [[#Deluxe Auto-Grabber|Deluxe Auto-Grabber]] instead).
 
   |summary  = remove this mod (no longer maintained; use [[#Deluxe Auto-Grabber|Deluxe Auto-Grabber]] instead).
 +
}}
 +
{{/entry
 +
  |name    = Auto Stack Items to Chest
 +
  |author  = Chosimba
 +
  |id      = Chosimba.AutoStackItemsToChest
 +
  |nexus id = 2307
 +
  |github  =
 +
  |broke in = SMAPI 3.0
 +
  |status  = obsolete
 +
  |summary  = remove this mod (added in Stardew Valley 1.4).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 7,416: Line 7,381:
 
   |nexus id = 3013
 
   |nexus id = 3013
 
   |github  = KirbyLink/BeeHouseFix
 
   |github  = KirbyLink/BeeHouseFix
−
 
 
   |broke in = Stardew Valley 1.4
 
   |broke in = Stardew Valley 1.4
 
   |status  = obsolete
 
   |status  = obsolete
Line 7,455: Line 7,419:
 
   |nexus id = 2501
 
   |nexus id = 2501
 
   |github  =  
 
   |github  =  
 +
  |broke in = SMAPI 2.8
 
   |status  = abandoned
 
   |status  = abandoned
−
  |broke in = SMAPI 2.8
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 7,480: Line 7,444:
 
   |nexus id = 2500
 
   |nexus id = 2500
 
   |github  =  
 
   |github  =  
 +
  |broke in = Stardew Valley 1.3.29
 
   |status  = abandoned
 
   |status  = abandoned
−
  |broke in = Stardew Valley 1.3.29
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 7,489: Line 7,453:
 
   |nexus id = 3144
 
   |nexus id = 3144
 
   |github  =  
 
   |github  =  
 +
  |broke in = SMAPI 3.0
 
   |status  = abandoned
 
   |status  = abandoned
−
  |broke in = SMAPI 3.0
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 7,528: Line 7,492:
 
   |nexus id = 3718
 
   |nexus id = 3718
 
   |github  =  
 
   |github  =  
−
 
 
   |broke in = Stardew Valley 1.4
 
   |broke in = Stardew Valley 1.4
 
   |status  = abandoned
 
   |status  = abandoned
Line 7,713: Line 7,676:
 
   |nexus id = 513
 
   |nexus id = 513
 
   |github  = janavarro95/Stardew_Valley_Mods
 
   |github  = janavarro95/Stardew_Valley_Mods
−
 
 
   |status  = abandoned
 
   |status  = abandoned
 
   |summary  = remove this mod (no longer maintained; use [[#Billboard Anywhere|Billboard Anywhere]] instead).
 
   |summary  = remove this mod (no longer maintained; use [[#Billboard Anywhere|Billboard Anywhere]] instead).
Line 7,724: Line 7,686:
 
   |github  = danvolchek/StardewMods
 
   |github  = danvolchek/StardewMods
 
   |broke in = Stardew Valley 1.4
 
   |broke in = Stardew Valley 1.4
 +
  |status  = obsolete
 +
  |summary  = remove this mod (added in Stardew Valley 1.4).
 +
}}
 +
{{/entry
 +
  |name    = Emotes
 +
  |author  = aurnj, Roy Li
 +
  |id      = RuyiLi.Emotes
 +
  |nexus id =
 +
  |url      = https://community.playstarbound.com/threads/emotes.129159
 +
  |github  =
 +
  |broke in = Stardew Valley 1.3
 
   |status  = obsolete
 
   |status  = obsolete
 
   |summary  = remove this mod (added in Stardew Valley 1.4).
 
   |summary  = remove this mod (added in Stardew Valley 1.4).
Line 7,742: Line 7,715:
 
   |nexus id = 2309
 
   |nexus id = 2309
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
−
 
 
   |broke in = Stardew Valley 1.4
 
   |broke in = Stardew Valley 1.4
 
   |status  = abandoned
 
   |status  = abandoned
Line 7,904: Line 7,876:
 
   |source  = https://github.com/ylsama/RightClickMoveMode/tree/MoveThoughObjects
 
   |source  = https://github.com/ylsama/RightClickMoveMode/tree/MoveThoughObjects
 
   |dev note = source in separate Git branch
 
   |dev note = source in separate Git branch
−
 
 
   |broke in = Stardew Valley 1.4
 
   |broke in = Stardew Valley 1.4
 
   |status  = abandoned
 
   |status  = abandoned
 
   |summary  = remove this mod (no longer maintained; use [[#Noclip Mode|Noclip Mode]] or [[#Passable Objects|Passable Objects]] instead).
 
   |summary  = remove this mod (no longer maintained; use [[#Noclip Mode|Noclip Mode]] or [[#Passable Objects|Passable Objects]] instead).
 +
}}
 +
{{/entry
 +
  |name    = Multiplayer Emotes
 +
  |author  = FerMod
 +
  |id      = FerMod.MultiplayerEmotes
 +
  |nexus id = 2347
 +
  |github  = FerMod/StardewMods
 +
  |broke in = Stardew Valley 1.4
 +
  |status  = obsolete
 +
  |summary  = remove this mod (added in Stardew Valley 1.4).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 7,925: Line 7,906:
 
   |nexus id = 2922
 
   |nexus id = 2922
 
   |github  = Prince-Leto/StardewValleyMods
 
   |github  = Prince-Leto/StardewValleyMods
−
   |broke in   = Stardew Valley 1.4
+
   |broke in = Stardew Valley 1.4
 
   |status  = obsolete
 
   |status  = obsolete
 
   |summary  = remove this mod (fixed in Stardew Valley 1.4).
 
   |summary  = remove this mod (fixed in Stardew Valley 1.4).
Line 8,062: Line 8,043:
 
   |nexus id = 3086
 
   |nexus id = 3086
 
   |github  =  
 
   |github  =  
−
 
 
   |broke in = Stardew Valley 1.4
 
   |broke in = Stardew Valley 1.4
 
   |status  = obsolete
 
   |status  = obsolete
Line 8,178: Line 8,158:
 
   |broke in = Stardew Valley 1.3.29
 
   |broke in = Stardew Valley 1.3.29
 
   |status  = abandoned
 
   |status  = abandoned
 +
}}
 +
{{/entry
 +
  |name    = Wallpaper Fix
 +
  |author  = Travoos
 +
  |id      =
 +
  |nexus id =
 +
  |curse id =
 +
  |chucklefish id = 4211
 +
  |github  =
 +
  |broke in = SMAPI 2.0
 +
  |status  = obsolete
 +
  |summary  = remove this mod (added in Stardew Valley 1.4; for wallpaper swapping use [[#Wallpaper Recycler|Wallpaper Recycler]] instead).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 8,185: Line 8,177:
 
   |nexus id = 450
 
   |nexus id = 450
 
   |github  =  
 
   |github  =  
 +
  |broke in = Stardew Valley 1.1
 
   |status  = abandoned
 
   |status  = abandoned
−
  |broke in = Stardew Valley 1.1
 
 
}}
 
}}
 
|}
 
|}

Revision as of 00:11, 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=96470"