Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: update mods fixed by PyTK update: ATM, CFAutomate, Ghost Town, Giant Crop Ring, Intravenous Coffee, JoJaBan, Junimo Studio, More Grass Starters, More TV Channel, Mushroom Propagator, Notes, Portal Guns, Show Players Behind Buildings)
(→‎SMAPI mods: update mods fixed by PyTK update (Custom Farming Redux, Sleep Worker, Sleepy Eye) and Custom Farming Redux change (The Pumpkin King))
Line 2,115: Line 2,115:
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
  
−
   |broke in = Stardew Valley 1.4.4<!--@retest-after PyTK, @retest-linked-->
+
   |broke in = Stardew Valley 1.4.4
−
<!--
 
 
   |unofficial version = 2.12.10-unofficial.1-minervamaga
 
   |unofficial version = 2.12.10-unofficial.1-minervamaga
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-26#post-3354284
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-26#post-3354284
 
   |pull request      = https://github.com/Platonymous/Stardew-Valley-Mods/pull/81
 
   |pull request      = https://github.com/Platonymous/Stardew-Valley-Mods/pull/81
−
-->
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,467: Line 6,465:
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
  
−
   |broke in          = Stardew Valley 1.5<!--@retest-linked-->
+
   |broke in          = Stardew Valley 1.5
 
   |unofficial version = 1.20.0-aplha
 
   |unofficial version = 1.20.0-aplha
 
   |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/page-3#post-20340
 
   |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/page-3#post-20340
Line 7,612: Line 7,610:
 
   |moddrop id = 793835
 
   |moddrop id = 793835
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
−
 
−
  |broke in = Stardew Valley 1.5<!--@retest-after PyTK-->
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 7,623: Line 7,619:
 
   |moddrop id = 129011
 
   |moddrop id = 129011
 
   |github  = spacechase0/SleepyEye
 
   |github  = spacechase0/SleepyEye
−
 
−
  |broke in = Stardew Valley 1.5<!--@retest-after PyTK-->
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 7,938: Line 7,932:
 
   |github  = ChroniclerCherry/stardew-valley-mods
 
   |github  = ChroniclerCherry/stardew-valley-mods
  
−
   |broke in = Stardew Valley 1.5<!--@retest-after Content Patcher, @retest-after Json Assets, @retest-after TMXL Map Toolkit-->
+
   |broke in = Stardew Valley 1.5<!--@retest-after Json Assets-->
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 8,314: Line 8,308:
 
   |github  = KirbyLink/PumpkinKing
 
   |github  = KirbyLink/PumpkinKing
  
−
  |broke in = Stardew Valley 1.4<!--@retest-after Custom Farming Redux-->
 
−
<!--
 
 
   |broke in          = Stardew Valley 1.4
 
   |broke in          = Stardew Valley 1.4
 
   |unofficial version = 1.1.1-unofficial.1-minervamaga
 
   |unofficial version = 1.1.1-unofficial.1-minervamaga
 
   |unofficial url    = https://www.nexusmods.com/stardewvalley/mods/4109
 
   |unofficial url    = https://www.nexusmods.com/stardewvalley/mods/4109
 
   |pull request      = https://github.com/KirbyLink/PumpkinKing/pull/1
 
   |pull request      = https://github.com/KirbyLink/PumpkinKing/pull/1
−
-->
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 8,406: Line 8,397:
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
  
−
   |broke in = Stardew Valley 1.5<!--@retest-after PyTK, @retest-linked-->
+
   |broke in = Stardew Valley 1.5
 
   |unofficial version = 1.21.0-alpha
 
   |unofficial version = 1.21.0-alpha
 
   |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/page-3#post-20340
 
   |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/page-3#post-20340

Revision as of 01:25, 22 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.
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Mod_compatibility&oldid=105707"