Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: add new mods (Ocarina of Time, Only Fish Consume Bait, Passable Descents, Passerby Cemetery, Perfect Trinkets, Pet Bowl Sprinklers, Pick Forge Enchantment, Polyamory Sweet Rooms, Positive Predictor, Precision Wheel, Prismatic Butterfly Location, Public Access TV (1.6), Put Batteries in Fish Tanks, Quick Agenda, Recipes In Mail, Recipe Tracker, Re-Mixed Seeds, Safe Lightning Updated, Share Experience), add workarounds (Public Access TV, Safe Lightning, Safe Lightning Redux))
(→‎SMAPI mods: add new mods (Shared Recipes, Shift Toolbar When Paused, Skin Tone Loader, Skinny Animals, Slots Cheats, Small Tree Texture, Special Orders Tweaks, Special Power Utilities, Speed Boots, Stardew Valley Balance Overhaul, Stardew Voices, Stardew Web API, Teleportation Tool, Terraria Accessories, Thai Font Adjuster, The Fish Dimension, The Return of Smaller Fish Ponds, Tileman Redux, Tilt-Shift), add workarounds (Immersive Sprinklers, Smaller Fish Ponds, Tileman Challenge))
Line 9,139: Line 9,139:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
  |status  = workaround
 +
  |summary  = use [[#The Return of Immersive Sprinklers|The Return of Immersive Sprinklers]] instead.
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 15,843: Line 15,845:
 
   |nexus  = 16628
 
   |nexus  = 16628
 
   |github  =
 
   |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Shared Recipes
 +
  |author  = jpslatt, jslattery26
 +
  |id      = jslattery26.SharedRecipes
 +
  |nexus  = 22718
 +
  |github  = jslattery26/stardew_mods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 15,877: Line 15,886:
  
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Shift Toolbar When Paused
 +
  |author  = Zamiel
 +
  |id      = Zamiel.ShiftToolbarWhenPaused
 +
  |nexus  = 21613
 +
  |github  = Zamiell/stardew-valley-mods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 16,316: Line 16,332:
 
   |nexus  = 14452
 
   |nexus  = 14452
 
   |github  = spacechase0/StardewValleyMods
 
   |github  = spacechase0/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Skinny Animals
 +
  |author  = tem696969696969
 +
  |id      = tem696969696969.SkinnyAnimals
 +
  |nexus  = 21826
 +
  |github  = kqrse/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Skin Tone Loader
 +
  |author  = HeyImAmethyst
 +
  |id      = HeyImAmethyst.SkinToneLoader
 +
  |nexus  = 22797
 +
  |github  = HeyImAmethyst/SkinToneLoader
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 16,534: Line 16,564:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Slots Cheats
 +
  |author  = Fischkop2
 +
  |id      = Fischkop2.SlotsCheats
 +
  |nexus  = 22574
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 16,563: Line 16,600:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
  |status  = workaround
 +
  |summary  = use [[#The Return of Smaller Fish Ponds|The Return of Smaller Fish Ponds]] instead.
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Small Tree Texture
 +
  |author  = season
 +
  |id      = season.SmallTreeTexture
 +
  |nexus  = 22285
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 16,802: Line 16,848:
  
 
   |broke in = Stardew Valley 1.6<!--@retest-after AtraCore-->
 
   |broke in = Stardew Valley 1.6<!--@retest-after AtraCore-->
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Special Orders Tweaks
 +
  |author  = nnn
 +
  |id      = nnn.Special_Orders_Tweaks
 +
  |nexus  = 22719
 +
  |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Special Power Utilities
 +
  |author  = Spiderbuttons
 +
  |id      = Spiderbuttons.SpecialPowerUtilities
 +
  |nexus  = 22300
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 16,811: Line 16,871:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Speed Boots
 +
  |author  = season
 +
  |id      = season.SpeedBoots
 +
  |nexus  = 22958
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 17,416: Line 17,483:
  
 
   |broke in = Stardew Valley 1.5.5
 
   |broke in = Stardew Valley 1.5.5
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Stardew Valley Balance Overhaul, Stardew Valley Balance Overhaul Bundles
 +
  |author  = Alvadea & Jaksha & Theoddon
 +
  |id      = Theoddon.SVBOBundlesLoader
 +
  |nexus  = 13426
 +
  |github  = Annosz/UIInfoSuite2
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 17,467: Line 17,541:
 
   |id      = evskii.StardewTimelapse
 
   |id      = evskii.StardewTimelapse
 
   |nexus  = 19806
 
   |nexus  = 19806
 +
  |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Stardew Voices
 +
  |author  = Shannon Hobby
 +
  |id      = shobby.StardewVoices
 +
  |nexus  = 22550
 
   |github  =
 
   |github  =
 
}}
 
}}
Line 17,475: Line 17,556:
 
   |nexus  = 8715
 
   |nexus  = 8715
 
   |github  =
 
   |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Stardew Web API
 +
  |author  = zunderscore
 +
  |id      = zunderscore.StardewWebApi
 +
  |nexus  = 22540
 +
  |github  = zunderscore/StardewWebApi
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 17,973: Line 18,061:
 
   |nexus  = 10190
 
   |nexus  = 10190
 
   |github  = Stingrayss/StardewValley
 
   |github  = Stingrayss/StardewValley
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Teleportation Tool
 +
  |author  = jeWel
 +
  |id      = jeWel.TeleportationToolModCode
 +
  |nexus  = 22534
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 18,023: Line 18,118:
 
   |id      = Rafael.TeleportToFarm
 
   |id      = Rafael.TeleportToFarm
 
   |nexus  = 7247
 
   |nexus  = 7247
 +
  |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Terraria Accessories
 +
  |author  = jeWel
 +
  |id      = jeWel.TerrariaAccessoriesCode
 +
  |nexus  = 22931
 
   |github  =
 
   |github  =
 
}}
 
}}
Line 18,031: Line 18,133:
 
   |nexus  = 21216
 
   |nexus  = 21216
 
   |github  = spacechase0/TestModWorkflow
 
   |github  = spacechase0/TestModWorkflow
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Thai Font Adjuster
 +
  |author  = 'ELL and NRTnarathip
 +
  |id      = ELL.ThaiFontAdjuster
 +
  |nexus  = 9586
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 18,064: Line 18,173:
 
   |moddrop = 804101
 
   |moddrop = 804101
 
   |github  =
 
   |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = The Fish Dimension
 +
  |author  = ichortower
 +
  |id      = ichortower.TheFishDimension
 +
  |nexus  = 22335
 +
  |github  = ichortower/TheFishDimension
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 18,156: Line 18,272:
 
   |nexus  = 20796
 
   |nexus  = 20796
 
   |github  = lucaskfreitas/ImmersiveSprinklers
 
   |github  = lucaskfreitas/ImmersiveSprinklers
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = The Return of Smaller Fish Ponds, Smaller Fish Ponds
 +
  |author  = platinummyr and wellbott
 +
  |id      = platinummyr.SmallerFishPonds
 +
  |nexus  = 21900
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 18,243: Line 18,366:
  
 
   |broke in = Stardew Valley 1.6
 
   |broke in = Stardew Valley 1.6
 +
  |status  = workaround
 +
  |summary  = use [[#Tileman Redux|Tileman Redux]] instead.
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Tileman Redux
 +
  |author  = Freaksaus
 +
  |id      = Freaksaus.TilemanRedux
 +
  |nexus  = 23023
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 18,266: Line 18,398:
 
   |nexus  = 2738
 
   |nexus  = 2738
 
   |github  = bcmpinc/StardewHack
 
   |github  = bcmpinc/StardewHack
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Tilt-Shift - Native Effect Shader
 +
  |author  = misterwu
 +
  |id      = misterwu.tiltshifteffect
 +
  |nexus  = 21959
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry

Revision as of 05:53, 25 April 2024

← Modding:Index
Player's guide to using mods SMAPI mascot.png
SMAPI mod compatibility, July 2017 to March 2021. 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).
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Mod_compatibility&oldid=168934"