Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: add ModDrop ID for Fishing Nets)
(→‎SMAPI mods: add new mods: AFK Pause, Auto-Grab Truffles, Better Festival Notifications, Breeding Overhaul, Challenger, Change Farm Caves, Custom Starter Package, Cycle Tools, Fast Fish Ponds (and Rebalancing), Frame Rate Viewer, Furniture Placement Tweaks, Galaxy Slingshot Obtainable, Gift Rejection, I Don't Use That Water, In-Game SMAPI Log Uploader, Multi Yield Crops and Deluxe Grabber Redux Compatibility Patch, OK Night Check, Personal Traveling Cart, Playground Mod, Secret Hedge Maze)
Line 281: Line 281:
  
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = AFK Pause, AFK Time Pause
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.AFKTimePause
 +
  |nexus id = 14228
 +
  |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 839: Line 846:
 
   |nexus id = 820
 
   |nexus id = 820
 
   |github  = StephenKairos/Teban100-StardewMods
 
   |github  = StephenKairos/Teban100-StardewMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Auto-Grab Truffles
 +
  |author  = Tsin
 +
  |id      = Tsin.AutoGrabTruffles
 +
  |nexus id = 14162
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 1,216: Line 1,230:
 
   |nexus id = 12802
 
   |nexus id = 12802
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Better Festival Notifications
 +
  |author  = drbirbdev
 +
  |id      = drbirbdev.BetterFestivalNotifications
 +
  |nexus id = 14170
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 1,687: Line 1,708:
 
   |nexus id = 5105
 
   |nexus id = 5105
 
   |github  =  
 
   |github  =  
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Breeding Overhaul
 +
  |author  = StarAmy
 +
  |id      = StarAmy.BreedingOverhaul
 +
  |nexus id = 13974
 +
  |github  = StarAmy/BreedingOverhaul
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 1,958: Line 1,986:
 
   |nexus id = 5104
 
   |nexus id = 5104
 
   |github  = mus-candidus/CellarAvailable
 
   |github  = mus-candidus/CellarAvailable
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Challenger
 +
  |author  = Slothsoft
 +
  |id      = Slothsoft.Challenger
 +
  |nexus id = 14196
 +
  |github  = slothsoft/stardew-challenger
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Challenger → Automate
 +
  |author  = Slothsoft
 +
  |id      = Slothsoft.ChallengerAutomate
 +
  |nexus id = 14196
 +
  |github  = slothsoft/stardew-challenger
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 1,992: Line 2,034:
 
   |moddrop id = 800760
 
   |moddrop id = 800760
 
   |github  =  
 
   |github  =  
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Change Farm Caves
 +
  |author  = MindMeltMax
 +
  |id      = MindMeltMax.ChangeFarmCaves
 +
  |moddrop id = 1247516
 +
  |nexus id = 14000
 +
  |github  = MindMeltMax/Stardew-Valley-Mods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 3,252: Line 3,302:
 
   |id      = aedenthorn.CustomSpouseRooms
 
   |id      = aedenthorn.CustomSpouseRooms
 
   |nexus id = 10029
 
   |nexus id = 10029
 +
  |github  = aedenthorn/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Custom Starter Package
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.CustomStarterPackage
 +
  |nexus id = 14152
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
Line 3,356: Line 3,413:
 
   |nexus id = 9571
 
   |nexus id = 9571
 
   |github  = harshlele/CutTheCord
 
   |github  = harshlele/CutTheCord
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Cycle Tools
 +
  |author  = furyx639
 +
  |id      = furyx639.CycleTools
 +
  |nexus id = 13973
 +
  |github  = ImJustMatt/StardewMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 4,689: Line 4,753:
 
   |status  = workaround
 
   |status  = workaround
 
   |summary  = use [[#Auto Speed|Auto Speed]] instead.
 
   |summary  = use [[#Auto Speed|Auto Speed]] instead.
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Fast Fish Ponds (and Rebalancing), Fast Fish Pond
 +
  |author  = zeldela
 +
  |id      = zeldela.FastFishPond
 +
  |nexus id = 14005
 +
  |github  = zeldela/sdv-mods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 5,224: Line 5,295:
  
 
   |broke in = Stardew Valley 1.5
 
   |broke in = Stardew Valley 1.5
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Frame Rate Viewer, FPS Viewer
 +
  |author  = Adham084
 +
  |id      = adham084.fpsviewer
 +
  |nexus id = 14046
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 5,337: Line 5,415:
 
   |id      = aedenthorn.FurnitureDisplayFramework
 
   |id      = aedenthorn.FurnitureDisplayFramework
 
   |nexus id = 10855
 
   |nexus id = 10855
 +
  |github  = aedenthorn/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Furniture Placement Tweaks
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.FurniturePlacementTweaks
 +
  |nexus id = 14092
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
Line 5,352: Line 5,437:
 
   |nexus id = 10696
 
   |nexus id = 10696
 
   |github  = ImJustMatt/StardewMods
 
   |github  = ImJustMatt/StardewMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Galaxy Slingshot Obtainable
 +
  |author  = Adham084
 +
  |id      = adham084.galaxyslingshot
 +
  |nexus id = 14115
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 5,499: Line 5,591:
 
   |nexus id = 6944
 
   |nexus id = 6944
 
   |github  = desto-git/sdv-mods
 
   |github  = desto-git/sdv-mods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Gift Rejection
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.GiftRejection
 +
  |nexus id = 14273
 +
  |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 6,203: Line 6,302:
 
   |summary      = use [[#Idle Pause|Idle Pause]] instead.
 
   |summary      = use [[#Idle Pause|Idle Pause]] instead.
 
   |pull request = https://github.com/emperorzuul/SMAPI_MODS/pull/2
 
   |pull request = https://github.com/emperorzuul/SMAPI_MODS/pull/2
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = I Don't Use That Water
 +
  |author  = idermailer
 +
  |id      = idermailer.iDontUseThatWater
 +
  |nexus id = 14047
 +
  |github  = idermailer/iDontUseThatWater
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 6,339: Line 6,445:
 
   |curseforge key = infinite-zoom
 
   |curseforge key = infinite-zoom
 
   |github  = berkayylmao/StardewValleyMods
 
   |github  = berkayylmao/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = In-Game SMAPI Log Uploader, Log Uploader
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.LogUploader
 +
  |nexus id = 13979
 +
  |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 6,362: Line 6,475:
 
   |nexus id = 9573
 
   |nexus id = 9573
 
   |github  = joisse1101/InstantAnimals
 
   |github  = joisse1101/InstantAnimals
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Instant Building Construction and Upgrade, Instant Building Construction
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.InstantBuildingConstruction
 +
  |nexus id = 14110
 +
  |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 6,955: Line 7,075:
 
   |nexus id = 11637
 
   |nexus id = 11637
 
   |github  =
 
   |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Literally Can't Even
 +
  |author  = spacechase0
 +
  |id      = spacechase0.LiterallyCantEven
 +
  |nexus id = 14262
 +
  |github  = spacechase0/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 8,110: Line 8,237:
 
   |nexus id = 6069
 
   |nexus id = 6069
 
   |github  = ChroniclerCherry/stardew-valley-mods
 
   |github  = ChroniclerCherry/stardew-valley-mods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Multi Yield Crops and Deluxe Grabber Redux Compatibility Patch, MYC-DGR Compatibility Patch
 +
  |author  = Jacque Pott
 +
  |id      = JacquePott.MYCDGRPatch
 +
  |nexus id = 14023
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 8,565: Line 8,699:
 
   |moddrop id = 131148
 
   |moddrop id = 131148
 
   |github  = spacechase0/StardewValleyMods
 
   |github  = spacechase0/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = OK Night Check
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.OKNightCheck
 +
  |nexus id = 14231
 +
  |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 8,952: Line 9,093:
 
   |nexus id = 8616
 
   |nexus id = 8616
 
   |github  = ceruleandeep/CeruleanStardewMods
 
   |github  = ceruleandeep/CeruleanStardewMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Personal Traveling Cart
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.PersonalTravellingCart
 +
  |nexus id = 14087
 +
  |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 9,164: Line 9,312:
 
   |nexus id = 7373
 
   |nexus id = 7373
 
   |github  = ha1fdaew/PlayerIncomeStats
 
   |github  = ha1fdaew/PlayerIncomeStats
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Playground Mod
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.PlaygroundMod
 +
  |nexus id = 14125
 +
  |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 10,545: Line 10,700:
 
   |nexus id = 7537
 
   |nexus id = 7537
 
   |github  = Janglinator/Secretariat
 
   |github  = Janglinator/Secretariat
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Secret Hedge Maze, Hedge Maze
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.HedgeMaze
 +
  |nexus id = 14138
 +
  |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry

Revision as of 01:51, 30 October 2022

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