Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
m
Line 414: Line 414:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Animal Social Menu
 
   |name    = Animal Social Menu
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.AnimalSocialMenu
 
   |id      = spacechase0.AnimalSocialMenu
 
   |nexus id = 3283
 
   |nexus id = 3283
Line 453: Line 453:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Another Hunger Mod
 
   |name    = Another Hunger Mod
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.AnotherHungerMod
 
   |id      = spacechase0.AnotherHungerMod
 
   |nexus id = 3379
 
   |nexus id = 3379
Line 977: Line 977:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Better Meteorites
 
   |name    = Better Meteorites
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.BetterMeteorites
 
   |id      = spacechase0.BetterMeteorites
 
   |nexus id = 5096
 
   |nexus id = 5096
Line 1,052: Line 1,052:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Better Shop Menu
 
   |name    = Better Shop Menu
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.BetterShopMenu
 
   |id      = spacechase0.BetterShopMenu
 
   |nexus id = 2012
 
   |nexus id = 2012
Line 1,132: Line 1,132:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Bigger Craftables
 
   |name    = Bigger Craftables
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.BiggerCraftables
 
   |id      = spacechase0.BiggerCraftables
 
   |nexus id = 7530
 
   |nexus id = 7530
Line 1,303: Line 1,303:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Bug Net
 
   |name    = Bug Net
   |author  = spacechase0 + Keychain + ParadigmNomad
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.BugNet
 
   |id      = spacechase0.BugNet
 
   |nexus id = 5099
 
   |nexus id = 5099
Line 1,409: Line 1,409:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Capstone Professions
 
   |name    = Capstone Professions
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.CapstoneProfessions
 
   |id      = spacechase0.CapstoneProfessions
 
   |nexus id = 7636
 
   |nexus id = 7636
Line 1,858: Line 1,858:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Combat Level Damage Scaler
 
   |name    = Combat Level Damage Scaler
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.CombatLevelDamageScaler
 
   |id      = spacechase0.CombatLevelDamageScaler
 
   |nexus id = 3905
 
   |nexus id = 3905
Line 1,999: Line 1,999:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Console Code
 
   |name    = Console Code
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.ConsoleCode
 
   |id      = spacechase0.ConsoleCode
 
   |nexus id = 3101
 
   |nexus id = 3101
Line 2,026: Line 2,026:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Content Patcher Animations
 
   |name    = Content Patcher Animations
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.ContentPatcherAnimations
 
   |id      = spacechase0.ContentPatcherAnimations
 
   |nexus id = 3853
 
   |nexus id = 3853
Line 2,301: Line 2,301:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Custom Critters
 
   |name    = Custom Critters
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.CustomCritters
 
   |id      = spacechase0.CustomCritters
 
   |nexus id = 1255
 
   |nexus id = 1255
Line 2,415: Line 2,415:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Customize Exterior
 
   |name    = Customize Exterior
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.CustomizeExterior, CustomizeExterior<!--changed in 1.0.3-->
 
   |id      = spacechase0.CustomizeExterior, CustomizeExterior<!--changed in 1.0.3-->
 
   |nexus id = 1099
 
   |nexus id = 1099
Line 2,493: Line 2,493:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Custom NPC Fixes
 
   |name    = Custom NPC Fixes
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.CustomNPCFixes
 
   |id      = spacechase0.CustomNPCFixes
 
   |nexus id = 3849
 
   |nexus id = 3849
Line 2,864: Line 2,864:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Displays
 
   |name    = Displays
   |author  = spacechase0 and ParadigmNomad
+
   |author  = spacechase0 and ParadigmNomad and Pathoschild
 
   |id      = spacechase0.Displays
 
   |id      = spacechase0.Displays
 
   |nexus id = 7635
 
   |nexus id = 7635
Line 3,317: Line 3,317:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Experience Bars
 
   |name    = Experience Bars
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.ExperienceBars, ExperienceBars<!--changed in 1.0.2-->
 
   |id      = spacechase0.ExperienceBars, ExperienceBars<!--changed in 1.0.2-->
 
   |nexus id = 509
 
   |nexus id = 509
Line 3,383: Line 3,383:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Extended Reach
 
   |name    = Extended Reach
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.ExtendedReach
 
   |id      = spacechase0.ExtendedReach
 
   |nexus id = 1493
 
   |nexus id = 1493
Line 3,886: Line 3,886:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Flower Color Picker
 
   |name    = Flower Color Picker
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.FlowerColorPicker
 
   |id      = spacechase0.FlowerColorPicker
 
   |nexus id = 1229
 
   |nexus id = 1229
Line 3,922: Line 3,922:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Flower Rain
 
   |name    = Flower Rain
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.FlowerRain
 
   |id      = spacechase0.FlowerRain
 
   |nexus id = 6131
 
   |nexus id = 6131
Line 4,117: Line 4,117:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Generic Mod Config Menu
 
   |name    = Generic Mod Config Menu
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.GenericModConfigMenu
 
   |id      = spacechase0.GenericModConfigMenu
 
   |nexus id = 5098
 
   |nexus id = 5098
Line 4,691: Line 4,691:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Hybrid Crop Engine
 
   |name    = Hybrid Crop Engine
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.HybridCropEngine
 
   |id      = spacechase0.HybridCropEngine
 
   |nexus id = 6577
 
   |nexus id = 6577

Revision as of 08:30, 19 June 2021

Modding:Player Guide/header

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)

These mods are either obsolete, or have been abandoned by their authors and probably won't 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.

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. Increase the official version in manifest.json by 0.0.1 and add -unofficial.1-yourName.
    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).