Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: Added unofficial update for Teh's Fishing Overhaul)
(→‎SMAPI mods: tweak recent changes; remove some Android notes about non-compatibility bugs (should be reported to the mod page), using Virtual Keyboard (true for most mods), or using the latest version (implied))
Line 297: Line 297:
 
   |moddrop id = 600967
 
   |moddrop id = 600967
 
   |github  = Gathouria/Adopt-Skin
 
   |github  = Gathouria/Adopt-Skin
−
  |warnings = Android users: compatible; use VirtualKeyboard to interact with pet bed
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 428: Line 427:
 
   |id      = macer.AuroraGSI
 
   |id      = macer.AuroraGSI
 
   |nexus id = 6088
 
   |nexus id = 6088
 +
  |github  =
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 781: Line 781:
 
   |curseforge key = better-mixed-seeds
 
   |curseforge key = better-mixed-seeds
 
   |github  = EpicBellyFlop45/StardewMods
 
   |github  = EpicBellyFlop45/StardewMods
−
   |warnings = Android users: broken on android; use {{github|Jonqora/AndyCrocker-StardewMods/releases/tag/2.3.10-unofficial.1-logofe/|unofficial update}}
+
   |warnings = On Android, use {{github|Jonqora/AndyCrocker-StardewMods/releases/tag/2.3.10-unofficial.1-logofe|unofficial update}}.
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 814: Line 814:
 
   |nexus id = 859
 
   |nexus id = 859
 
   |github  = urbanyeti/stardew-better-ranching
 
   |github  = urbanyeti/stardew-better-ranching
−
  |warnings = Android users: functional but with zoom-level display bugs
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,400: Line 1,399:
 
   |nexus id = 4568
 
   |nexus id = 4568
 
   |github  = loe2run/ChildToNPC
 
   |github  = loe2run/ChildToNPC
−
   |warnings = Android users: not android-compatible
+
   |warnings = Broken on Android.
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,025: Line 2,024:
 
   |nexus id = 5377
 
   |nexus id = 5377
 
   |github  = ZaneYork/SDV_CustomLocalization
 
   |github  = ZaneYork/SDV_CustomLocalization
−
   |summary  = use latest version. (Only Android).
+
   |summary  = use latest version.
 +
  |warnings = Only compatible with Android.
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,085: Line 2,085:
 
