Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: add CurseForge ID for Keybind UI)
(→‎SMAPI mods: add new mods (AchtuurCore, Archery - Starter Pack, Bat Form, Chatter, Combat Dummies, Crop Walker, Custom Hay, Custom Starter Furniture, Desert Bloom Farm, Farmhouse Fixes, Hopper Extractor, Let Me Shop, Mine Tweaks, Mini Tool NPC, Multiplayer Mod, Quick Forward Dash, Rainbow Cursor, Shared Professions, Skull Cavern Drill Redux, Sleep Wherever, Stardew Aquarium Informant, Stardew Twitch Tracker, This Mod Is Organic))
Line 89: Line 89:
 
   |nexus id = 10755
 
   |nexus id = 10755
 
   |github  =  
 
   |github  =  
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = AchtuurCore
 +
  |author  = Achtuur
 +
  |id      = Achtuur.AchtuurCore
 +
  |nexus id = 16827
 +
  |github  = Achtuur/StardewTravelSkill
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 685: Line 692:
 
   |id      = PeacefulEnd.Archery
 
   |id      = PeacefulEnd.Archery
 
   |nexus id = 16767
 
   |nexus id = 16767
 +
  |github  = Floogen/Archery
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Archery - Starter Pack
 +
  |author  = PeacefulEnd
 +
  |id      = PeacefulEnd.Archery.StarterPack.Code
 +
  |nexus id = 16768
 
   |github  = Floogen/Archery
 
   |github  = Floogen/Archery
 
}}
 
}}
Line 1,098: Line 1,112:
 
   |nexus id = 833
 
   |nexus id = 833
 
   |github  = littleraskol/Basic-Sprinkler-Improved
 
   |github  = littleraskol/Basic-Sprinkler-Improved
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Bat Form
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.BatForm
 +
  |nexus id = 16825
 +
  |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 2,209: Line 2,230:
 
   |moddrop id = 833554
 
   |moddrop id = 833554
 
   |github  = danvolchek/StardewMods
 
   |github  = danvolchek/StardewMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Chatter
 +
  |author  = Jboss
 +
  |id      = Jboss.Chatter
 +
  |nexus id = 16559
 +
  |github  = jbossjaslow/Chatter
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 2,530: Line 2,558:
 
   |nexus id = 10496
 
   |nexus id = 10496
 
   |github  = NormanPCN/StardewValleyMods
 
   |github  = NormanPCN/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Combat Dummies, Combat Dummy
 +
  |author  = PeacefulEnd
 +
  |id      = PeacefulEnd.CombatDummy
 +
  |nexus id = 16769
 +
  |github  = Floogen/CombatDummy
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 3,030: Line 3,065:
 
   |nexus id = 11467
 
   |nexus id = 11467
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Crop Walker
 +
  |author  = MindMeltMax
 +
  |id      = MindMeltMax.CropWalker
 +
  |nexus id = 16632
 +
  |github  = MindMeltMax/Stardew-Valley-Mods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 3,206: Line 3,248:
 
   |id      = aedenthorn.CustomGiftLimits
 
   |id      = aedenthorn.CustomGiftLimits
 
   |nexus id = 13964
 
   |nexus id = 13964
 +
  |github  = aedenthorn/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Custom Hay
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.CustomHay
 +
  |nexus id = 16744
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
Line 3,451: Line 3,500:
 
   |id      = aedenthorn.CustomSpouseRooms
 
   |id      = aedenthorn.CustomSpouseRooms
 
   |nexus id = 10029
 
   |nexus id = 10029
 +
  |github  = aedenthorn/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Custom Starter Furniture
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.CustomStarterFurniture
 +
  |nexus id = 16729
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
Line 3,794: Line 3,850:
 
   |nexus id = 5477
 
   |nexus id = 5477
 
   |github  = KeelanRosa/StardewMods
 
   |github  = KeelanRosa/StardewMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Desert Bloom Farm
 +
  |author  = DeLiXx
 +
  |id      = DeLiXx.Desert_Bloom_Farm
 +
  |nexus id = 16750
 +
  |github  =
 +
  |source  = https://gitlab.com/delixx/stardew-valley-desert-bloom-farm
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 4,884: Line 4,948:
 
   |nexus id = 13153
 
   |nexus id = 13153
 
   |github  = 2Retr0/FarmhandFinder
 
   |github  = 2Retr0/FarmhandFinder
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Farmhouse Fixes
 +
  |author  = CyanFire
 +
  |id      = CF.FarmhouseFixes
 +
  |nexus id = 16507
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 5,678: Line 5,749:
 
   |nexus id = 11422
 
   |nexus id = 11422
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Full Romanceable Witch NPC, Witch Events Shop
 +
  |author  = jennisimone
 +
  |id      = jennisimone.WitchEventsShop
 +
  |nexus id = 16304
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 6,502: Line 6,580:
 
   |nexus id = 4935
 
   |nexus id = 4935
 
   |github  = MouseyPounds/stardew-mods
 
   |github  = MouseyPounds/stardew-mods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Hopper Extractor
 +
  |author  = BPavol, Lamacik
 +
  |id      = bpavol.hopper_extractor
 +
  |nexus id = 16688
 +
  |github  = BPavol/stardew-valley-mods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 7,536: Line 7,621:
 
   |nexus id = 8205
 
   |nexus id = 8205
 
   |github  = Ophaneom/Let-Me-Rest
 
   |github  = Ophaneom/Let-Me-Rest
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Let Me Shop
 +
  |author  = MindMeltMax
 +
  |id      = MindMeltMax.LetMeShop
 +
  |nexus id = 16738
 +
  |github  = StardewModders/mod-ideas
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 8,178: Line 8,270:
 
   |nexus id = 3963
 
   |nexus id = 3963
 
   |github  = JPANv2/Stardew-Valley-Mine-Changes
 
   |github  = JPANv2/Stardew-Valley-Mine-Changes
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Mine Tweaks
 +
  |author  = Shockah
 +
  |id      = Shockah.MineTweaks
 +
  |nexus id = 16859
 +
  |github  = Shockah/Stardew-Valley-Mods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 8,185: Line 8,284:
 
   |nexus id = 8329
 
   |nexus id = 8329
 
   |github  = Ophaneom/Mini-Bars
 
   |github  = Ophaneom/Mini-Bars
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Mini Tool NPC
 +
  |author  = Tran Minh Thong
 +
  |id      = mini.tool.npc.mod
 +
  |nexus id = 7060
 +
  |github  = TMThong/Stardew-Mods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 8,784: Line 8,890:
 
   |nexus id = 16030
 
   |nexus id = 16030
 
   |github  = scayze/multiprairie
 
   |github  = scayze/multiprairie
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Multiplayer Mod
 +
  |author  = Tran Minh Thong
 +
  |id      = multiplayer.mod
 +
  |nexus id = 16582
 +
  |github  = TMThong/Stardew-Mods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 10,568: Line 10,681:
 
   |nexus id = 16403
 
   |nexus id = 16403
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Quick Forward Dash, Warp Mod
 +
  |author  = Vexorth
 +
  |id      = Vexorth.Warp
 +
  |nexus id = 16605
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 10,652: Line 10,772:
 
   |nexus id = 7630
 
   |nexus id = 7630
 
   |github  = kakashigr/stardew-radioactivetools
 
   |github  = kakashigr/stardew-radioactivetools
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Rainbow Cursor
 +
  |author  = Jamie Taylor
 +
  |id      = jltaylor-us.RainbowCursor
 +
  |nexus id = 15886
 +
  |github  = jltaylor-us/StardewRainbowCursor
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 11,696: Line 11,823:
 
   |moddrop id = 1269698
 
   |moddrop id = 1269698
 
   |nexus id = 14607
 
   |nexus id = 14607
 +
  |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Shared Professions
 +
  |author  = virtualbjorn
 +
  |id      = virtualbjorn.SharedProfessions
 +
  |nexus id = 16628
 
   |github  =
 
   |github  =
 
}}
 
}}
Line 12,138: Line 12,272:
 
   |nexus id = 6121
 
   |nexus id = 6121
 
   |github  = S1mmyy/StardewMods
 
   |github  = S1mmyy/StardewMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Skull Cavern Drill Redux
 +
  |author  = NetworkOverflow
 +
  |id      = NetworkOverflow.SkullCavernDrillRedux
 +
  |nexus id = 16533
 +
  |github  = AndrewGraber/Skull-Cavern-Drill-Redux
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 12,152: Line 12,293:
 
   |nexus id = 7908
 
   |nexus id = 7908
 
   |github  = TheMightyAmondee/SkullCavernToggle
 
   |github  = TheMightyAmondee/SkullCavernToggle
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Sleep Wherever
 +
  |author  = Vexorth
 +
  |id      = Vexorth.SleepWherever
 +
  |nexus id = 16674
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 12,850: Line 12,998:
 
   |nexus id = 6372
 
   |nexus id = 6372
 
   |github  = ChroniclerCherry/stardew-valley-mods
 
   |github  = ChroniclerCherry/stardew-valley-mods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Stardew Aquarium Informant, Informant - Stardew Aquarium Add-on
 +
  |author  = Moonwolf, Moonwolf287
 +
  |id      = Moonwolf.StardewAquariumInformant
 +
  |nexus id = 16527
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 13,035: Line 13,190:
  
 
   |broke in = Stardew Valley 1.5.5
 
   |broke in = Stardew Valley 1.5.5
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Stardew Twitch Tracker
 +
  |author  = Cody, Cody Hansen
 +
  |id      = cody.StardewTwitchTrackerMod
 +
  |nexus id = 16543
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 13,595: Line 13,757:
 
   |nexus id = 9546
 
   |nexus id = 9546
 
   |github  = Prism-99/Think-n-Talk
 
   |github  = Prism-99/Think-n-Talk
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = This Mod Is Organic
 +
  |author  = RealSweetPanda, Sweet Panda and Bennoloth
 +
  |id      = SweetPanda.Organic
 +
  |nexus id = 16648
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry

Revision as of 00:52, 31 May 2023

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