Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: add ModDrop IDs for Custom Death Penalty Plus and Custom NPC Exclusions)
(→‎SMAPI mods: + new mods: Configurable Cellar Extension, Crop Grace Period, Farm to Table Ready Meals, Goodbye American English, ImagEd, Junimo Studio, LewdDew Valley, Queen of Sauce Randomizer, Slime Water Filler)
Line 1,678: Line 1,678:
 
   |nexus id = 4446
 
   |nexus id = 4446
 
   |github  = jahangmar/StardewValleyMods
 
   |github  = jahangmar/StardewValleyMods
 +
}}
 +
{{/entry
 +
  |name    = Configurable Cellar Extension (with tillable soil), Boogies Cellar Soil Fix
 +
  |author  = Boogie, BoogieBest
 +
  |id      = boogie.greenhouse
 +
  |nexus id = 7109
 +
  |github  =
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,881: Line 1,888:
 
   |nexus id = 4885
 
   |nexus id = 4885
 
   |github  =  
 
   |github  =  
 +
}}
 +
{{/entry
 +
  |name    = Crop Grace Period
 +
  |author  = lefthandedkid, stoobinator
 +
  |id      = stoobinator.seasonspillover
 +
  |nexus id = 7203
 +
  |github  = stoobinator/Stardew-Valley-Grace-Period
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 3,057: Line 3,071:
 
   |status  = workaround
 
   |status  = workaround
 
   |summary  = use [[#Farm Type Manager|Farm Type Manager]] instead.
 
   |summary  = use [[#Farm Type Manager|Farm Type Manager]] instead.
 +
}}
 +
{{/entry
 +
  |name    = Farm to Table Ready Meals
 +
  |author  = Speshkitty
 +
  |id      = speshkitty.farmtotablereadymeals
 +
  |nexus id = 7148
 +
  |github  = Speshkitty/FarmToTableReadyMeals
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 3,597: Line 3,618:
 
   |nexus id = 2641
 
   |nexus id = 2641
 
   |github  =  
 
   |github  =  
 +
}}
 +
{{/entry
 +
  |name    = Goodbye American English
 +
  |author  = TheMightyAmondee
 +
  |id      = TheMightyAmondee.GoodbyeAmericanEnglish
 +
  |moddrop id = 854437
 +
  |nexus id = 7183
 +
  |github  = TheMightyAmondee/GoodbyeAmericanEnglish
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 3,988: Line 4,017:
 
   |summary      = use [[#AFK Timer|AFK Timer]] or [[#Idle Pause|Idle Pause]] instead.
 
   |summary      = use [[#AFK Timer|AFK Timer]] or [[#Idle Pause|Idle Pause]] instead.
 
   |pull request = https://github.com/emperorzuul/SMAPI_MODS/pull/2
 
   |pull request = https://github.com/emperorzuul/SMAPI_MODS/pull/2
 +
}}
 +
{{/entry
 +
  |name    = ImagEd
 +
  |author  = candidus42
 +
  |id      = Candidus42.ImagEd
 +
  |nexus id = 7218
 +
  |github  = mus-candidus/ImagEd
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,300: Line 4,336:
 
   |id      = Ryaon.JunimoKartCheater
 
   |id      = Ryaon.JunimoKartCheater
 
   |nexus id = 5137
 
   |nexus id = 5137
 +
  |github  =
 +
}}
 +
{{/entry
 +
  |name    = Junimo Studio
 +
  |author  = Becks723
 +
  |id      = Becks723.JunimoStudio
 +
  |nexus id = 6971
 
   |github  =  
 
   |github  =  
 
}}
 
}}
Line 4,408: Line 4,451:
  
 
   |map remote versions = 1.0.0-1.3patch → 0.0.2-unofficial.1-pathoschild<!--CurseForge version incorrect-->
 
   |map remote versions = 1.0.0-1.3patch → 0.0.2-unofficial.1-pathoschild<!--CurseForge version incorrect-->
 +
}}
 +
{{/entry
 +
  |name    = LewdDew Valley, LewdDew_Valley_helper2
 +
  |author  = shurmash
 +
  |id      = shurmash.LewdDew_Valley_helper
 +
  |nexus id = 7222
 +
  |github  =
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,189: Line 6,239:
 
   |nexus id = 5663
 
   |nexus id = 5663
 
   |github  = Traktori7/StardewValleyMods
 
   |github  = Traktori7/StardewValleyMods
 +
}}
 +
{{/entry
 +
  |name    = Queen of Sauce Randomizer
 +
  |author  = Speshkitty
 +
  |id      = speshkitty.queenofsauceshuffler
 +
  |nexus id = 7151
 +
  |github  = Speshkitty/QueenOfSauceRandomiser
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 7,234: Line 7,291:
  
 
   |broke in = SMAPI 2.0
 
   |broke in = SMAPI 2.0
 +
}}
 +
{{/entry
 +
  |name    = Slime Water Filler, Slime AutoWaterer
 +
  |author  = Speshkitty
 +
  |id      = speshkitty.slimewaterer
 +
  |nexus id = 7141
 +
  |github  = Speshkitty/SlimeWaterFiller
 
}}
 
}}
 
{{/entry
 
{{/entry

Revision as of 05:09, 2 December 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.