Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(Mark Cats and Dogs obsolete (1.6 feature))
(→‎SMAPI mods: consistency in sophiesalacia's name)
(4 intermediate revisions by 4 users not shown)
Line 2,425: Line 2,425:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Car Warp, Decorative Cars<!--changed in 1.3.0-->
 
   |name    = Car Warp, Decorative Cars<!--changed in 1.3.0-->
   |author  = skellady and sophie
+
   |author  = skellady and sophiesalacia
 
   |id      = sophie.CarWarp
 
   |id      = sophie.CarWarp
 
   |nexus  = 11102
 
   |nexus  = 11102
Line 3,030: Line 3,030:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Colored Crystalariums
 
   |name    = Colored Crystalariums
   |author  = sophie
+
   |author  = sophiesalacia
 
   |id      = sophie.ColoredCrystalariums
 
   |id      = sophie.ColoredCrystalariums
 
   |nexus  = 14428
 
   |nexus  = 14428
Line 3,167: Line 3,167:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Configurable Bundle Costs
 
   |name    = Configurable Bundle Costs
   |author  = Vertigon
+
   |author  = sophiesalacia
 
   |id      = sophie.ConfigurableBundleCosts, Vertigon.ConfigurableBundleCosts<!--before 1.0.1-->
 
   |id      = sophie.ConfigurableBundleCosts, Vertigon.ConfigurableBundleCosts<!--before 1.0.1-->
 
   |nexus  = 9444
 
   |nexus  = 9444
Line 3,188: Line 3,188:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Configurable Luck
 
   |name    = Configurable Luck
   |author  = sophie
+
   |author  = sophiesalacia
 
   |id      = sophie.ConfigurableLuck
 
   |id      = sophie.ConfigurableLuck
 
   |nexus  = 14610
 
   |nexus  = 14610
Line 3,206: Line 3,206:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Configurable Special Orders Unlock
 
   |name    = Configurable Special Orders Unlock
   |author  = Vertigon
+
   |author  = sophiesalacia
 
   |id      = Vertigon.ConfigurableSpecialOrdersUnlock
 
   |id      = Vertigon.ConfigurableSpecialOrdersUnlock
 
   |nexus  = 8690
 
   |nexus  = 8690
Line 5,187: Line 5,187:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Early Community Upgrades
 
   |name    = Early Community Upgrades
   |author  = Vertigon
+
   |author  = sophiesalacia
 
   |id      = Vertigon.EarlyCommunityUpgrades
 
   |id      = Vertigon.EarlyCommunityUpgrades
 
   |nexus  = 8450
 
   |nexus  = 8450
Line 6,091: Line 6,091:
 
   |nexus  = 9969
 
   |nexus  = 9969
 
   |github  = Floogen/FashionSense
 
   |github  = Floogen/FashionSense
 
  |beta broke in = Stardew Valley 1.6<!--@retest-linked-->
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 9,000: Line 8,998:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Joja's Dark Secret, Halloween Jam CSharp
 
   |name    = Joja's Dark Secret, Halloween Jam CSharp
   |author  = sophie
+
   |author  = sophiesalacia
 
   |id      = sophie.HalloweenJamCSharp
 
   |id      = sophie.HalloweenJamCSharp
 
   |nexus  = 18927
 
   |nexus  = 18927
Line 9,315: Line 9,313:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Lasting Conversation Topics
 
   |name    = Lasting Conversation Topics
   |author  = sophie
+
   |author  = sophiesalacia
 
   |id      = sophie.LastingCTs
 
   |id      = sophie.LastingCTs
 
   |nexus  = 14377
 
   |nexus  = 14377
Line 10,028: Line 10,026:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Matching Nodes, MinesTokens
 
   |name    = Matching Nodes, MinesTokens
   |author  = Eryk601 and Vertigon
+
   |author  = Eryk601 and sophiesalacia
 
   |id      = Vertigon.MinesTokens
 
   |id      = Vertigon.MinesTokens
 
   |nexus  = 11124
 
   |nexus  = 11124
Line 10,185: Line 10,183:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Mines Tokens
 
   |name    = Mines Tokens
   |author  = sophie
+
   |author  = sophiesalacia
 
   |id      = sophie.MinesTokens
 
   |id      = sophie.MinesTokens
 
   |nexus  = 18776
 
   |nexus  = 18776
Line 10,588: Line 10,586:
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
   |name    = More Conversion Topics
+
   |name    = More Conversation Topics
 
   |author  = violetlizabet
 
   |author  = violetlizabet
 
   |id      = violetlizabet.MoreConvoTopics
 
   |id      = violetlizabet.MoreConvoTopics
Line 11,305: Line 11,303:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = New Years Eve → Fireworks
 
   |name    = New Years Eve → Fireworks
   |author  = sophie
+
   |author  = sophiesalacia
 
   |id      = sophie.Fireworks
 
   |id      = sophie.Fireworks
 
   |nexus  = 15277
 
   |nexus  = 15277
Line 13,909: Line 13,907:
  
 
   |broke in          = Stardew Valley 1.5
 
   |broke in          = Stardew Valley 1.5
  |unofficial version = 1.0.3-unofficial.1-esca
 
  |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/page-64#post-43678
 
  |summary = use [https://github.com/Lake1059/ResetTerrainFeatures_NET5 1.3-unofficial-Lake1059 or [https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/page-64#post-43678 unofficial update] instead.
 
 
  |beta broke in = Stardew Valley 1.6
 
 
   |unofficial version = 1.4.0-unofficial-Lake1059
 
   |unofficial version = 1.4.0-unofficial-Lake1059
 
   |unofficial url    = https://github.com/Lake1059/ResetTerrainFeatures_NET6
 
   |unofficial url    = https://github.com/Lake1059/ResetTerrainFeatures_NET6
  |summary = use [https://github.com/Lake1059/ResetTerrainFeatures_NET6 unofficial update] instead.
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 15,696: Line 15,688:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Splash Text
 
   |name    = Splash Text
   |author  = sophie
+
   |author  = sophiesalacia
 
   |id      = sophie.SplashText
 
   |id      = sophie.SplashText
 
   |nexus  = 14416
 
   |nexus  = 14416
Line 16,392: Line 16,384:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Stats as Tokens
 
   |name    = Stats as Tokens
   |author  = Vertighost, Vertigon
+
   |author  = sophiesalacia
 
   |id      = Vertigon.StatsAsTokens
 
   |id      = Vertigon.StatsAsTokens
 
   |nexus  = 9659
 
   |nexus  = 9659
Line 16,517: Line 16,509:
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
 
   |name    = Sturdy Saplings<!--manifest-->, Sturdier Saplings<!--Nexus-->
 
   |name    = Sturdy Saplings<!--manifest-->, Sturdier Saplings<!--Nexus-->
   |author  = sophie
+
   |author  = sophiesalacia
 
   |id      = sophie.SturdySaplings
 
   |id      = sophie.SturdySaplings
 
   |nexus  = 14440
 
   |nexus  = 14440
Line 18,380: Line 18,372:
 
   |moddrop = 833564
 
   |moddrop = 833564
 
   |github  = danvolchek/StardewMods
 
   |github  = danvolchek/StardewMods
 
 
   |broke in          = Stardew Valley 1.5
 
   |broke in          = Stardew Valley 1.5
   |unofficial version = 1.0.3-unofficial.4-brimbane
+
   |unofficial version = 1.0.3-unofficial.5-brimbane
   |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/post-80633
+
   |unofficial url    = http://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/post-119900
 
 
  |beta broke in = Stardew Valley 1.6
 
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry

Revision as of 22:32, 21 March 2024

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