Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: set Community Bundle Item Tooltip as workaround for Jiggly Junimo Bundles)
(→‎SMAPI mods: split Angel's Existing Weapon Updater and Angel's Weapon Rebalance)
(6 intermediate revisions by the same user not shown)
Line 298: Line 298:
 
   |moddrop id = 600967
 
   |moddrop id = 600967
 
   |github  = Gathouria/Adopt-Skin
 
   |github  = Gathouria/Adopt-Skin
 +
}}
 +
{{/entry
 +
  |name    = Angel's Existing Weapon Updater
 +
  |author  = AngelaRanna
 +
  |id      = AngelaRanna.ExistingWeaponsUpdater
 +
  |nexus id = 6894
 +
  |github  =
 +
}}
 +
{{/entry
 +
  |name    = Angel's Weapon Rebalance
 +
  |author  = AngelaRanna
 +
  |id      = AngelaRanna.WeaponBalanceCode
 +
  |nexus id = 6894
 +
  |github  =
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 454: Line 468:
 
   |nexus id = 1019
 
   |nexus id = 1019
 
   |github  = taggartaa/AutoAnimalDoors
 
   |github  = taggartaa/AutoAnimalDoors
 +
}}
 +
{{/entry
 +
  |name    = Auto Bait and Tackles
 +
  |author  = Alison Li
 +
  |id      = Alison-Li.AutoBaitAndTackles
 +
  |nexus id = 6773
 +
  |github  = Alison-Li/AutoBaitAndTacklesMod
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 614: Line 635:
 
{{/entry
 
{{/entry
 
   |name    = Basic Sprinkler Improved
 
   |name    = Basic Sprinkler Improved
−
   |author  = LittleRaskols
+
   |author  = littleraskol
 
   |id      = lrsk_sdvm_bsi.0117171308
 
   |id      = lrsk_sdvm_bsi.0117171308
 
   |nexus id = 833
 
   |nexus id = 833
Line 796: Line 817:
 
   |name    = Better Quality More Seeds
 
   |name    = Better Quality More Seeds
 
   |author  = bmarquismarkail, Space Baby
 
   |author  = bmarquismarkail, Space Baby
−
   |id      = SB_BQMS
+
   |id      = SpaceBaby.BetterQualityMoreSeeds, SB_BQMS<!--changed in 2.0.0-4-->
 
   |nexus id = 935
 
   |nexus id = 935
 
   |github  = bmarquismarkail/SV_BetterQualityMoreSeeds
 
   |github  = bmarquismarkail/SV_BetterQualityMoreSeeds
Line 2,223: Line 2,244:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Custom TV Template
+
   |name    = Custom TV
 
   |author  = Platonymous
 
   |author  = Platonymous
−
   |id      = Platonymous.CustomTVTemplate
+
   |id      = Platonymous.CustomTV
 
   |nexus id = 6775
 
   |nexus id = 6775
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
Line 2,270: Line 2,291:
 
   |status  = workaround
 
   |status  = workaround
 
   |summary  = use [[#Stardew Notifications|Stardew Notifications]] instead.
 
   |summary  = use [[#Stardew Notifications|Stardew Notifications]] instead.
 +
}}
 +
{{/entry
 +
  |name    = Daily Luck and Weather Predictions, Steps Taken RNG Prediction on Screen
 +
  |author  = BlaDe
 +
  |id      = BlaDe.StepsTakenOnScreen
 +
  |nexus id = 6783
 +
  |github  =
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,146: Line 6,174:
 
   |id      = jltaylor-us.RangeHighlight
 
   |id      = jltaylor-us.RangeHighlight
 
   |nexus id = 6752
 
   |nexus id = 6752
−
   |github  = jitaylor-us/StardewRangeHighlight
+
   |github  = jltaylor-us/StardewRangeHighlight
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,205: Line 6,233:
  
 
   |broke in = SMAPI 3.0
 
   |broke in = SMAPI 3.0
 +
}}
 +
{{/entry
 +
  |name    = Recurring Reminders
 +
  |author  = Dem1se
 +
  |id      = Dem1se.RecurringReminders
 +
  |nexus id = 6840
 +
  |github  = dem1se/SDVMods
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,344: Line 6,379:
  
 
   |broke in          = Stardew Valley 1.3.29
 
   |broke in          = Stardew Valley 1.3.29
−
   |unofficial version = 1.1.3-unofficial.1-jacquesdereims
+
   |unofficial version = 1.1.2-unofficial.2-jacquesdereims
−
   |unofficial url    = http://forums.stardewvalley.net/index.php?threads/unofficial-mod-updates.2096/post-15026
+
   |unofficial url    = http://forums.stardewvalley.net/index.php?threads/unofficial-mod-updates.2096/post-15790
 
   |pull request      = https://github.com/jdusbabek/stardewvalley/pull/14
 
   |pull request      = https://github.com/jdusbabek/stardewvalley/pull/14
 
}}
 
}}
Line 6,353: Line 6,388:
 
   |id      = lrsk_sdvm_rerg.0925160827
 
   |id      = lrsk_sdvm_rerg.0925160827
 
   |nexus id = 6837
 
   |nexus id = 6837
−
   |chucklefish id = 4465
+
   |moddrop id = 827580
 
   |github  = littleraskol/ReRegeneration
 
   |github  = littleraskol/ReRegeneration
 
}}
 
}}
Line 6,571: Line 6,606:
 
   |id      = SixthTitan.SDVWM, SixthTitan.StarDewValleyWeatherMachine <!--changed in 2.2-->
 
   |id      = SixthTitan.SDVWM, SixthTitan.StarDewValleyWeatherMachine <!--changed in 2.2-->
 
   |nexus id = 3203
 
   |nexus id = 3203
 +
  |github  =
 +
}}
 +
{{/entry
 +
  |name    = SDVWM Astro, SDVWM Environment
 +
  |author  = SixthTitan
 +
  |id      = SixthTitan.SDVWM_Astro
 +
  |nexus id = 5773
 
   |github  =  
 
   |github  =  
 
}}
 
}}
Line 6,663: Line 6,705:
 
   |id      = CyTheGuy01.TestMod
 
   |id      = CyTheGuy01.TestMod
 
   |nexus id = 6463
 
   |nexus id = 6463
 +
  |github  =
 +
}}
 +
{{/entry
 +
  |name    = Single-Player Regen, Single-Player Sleep
 +
  |author  = MindMeltMax
 +
  |id      = MindMeltMax.SPRegen
 +
  |nexus id = 6778
 
   |github  =  
 
   |github  =  
 
}}
 
}}
Line 7,197: Line 7,246:
 
   |broke in = SMAPI 0.39.1
 
   |broke in = SMAPI 0.39.1
 
   |status  = workaround
 
   |status  = workaround