{{/entry
 
{{/entry
 
   |name    = Custom Reminders
 
   |name    = Custom Reminders
−
   |author  = Dem1se, Dem1se7990
+
   |author  = Dem1se
 
   |id      = Dem1se.CustomReminders
 
   |id      = Dem1se.CustomReminders
 
   |nexus id = 6215
 
   |nexus id = 6215
Line 2,184: Line 2,184:
 
   |unofficial version = 1.4.2-unofficial.5-mizzion
 
   |unofficial version = 1.4.2-unofficial.5-mizzion
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-41#post-3355601
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-41#post-3355601
−
  |warnings = Android users: functional but with zoom-level display bugs
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,824: Line 2,823:
 
   |moddrop id = 598755
 
   |moddrop id = 598755
 
   |github  = Esca-MMC/FarmTypeManager
 
   |github  = Esca-MMC/FarmTypeManager
−
  |warnings = Android users: fixed as of version 1.11.0
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,966: Line 2,964:
 
   |nexus id = 5452
 
   |nexus id = 5452
 
   |github  =  
 
   |github  =  
−
  |warnings = Android users: functional with some text overflow issues
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 3,215: Line 3,212:
 
   |github  = Entoarox/StardewMods
 
   |github  = Entoarox/StardewMods
  
−
   |warnings = many players report a crash when season changes to winter.
+
   |warnings = Many players report a crash when season changes to winter.
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 3,314: Line 3,311:
 
   |nexus id = 229
 
   |nexus id = 229
 
   |github  = tstaples/GiftTasteHelper
 
   |github  = tstaples/GiftTasteHelper
−
  |warnings = Android users: some features not android-compatible
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,130: Line 4,126:
 
   |github  =  
 
   |github  =  
  
−
   |warnings = requires manually replacing game files; see install instructions on the mod page.
+
   |warnings = Requires manually replacing game files; see install instructions on the mod page.
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,139: Line 4,135:
 
   |moddrop id = 606605
 
   |moddrop id = 606605
 
   |github  = Pathoschild/StardewMods
 
   |github  = Pathoschild/StardewMods
−
  |warnings = Android users: mostly compatible; use VirtualKeyboard or VolumeUp/VolumeDown in config
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 4,951: Line 4,946:
 
   |nexus id = 239
 
   |nexus id = 239
 
   |github  = Bouhm/stardew-valley-mods
 
   |github  = Bouhm/stardew-valley-mods
−
  |warnings = Android users: functional with small display bugs
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 5,875: Line 5,869:
 
   |nexus id = 2481
 
   |nexus id = 2481
 
   |github  =  
 
   |github  =  
 +
 +
  |broke in = SMAPI 3.0
 
   |status  = workaround
 
   |status  = workaround
 
   |summary  = use [[#Custom Reminders|Custom Reminders]] instead.
 
   |summary  = use [[#Custom Reminders|Custom Reminders]] instead.
−
 
−
  |broke in = SMAPI 3.0
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,050: Line 6,044:
 
   |nexus id = 444
 
   |nexus id = 444
 
   |github  = janavarro95/Stardew_Valley_Mods
 
   |github  = janavarro95/Stardew_Valley_Mods
−
   |warnings = Android users: don't use this; Android has built-in autosave already
+
   |warnings = On Android, use the built-in autosave instead.
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,590: Line 6,584:
 
   |moddrop id = 606555
 
   |moddrop id = 606555
 
   |github  = Pathoschild/StardewMods
 
   |github  = Pathoschild/StardewMods
−
   |warnings = Android users: use version 1.5
+
   |warnings = On Android, use the version marked "For Android phones only".
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,937: Line 6,931:
 
   |id      = FlashShifter.SVECode
 
   |id      = FlashShifter.SVECode
 
   |nexus id = 3753
 
   |nexus id = 3753
−
   |warnings = Android users: mostly compatible with minor bugs
+
   |github  =  
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 7,105: Line 7,099:
 
   |github  = TehPers/StardewValleyMods
 
   |github  = TehPers/StardewValleyMods
  
−
   |broke in = Stardew Valley 1.4
+
   |broke in           = Stardew Valley 1.4
 
   |unofficial version = 2.1.5-unofficial.1-Mendaere
 
   |unofficial version = 2.1.5-unofficial.1-Mendaere
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-73#post-3364498
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-73#post-3364498
Line 7,240: Line 7,234:
 
   |curseforge key = tmx-loader
 
   |curseforge key = tmx-loader
 
   |github  = Platonymous/Stardew-Valley-Mods
 
   |github  = Platonymous/Stardew-Valley-Mods
−
   |warnings = Android users: works for most maps. Some mods' maps and custom spouse rooms load as a black void.
+
   |warnings = On Android, some maps and custom spouse rooms may load as a black void (fixed in an upcoming SMAPI update).
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 7,454: Line 7,448:
 
   |nexus id = 1150
 
   |nexus id = 1150
 
   |github  = cdaragorn/Ui-Info-Suite
 
   |github  = cdaragorn/Ui-Info-Suite
−
   |warnings = Android users: not android-compatible
+
   |warnings = Broken on Android.
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 7,806: Line 7,800:
 
   |nexus id = 3654
 
   |nexus id = 3654
 
   |github  = jahangmar/StardewValleyMods
 
   |github  = jahangmar/StardewValleyMods
−
  |warnings = Android users: fixed as of version 1.5.2
 
 
}}
 
}}
 
{{/entry
 
{{/entry

Revision as of 02:43, 15 June 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.

Cite error: <ref> tag with name "optional-update" defined in <references> is not used in prior text.

Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Mod_compatibility&oldid=101164"