Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
Line 2,015: Line 2,015:
 
   |url      = https://smapi.io
 
   |url      = https://smapi.io
 
   |github  = Pathoschild/SMAPI
 
   |github  = Pathoschild/SMAPI
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Console Coordinates
 +
  |author  = Pillow
 +
  |id      = Pillow.ConsoleCoordinates
 +
  |nexus id = 8957
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 5,074: Line 5,081:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Json Assets
 
   |name    = Json Assets
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.JsonAssets
 
   |id      = spacechase0.JsonAssets
 
   |nexus id = 1720
 
   |nexus id = 1720
Line 5,090: Line 5,097:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Jump Over
 
   |name    = Jump Over
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.JumpOver
 
   |id      = spacechase0.JumpOver
 
   |nexus id = 1844
 
   |nexus id = 1844
Line 5,123: Line 5,130:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Junimos Accept Cash
 
   |name    = Junimos Accept Cash
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.JunimosAcceptCash
 
   |id      = spacechase0.JunimosAcceptCash
 
   |nexus id = 7437
 
   |nexus id = 7437
Line 5,426: Line 5,433:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Luck Skill
 
   |name    = Luck Skill
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.LuckSkill, LuckSkill<!--changed in 0.1.4-->
 
   |id      = spacechase0.LuckSkill, LuckSkill<!--changed in 0.1.4-->
 
   |nexus id = 521
 
   |nexus id = 521
Line 5,461: Line 5,468:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Magic
 
   |name    = Magic
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.Magic
 
   |id      = spacechase0.Magic
 
   |nexus id = 2007
 
   |nexus id = 2007
Line 5,517: Line 5,524:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Mana Bar
 
   |name    = Mana Bar
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.ManaBar
 
   |id      = spacechase0.ManaBar
 
   |nexus id = 7831
 
   |nexus id = 7831
Line 5,848: Line 5,855:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = More Buildings
 
   |name    = More Buildings
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.MoreBuildings
 
   |id      = spacechase0.MoreBuildings
 
   |nexus id = 2757
 
   |nexus id = 2757
Line 5,859: Line 5,866:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = More Giant Crops
 
   |name    = More Giant Crops
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.MoreGiantCrops
 
   |id      = spacechase0.MoreGiantCrops
 
   |nexus id = 5263
 
   |nexus id = 5263
Line 5,881: Line 5,888:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = More Grass Starters
 
   |name    = More Grass Starters
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.MoreGrassStarters
 
   |id      = spacechase0.MoreGrassStarters
 
   |nexus id = 1702
 
   |nexus id = 1702
Line 5,937: Line 5,944:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = More Rings
 
   |name    = More Rings
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.MoreRings
 
   |id      = spacechase0.MoreRings
 
   |nexus id = 2054
 
   |nexus id = 2054
Line 6,057: Line 6,064:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Multi Fertilizer
 
   |name    = Multi Fertilizer
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.MultiFertilizer
 
   |id      = spacechase0.MultiFertilizer
 
   |nexus id = 7436
 
   |nexus id = 7436
Line 6,557: Line 6,564:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Object Time Left
 
   |name    = Object Time Left
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.ObjectTimeLeft
 
   |id      = spacechase0.ObjectTimeLeft
 
   |nexus id = 1315
 
   |nexus id = 1315
Line 7,127: Line 7,134:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Preexisting Relationship
 
   |name    = Preexisting Relationship
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.PreexistingRelationship
 
   |id      = spacechase0.PreexistingRelationship
 
   |nexus id = 7684
 
   |nexus id = 7684
Line 7,225: Line 7,232:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Profit Calculator
 
   |name    = Profit Calculator
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.ProfitCalculator
 
   |id      = spacechase0.ProfitCalculator
 
   |nexus id = 3378
 
   |nexus id = 3378
Line 7,297: Line 7,304:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Pyromancer's Journey, Fire Arcade Game
 
   |name    = Pyromancer's Journey, Fire Arcade Game
   |author  = spacechase0 and ParadigmNomad
+
   |author  = spacechase0 and ParadigmNomad and Pathoschild
 
   |id      = spacechase0.FireArcadeGame
 
   |id      = spacechase0.FireArcadeGame
 
   |nexus id = 7455
 
   |nexus id = 7455
Line 7,917: Line 7,924:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Rush Orders
 
   |name    = Rush Orders
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.RushOrders, RushOrders<!--changed in 1.1-->
 
   |id      = spacechase0.RushOrders, RushOrders<!--changed in 1.1-->
 
   |nexus id = 605
 
   |nexus id = 605
Line 8,615: Line 8,622:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Sleepy Eye
 
   |name    = Sleepy Eye
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.SleepyEye
 
   |id      = spacechase0.SleepyEye
 
   |nexus id = 1152
 
   |nexus id = 1152
Line 8,779: Line 8,786:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = SpaceCore
 
   |name    = SpaceCore
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.SpaceCore
 
   |id      = spacechase0.SpaceCore
 
   |nexus id = 1348
 
   |nexus id = 1348
Line 8,837: Line 8,844:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Spenny
 
   |name    = Spenny
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.Spenny
 
   |id      = spacechase0.Spenny
 
   |nexus id = 2755
 
   |nexus id = 2755
Line 9,207: Line 9,214:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Statue of Generosity
 
   |name    = Statue of Generosity
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.StatueOfGenerosity
 
   |id      = spacechase0.StatueOfGenerosity
 
   |nexus id = 7532
 
   |nexus id = 7532
Line 9,268: Line 9,275:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Surfing Festival
 
   |name    = Surfing Festival
   |author  = spacechase0 and ParadigmNomad
+
   |author  = spacechase0 and ParadigmNomad and Pathoschild
 
   |id      = spacechase0.SurfingFestival
 
   |id      = spacechase0.SurfingFestival
 
   |nexus id = 6688
 
   |nexus id = 6688
Line 9,451: Line 9,458:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Theft of the Winter Star
 
   |name    = Theft of the Winter Star
   |author  = spacechase0 + ParadigmNomad
+
   |author  = spacechase0 and ParadigmNomad and Pathoschild
 
   |id      = spacechase0.TheftOfTheWinterStar
 
   |id      = spacechase0.TheftOfTheWinterStar
 
   |nexus id = 5062
 
   |nexus id = 5062
Line 9,503: Line 9,510:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Three Heart Flower Festival Dance Partners, 3-heart Dance Partner
 
   |name    = Three Heart Flower Festival Dance Partners, 3-heart Dance Partner
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = ThreeHeartDancePartner
 
   |id      = ThreeHeartDancePartner
 
   |nexus id = 500
 
   |nexus id = 500
Line 9,512: Line 9,519:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Throwable Axe
 
   |name    = Throwable Axe
   |author  = spacechase0
+
   |author  = spacechase0 and Pathoschild
 
   |id      = spacechase0.ThrowableAxe
 
   |id      = spacechase0.ThrowableAxe
 
   |nexus id = 5097
 
   |nexus id = 5097
Line 10,155: Line 10,162:
 
   |nexus id = 7451
 
   |nexus id = 7451
 
   |github  = Shalankwa/SDV_Mods
 
   |github  = Shalankwa/SDV_Mods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Warp Multiplayer (Location)
 +
  |author  = Shaklin
 +
  |id      = Shaklin.WarpMultiplayerLocation
 +
  |nexus id = 8950
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry

Revision as of 01:58, 20 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).