Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: add new mods (AtraCore, Better Elevator, Carry Your Pet, Catalogue Filter, Character Wiki Linker, Controller Radial Keybindings, Dimensional Pockets, Durin's Rest, Dynamic Bodies, Dynamic Dialogues Framework, Fish Tank Bubble Toggle, Fix TVs on Custom Farm Types, Gradient Hair Colors, Holiday Sales, Infinite Watering Cans, Into the Game (Save Loaded Notifier), Item Recovery Plus, Krobus Roommate Shop, Marry Morris, More for Leo, Nexus Mods Button, Phone Traveling Cart))
(→‎SMAPI mods: add new mods (Planned Parenthood, Play Prairie King With NPCs, Prismatic Clothing, Prismatic Fire, Rummage - The Thievery Mod, Skateboard, Sound Loop Mod, Surprise Pregnancy, Tap Giant Crops, Toolbar Icons, Zen Mod))
Line 8,865: Line 8,865:
 
   |moddrop id = 793846
 
   |moddrop id = 793846
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Planned Parenthood
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.PlannedParenthood
 +
  |nexus id = 12869
 +
  |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 8,920: Line 8,927:
 
   |moddrop id = 793920
 
   |moddrop id = 793920
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Play Prairie King With NPCs, Two Player Prairie King
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.TwoPlayerPrairieKing
 +
  |nexus id = 12750
 +
  |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 9,159: Line 9,173:
 
   |status  = workaround
 
   |status  = workaround
 
   |summary  = use [[#CJB Show Item Sell Price|CJB Show Item Sell Price]] instead.
 
   |summary  = use [[#CJB Show Item Sell Price|CJB Show Item Sell Price]] instead.
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Prismatic Clothing
 +
  |author  = atravita
 +
  |id      = atravita.PrismaticClothing
 +
  |moddrop id = 1205162
 +
  |nexus id = 13051
 +
  |github  = atravita-mods/StardewMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Prismatic Fire
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.PrismaticFire
 +
  |nexus id = 12931
 +
  |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 10,026: Line 10,055:
 
   |unofficial version = 1.0.1-unofficial.3-pathoschild
 
   |unofficial version = 1.0.1-unofficial.3-pathoschild
 
   |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/post-61318
 
   |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/post-61318
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Rummage - The Thievery Mod
 +
  |author  = ApryllForever
 +
  |id      = ApryllForever.RestStop.Rummage
 +
  |nexus id = 12764
 +
  |github  = ApryllForever/Rummage
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 10,682: Line 10,718:
 
   |id      = aedenthorn.SixtyNine
 
   |id      = aedenthorn.SixtyNine
 
   |nexus id = 6969
 
   |nexus id = 6969
 +
  |github  = aedenthorn/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Skateboard
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.Skateboard
 +
  |nexus id = 13096
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
Line 11,022: Line 11,065:
 
   |nexus id = 10232
 
   |nexus id = 10232
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Sound Loop Mod
 +
  |author  = strelkasaur
 +
  |id      = com.strelkasaurus.sm.soundloop
 +
  |nexus id = 13099
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 11,709: Line 11,759:
 
   |nexus id = 6688
 
   |nexus id = 6688
 
   |github  = spacechase0/StardewValleyMods
 
   |github  = spacechase0/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Surprise Pregnancy, SurpriseBaby1
 +
  |author  = MiphasGrace
 +
  |id      = MiphasGrace.SurpriseBaby1
 +
  |nexus id = 13126
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 11,772: Line 11,829:
 
   |pull request      = https://github.com/Jinxiewinxie/StardewValleyMods/pull/5
 
   |pull request      = https://github.com/Jinxiewinxie/StardewValleyMods/pull/5
 
-->
 
-->
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Tap Giant Crops
 +
  |author  = atravita
 +
  |id      = atravita.TapGiantCrops
 +
  |moddrop id = 1205166
 +
  |nexus id = 13052
 +
  |github  = atravita-mods/StardewMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 12,120: Line 12,185:
 
   |nexus id = 11801
 
   |nexus id = 11801
 
   |github  =
 
   |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Toolbar Icons
 +
  |author  = furyx639
 +
  |id      = furyx639.ToolbarIcons
 +
  |nexus id = 11026
 +
  |github  = ImJustMatt/StardewMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 13,117: Line 13,189:
 
   |id      = BlaDe.Zenchman
 
   |id      = BlaDe.Zenchman
 
   |nexus id = 12024
 
   |nexus id = 12024
 +
  |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Zen Mod
 +
  |author  = PositiveVegan
 +
  |id      = PositiveVegan.ZenMod
 +
  |nexus id = 12899
 
   |github  =
 
   |github  =
 
}}
 
}}

Revision as of 03:20, 30 July 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).