Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(Update Bed Tweaks unofficial version)
(→‎SMAPI mods: add new mods (Clear Glasses, Clint's Backstock, Comprehensive Stardew Valley Mod, Custom Home Music, Custom Locks Updated, Daily Tasks Report Plus, Default On Cheats, Deluxe Grabber Redux 1.6, Easy Attack, Easy Chest, Easy Cleaner, Easy Fairy, Easy Fishing, Easy Gift, Easy Harvest, Easy Travel, Easy Valley, Eat & Drink From Inventory, Enchanted Adventurer's Guild Rewards, Enchanted Cowboy Boots, Farm in Paradise); add CurseForge IDs (Custom Companions, Dynamic Reflections))
Line 3,033: Line 3,033:
 
   |nexus  = 794
 
   |nexus  = 794
 
   |github  = tstaples/CleanFarm
 
   |github  = tstaples/CleanFarm
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Clear Glasses, Clear Glasses - HD Graphics and Filters
 +
  |author  = aurpine
 +
  |id      = aurpine.ClearGlasses
 +
  |nexus  = 21090
 +
  |github  = aurpine/Stardew-SpriteMaster
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 3,044: Line 3,051:
 
   |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.
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Clint's Backstock
 +
  |author  = Rokugin
 +
  |id      = Rokugin.ClintsBackstock
 +
  |nexus  = 20886
 +
  |github  = rokugin/StardewMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 3,235: Line 3,249:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Comprehensive Stardew Valley Mod, My Modding
 +
  |author  = BenW, BW
 +
  |id      = BW.MyModding
 +
  |nexus  = 20918
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 3,891: Line 3,912:
 
   |author  = PeacefulEnd
 
   |author  = PeacefulEnd
 
   |id      = PeacefulEnd.CustomCompanions
 
   |id      = PeacefulEnd.CustomCompanions
 +
  |curse  = 870939
 
   |nexus  = 8626
 
   |nexus  = 8626
 
   |github  = Floogen/CustomCompanions
 
   |github  = Floogen/CustomCompanions
Line 4,025: Line 4,047:
 
   |nexus  = 16744
 
   |nexus  = 16744
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Custom Home Music, Zelink's ZeldaHome
 +
  |author  = zelink, zelinknilez
 +
  |id      = zelink.zeldaHome
 +
  |nexus  = 20844
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 4,121: Line 4,150:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Custom Locks Updated
 +
  |author  = Rokugin
 +
  |id      = Rokugin.CustomLocksUpdated
 +
  |nexus  = 21148
 +
  |github  = rokugin/StardewMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 4,573: Line 4,609:
 
   |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/post-56142
 
   |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/post-56142
 
-->
 
-->
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Daily Tasks Report Plus
 +
  |author  = Prism 99
 +
  |id      = Prism99.DailyTasksReportPlus
 +
  |nexus  = 20871
 +
  |github  = Prism-99/DailyTaskReportPlus
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 4,671: Line 4,714:
 
   |nexus  = 12421
 
   |nexus  = 12421
 
   |github  = tylergibbs2/StardewValleyMods
 
   |github  = tylergibbs2/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Default On Cheats
 +
  |author  = EnderTedi
 +
  |id      = EnderTedi.DefaultOnCheats
 +
  |nexus  = 21035
 +
  |github  = EnderTedi/DefaultOnCheats
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 4,706: Line 4,756:
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 
   |status  = workaround
 
   |status  = workaround
   |summary  = use {{nexus mod|20799|Deluxe Grabber Redux 1.6}} instead.
