Jump to content

Modding:Mod compatibility: Difference between revisions

From Stardew Valley Wiki
← Older editNewer edit →
imported>Pathoschild
→SMAPI mods: update intro
imported>Pathoschild
→SMAPI mods: + AutoFish, Content Patcher, Enhanced Relationships, Fixed Secret Woods Debris, Monster Level Tip, Qi Exchanger, Stardew Locations, Wallpaper Recycler
Line 149: Line 149:
   |source  =  
   |source  =  
}}
}}
{{/entry
  |name    = AutoFish
  |author  = WhiteMind
  |url      = https://www.nexusmods.com/stardewvalley/mods/1895
  |source  =
}}
{{/entry
{{/entry
   |name    = AutoGate
   |name    = AutoGate
Line 532: Line 539:
   |url      = https://smapi.io/
   |url      = https://smapi.io/
   |source  = https://github.com/Pathoschild/SMAPI
   |source  = https://github.com/Pathoschild/SMAPI
}}
{{/entry
  |name    = Content Patcher
  |author  = Pathoschild
  |url      = https://www.nexusmods.com/stardewvalley/mods/1915
  |source  = https://github.com/pathoschild/StardewMods
}}
}}
{{/entry
{{/entry
Line 780: Line 793:
   |links    = https://gitlab.com/speeder1/SMAPIHealthbarMod/merge_requests/1
   |links    = https://gitlab.com/speeder1/SMAPIHealthbarMod/merge_requests/1
   |broke in = Stardew Valley 1.2
   |broke in = Stardew Valley 1.2
}}
{{/entry
  |name    = Enhanced Relationships
  |author  = Mizzion
  |url      = https://www.nexusmods.com/stardewvalley/mods/1927
  |source  =
}}
}}
{{/entry
{{/entry
Line 968: Line 987:
   |url      = https://community.playstarbound.com/resources/fishing-tuner-redux.4578
   |url      = https://community.playstarbound.com/resources/fishing-tuner-redux.4578
   |source  = https://community.playstarbound.com/resources/fishing-tuner-redux.4578<!-- included in download -->
   |source  = https://community.playstarbound.com/resources/fishing-tuner-redux.4578<!-- included in download -->
}}
{{/entry
  |name    = Fixed Secret Woods Debris
  |author  = f4iTh and Lita
  |author2  = JertsukkaTheMan
  |url      = https://www.nexusmods.com/stardewvalley/mods/1941
  |source  =
}}
}}
{{/entry
{{/entry
Line 1,084: Line 1,110:
}}
}}
{{/entry
{{/entry
   |name     = Hardcore Mines
   |name     = Hardcore Mines
   |author   = kibbe
   |author   = kibbe
   |author2   = lillvik
   |author2 = lillvik
   |url       = https://www.nexusmods.com/stardewvalley/mods/1674
   |url     = https://www.nexusmods.com/stardewvalley/mods/1674
   |source   = https://github.com/chaos234/StardewValleyMods
   |source   = https://github.com/chaos234/StardewValleyMods
}}
}}
{{/entry
{{/entry
Line 1,365: Line 1,391:
   |url      = https://www.nexusmods.com/stardewvalley/mods/1597
   |url      = https://www.nexusmods.com/stardewvalley/mods/1597
   |source  = https://github.com/YonKuma/MoodGuard
   |source  = https://github.com/YonKuma/MoodGuard
}}
{{/entry
  |name    = Monster Level Tip
  |author  = WhiteMind
  |url      = https://www.nexusmods.com/stardewvalley/mods/1896
  |source  =
}}
}}
{{/entry
{{/entry
Line 1,644: Line 1,676:
   |author  = Prismuth
   |author  = Prismuth
   |url      = https://www.nexusmods.com/stardewvalley/mods/1647
   |url      = https://www.nexusmods.com/stardewvalley/mods/1647
  |source  =
}}
{{/entry
  |name    = Qi Exchanger
  |author  = Mizzion
  |url      = https://www.nexusmods.com/stardewvalley/mods/1930
   |source  =  
   |source  =  
}}
}}
Line 1,696: Line 1,734:
   |name    = Relationships Enhanced
   |name    = Relationships Enhanced
   |author  = rodrigovaz
   |author  = rodrigovaz
   |url     = https://community.playstarbound.com/resources/smapi-relationships-enhanced.4435
   |hide-url = https://community.playstarbound.com/resources/smapi-relationships-enhanced.4435
   |source  =  
   |source  =  
   |status  = broken
   |status  = workaround
   |summary  =  
   |summary  = use [[#Enhanced Relationships|Enhanced Relationships]] instead.
   |broke in = SMAPI 2.0
   |broke in = SMAPI 2.0
}}
}}
Line 1,742: Line 1,780:
   |name2    = Wallpaper Retain
   |name2    = Wallpaper Retain
   |author  = Iceburg
   |author  = Iceburg
   |url     = https://www.nexusmods.com/stardewvalley/mods/356
   |hide-url = https://www.nexusmods.com/stardewvalley/mods/356
   |source  =  
   |source  =  
   |status  = broken
   |status  = workaround
   |summary  =  
   |summary  = use [[#Wallpaper Recycler|Wallpaper Recycler]] instead.
   |broke in = SMAPI 2.0
   |broke in = SMAPI 2.0
}}
}}
Line 2,102: Line 2,140:
   |url      = https://www.nexusmods.com/stardewvalley/mods/1298
   |url      = https://www.nexusmods.com/stardewvalley/mods/1298
   |source  = https://github.com/spacechase0/StardewEditor
   |source  = https://github.com/spacechase0/StardewEditor
}}
{{/entry
  |name    = Stardew Locations
  |author  = Mizzion
  |url      = https://www.nexusmods.com/stardewvalley/mods/1929
  |source  =
}}
}}
{{/entry
{{/entry
Line 2,359: Line 2,403:
   |summary  =  
   |summary  =  
   |broke in = SMAPI 2.0
   |broke in = SMAPI 2.0
}}
{{/entry
  |name    = Wallpaper Recycler
  |author  = Mizzion
  |url      = https://www.nexusmods.com/stardewvalley/mods/1905
  |source  =
}}
}}
{{/entry
{{/entry

Revision as of 23:52, 3 March 2018

←Index

SMAPI updates almost never break mods, except when the major version changes (e.g. SMAPI 1.0 and 2.0). This page lists known SMAPI mods and their compatibility with the latest versions of SMAPI and Stardew Valley.

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 SMAPI 2.0 migration thread (with your SMAPI log attached) and we'll help.

SMAPI mods

Here's a list of mods tested with SMAPI 2.5+ and Stardew Valley 1.2.30+. Content packs aren't listed unless incompatible. It's updated periodically for new mod releases.

  1. ↑ This only shows whether a mod is compatible; it may have bugs unrelated to SMAPI compatibility.

For mod developers

Updating a mod

See how to update deprecated code. 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 version in manifest.json by 0.0.1-<yourname>-update.
    For example, if the current version is 1.0.0 and your username is SampleUser, you'd change the version to 1.0.1-sampleUser-update. If you need to release new versions of your update, add a number at the end like 1.0.1-sampleUser-update.2, 1.0.1-sampleUser-update.3, etc. This ensures that official versions will supersede unofficial ones (e.g. for update checks).
  4. Push your changes to GitHub.
  5. Post a release package to the SMAPI 2.0 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).

Overall compatibility

Status of known SMAPI mods:

 
 92% are compatible or have a working alternative.
 
 0% have an update coming soon.
 
 8% are broken and not open-source.¹

¹ Many of these broke due to a Stardew Valley update. Some may be updated by their authors later.

Retrieved from "https://stardew.fastobject.net/index.php?title=Modding:Mod_compatibility&oldid=58047"