−
   |summary  = use [[#Sprint Sprint|Sprint Sprint]] instead.
+
   |summary  = use [[#Sprint and Dash Buttons|Sprint and Dash Buttons]] or [[#Sprint Sprint|Sprint Sprint]] instead.
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 7,212: Line 7,261:
 
   |id      = littleraskol.SprintAndDashRedux, lrsk_sdvm_sndr.0921161059<!--changed in 1.3-->
 
   |id      = littleraskol.SprintAndDashRedux, lrsk_sdvm_sndr.0921161059<!--changed in 1.3-->
 
   |nexus id = 560
 
   |nexus id = 560
−
   |chucklefish id = 4201
+
   |moddrop id = 827770
 
   |github  = littleraskol/Sprint-And-Dash-Redux
 
   |github  = littleraskol/Sprint-And-Dash-Redux
 
}}
 
}}
Line 7,225: Line 7,274:
 
   |broke in = Stardew Valley 1.2
 
   |broke in = Stardew Valley 1.2
 
   |status  = workaround
 
   |status  = workaround
−
   |summary  = use [[#Sprint Sprint|Sprint Sprint]] instead.
+
   |summary  = use [[#Sprint and Dash Buttons|Sprint and Dash Buttons]] or [[#Sprint Sprint|Sprint Sprint]] instead.
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 8,047: Line 8,096:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Unlimited Gift
+
   |name    = Unlimited Gift (Gift All Week)
 +
  |author  = Chirase
 +
  |id      = Tommy.GiftAllWeek
 +
  |nexus id = 6850
 +
  |github  =
 +
}}
 +
{{/entry
 +
  |name    = Unlimited Gift (Gift Every Day)
 
   |author  = Chirase
 
   |author  = Chirase
−
   |id      = Chirase.UnlimitedGift
+
   |id      = Tommy.GiftEveryDay
 
   |nexus id = 6850
 
   |nexus id = 6850
 
   |github  =
 
   |github  =
Line 8,922: Line 8,978:
 
   |status  = abandoned
 
   |status  = abandoned
 
   |summary  = remove this mod (no longer maintained; use [[#Shop Tile Framework|Shop Tile Framework]] + [[#TMXL Map Toolkit|TMXL Map Toolkit]] instead).
 
   |summary  = remove this mod (no longer maintained; use [[#Shop Tile Framework|Shop Tile Framework]] + [[#TMXL Map Toolkit|TMXL Map Toolkit]] instead).
−
}}
 
−
{{/entry
 
−
  |name    = Custom TV
 
−
  |author  = Platonymous
 
−
  |id      = Platonymous.CustomTV
 
−
  |nexus id = 1139
 
−
  |github  = Platonymous/Stardew-Valley-Mods
 
−
  |broke in = Stardew Valley 1.3
 
−
  |status  = abandoned
 
−
  |summary  = remove this mod (no longer maintained; use [[#PyTK|PyTK]] instead).
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 9,474: Line 9,520:
 
   |github  = JessebotX/StardewMods
 
   |github  = JessebotX/StardewMods
 
   |status  = obsolete
 
   |status  = obsolete
−
   |summary  = remove this mod (no longer maintained; use [[#Sprint Sprint|Sprint Sprint]] instead).
+
   |summary  = remove this mod (no longer maintained; use [[#Sprint and Dash Buttons|Sprint and Dash Buttons]] or [[#Sprint Sprint|Sprint Sprint]] instead).
 
}}
 
}}
 
{{/entry
 
{{/entry

Revision as of 21:08, 27 September 2020

Modding:Player Guide/header

SMAPI mod compatibility, July 2017 to present. See notable events which affect this chart.

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 mods.smapi.io 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

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

Footnotes

  1. ↑ 1.0 1.1 1.2 This only shows whether a mod is compatible; it may have bugs unrelated to SMAPI compatibility.
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Mod_compatibility&oldid=103462"