+
   |summary  = use [[#Deluxe Grabber Redux 1.6|Deluxe Grabber Redux 1.6]] instead.
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Deluxe Grabber Redux 1.6
 +
  |author  = Nykal145
 +
  |id      = Nykal145.DeluxeGrabberRedux16
 +
  |nexus  = 20799
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 5,243: Line 5,300:
 
   |author  = PeacefulEnd
 
   |author  = PeacefulEnd
 
   |id      = PeacefulEnd.DynamicReflections
 
   |id      = PeacefulEnd.DynamicReflections
 +
  |curse  = 870926
 
   |nexus  = 12831
 
   |nexus  = 12831
 
   |github  = Floogen/DynamicReflections
 
   |github  = Floogen/DynamicReflections
Line 5,343: Line 5,401:
 
   |nexus  = 11002
 
   |nexus  = 11002
 
   |github  = LeFauxMatt/StardewMods
 
   |github  = LeFauxMatt/StardewMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Easy Attack
 +
  |author  = season
 +
  |id      = season.EasyAttack
 +
  |nexus  = 20832
 +
  |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Easy Chest
 +
  |author  = season
 +
  |id      = season.EasyChest
 +
  |nexus  = 20842
 +
  |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Easy Cleaner
 +
  |author  = season
 +
  |id      = season.EasyCleaner
 +
  |nexus  = 20865
 +
  |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Easy Fairy
 +
  |author  = season
 +
  |id      = season.EasyFairy
 +
  |nexus  = 20931
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 5,363: Line 5,449:
 
   |github  =
 
   |github  =
 
   |source  = https://gitlab.com/delixx/stardew-valley-custom-farm-loader
 
   |source  = https://gitlab.com/delixx/stardew-valley-custom-farm-loader
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Easy Fishing
 +
  |author  = season
 +
  |id      = season.EasyFishing
 +
  |nexus  = 20830
 +
  |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Easy Gift
 +
  |author  = season
 +
  |id      = season.EasyGift
 +
  |nexus  = 20838
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 5,372: Line 5,472:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Easy Harvest
 +
  |author  = season
 +
  |id      = season.EasyHarvest
 +
  |nexus  = 20924
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 5,390: Line 5,497:
 
   |status  = workaround
 
   |status  = workaround
 
   |summary  = use [[#Animal Observer|Animal Observer]] instead.
 
   |summary  = use [[#Animal Observer|Animal Observer]] instead.
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Easy Travel, Easy Move
 +
  |author  = season
 +
  |id      = season.EasyMove
 +
  |nexus  = 20872
 +
  |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Easy Valley
 +
  |author  = season
 +
  |id      = season.EasyValley
 +
  |nexus  = 21181
 +
  |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Eat & Drink From Inventory
 +
  |author  = Zamiel
 +
  |id      = Zamiel.EatDrinkFromInventory
 +
  |nexus  = 21280
 +
  |github  = Zamiell/stardew-valley-mods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 5,485: Line 5,613:
 
   |id      = Goldenrevolver.EnchantableScythes
 
   |id      = Goldenrevolver.EnchantableScythes
 
   |nexus  = 10668
 
   |nexus  = 10668
 +
  |github  = Goldenrevolver/Stardew-Valley-Mods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Enchanted Adventurer's Guild Rewards
 +
  |author  = Goldenrevolver
 +
  |id      = Goldenrevolver.EnchantedAdventurersGuildRewards
 +
  |nexus  = 20942
 +
  |github  = Goldenrevolver/Stardew-Valley-Mods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Enchanted Cowboy Boots
 +
  |author  = Goldenrevolver
 +
  |id      = Goldenrevolver.ObtainableCowboyBoots
 +
  |nexus  = 20941
 
   |github  = Goldenrevolver/Stardew-Valley-Mods
 
   |github  = Goldenrevolver/Stardew-Valley-Mods
 
}}
 
}}
Line 6,076: Line 6,218:
 
   |nexus  = 12457
 
   |nexus  = 12457
 
   |github  = misty-spring/StardewMods
 
   |github  = misty-spring/StardewMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Farm in Paradise, Textura de Neve
 +
  |author  = BrasileiroTop, LKboss
 +
  |id      = LKboss.TexturaNeve
 +
  |nexus  = 13594
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry

Revision as of 03:27, 1 April 2024

SMAPI mod compatibility, July 2017 to present. See notable events which affect this chart.
broken (proprietary)
broken (open-source)
compatible

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 smapi.io/mods 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

  • Players: See smapi.io/mods for a more user-friendly list.
  • Modders: feel free to update this list! (See instructions.) Note that only SMAPI mods should be listed, not XNB mods or content packs.

SMAPI mods (obsolete)

This list contains mods which...

  • have their mod pages hidden/deleted;
  • or have been replaced by a change in the base game;
  • or have been explicitly abandoned by the mod author (unless they're open-source and likely to 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.

Mod data overrides

This section overrides the data specified in mods' manifest.json files or mod pages for SMAPI's update checks. This is a specialized section; in most cases it's better to correct the mod instead. See the format description when editing this section.

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. Change the version in manifest.json to the official version number plus 0.0.1, with -unofficial.1-yourName at the end.
    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).