Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: + new mods (Responsive Knockback, Better Artisan Good Icons For Meads, Clay Map, Coop Battle Pause, Crop Growth Info, Dialogue New Line, Drive By, Farm Animal Choices, Flamingo Breeding, Haboo, Miscellaneous Modded Meadows Trolls, Moon Misadventures - Bigger Backpack Compatibility Patch, Pet Bowl Filler, Pokemania Revised, Profiler, Quick Glance, Redesigned Farmhouse Layout, Savage Vincent, Silent Alarm Clock, Skip Start, Split Screen Manager, Stack Size Changer))
(→‎SMAPI mods: + new mods (Stardew and Chill, Stardew Nametags, Survivalistic, Tidy Fields, Tileman Challenge, Time Before Harvest Enhanced, Water Flow, Zenchman), add workaround (Time Before Harvest))
Line 10,952: Line 10,952:
 
   |url      = https://github.com/stardew-access/stardew-access/releases
 
   |url      = https://github.com/stardew-access/stardew-access/releases
 
   |github  = stardew-access/stardew-access
 
   |github  = stardew-access/stardew-access
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Stardew and Chill
 +
  |author  = mod.kitchen
 +
  |id      = mod.kitchen.stardewandchill
 +
  |nexus id = 12147
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 11,051: Line 11,058:
 
   |nexus id = 11246
 
   |nexus id = 11246
 
   |github  = AngeloC3/StardewMods
 
   |github  = AngeloC3/StardewMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Stardew Nametags
 +
  |author  = tylergibbs2
 +
  |id      = tylergibbs2.StardewNametags
 +
  |nexus id = 12158
 +
  |github  = tylergibbs2/StardewNametags
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 11,299: Line 11,313:
 
   |nexus id = 6688
 
   |nexus id = 6688
 
   |github  = spacechase0/StardewValleyMods
 
   |github  = spacechase0/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Survivalistic
 +
  |author  = Ophaneom
 +
  |id      = Ophaneom.Survivalistic
 +
  |nexus id = 12179
 +
  |github  = Ophaneom/Survivalistic
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 11,566: Line 11,587:
 
   |nexus id =  
 
   |nexus id =  
 
   |github  =  
 
   |github  =  
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Tidy Fields
 +
  |author  = seitanicbean
 +
  |id      = seitanicbean.tidyfields
 +
  |nexus id = 10929
 +
  |github  =
 +
  |source  = https://gitlab.com/tophatsquid/sdv-tidy-fields
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Tileman Challenge
 +
  |author  = SpicyKai
 +
  |id      = SpicyKai.Tileman
 +
  |nexus id = 11945
 +
  |github  = spicykai/StardewValley-Mods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 11,588: Line 11,624:
 
   |github  =  
 
   |github  =  
  
−
   |status  = broken<!--implemented a SMAPI API interface and broke when new functionality was added to SMAPI-->
+
   |status  = workaround<!--implemented a SMAPI API interface and broke when new functionality was added to SMAPI-->
 +
  |summary  = use [[#Time Before Harvest Enhanced|Time Before Harvest Enhanced]] instead.
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Time Before Harvest Enhanced
 +
  |author  = Jonathan Ginn
 +
  |id      = JonathanGinn.TimeBeforeHarvestEnhanced
 +
  |nexus id = 12170
 +
  |github  =
 +
  |source  = https://gitlab.com/enom/time-before-harvest-enhanced
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 12,372: Line 12,417:
 
   |moddrop id = 661368
 
   |moddrop id = 661368
 
   |github  = Mizzion/MyStardewMods
 
   |github  = Mizzion/MyStardewMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Water Flow
 +
  |author  = blueberry
 +
  |id      = blueberry.WaterFlow
 +
  |nexus id = 11790
 +
  |github  = b-b-blueberry/WaterFlow
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 12,651: Line 12,703:
  
 
   |broke in = Stardew Valley 1.3
 
   |broke in = Stardew Valley 1.3
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Zenchman
 +
  |author  = BlaDe
 +
  |id      = BlaDe.Zenchman
 +
  |nexus id = 12024
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry

Revision as of 02:49, 29 May 2022

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)

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).
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Mod_compatibility&oldid=138197"