Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: + mods already broken before SDV 1.3)
Line 2,680: Line 2,680:
 
===SMAPI mods===
 
===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.
 
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.
 +
 +
'''This is list doesn't include all known mods yet.'''
  
 
{| class="wikitable plainlinks" id="mod-list"
 
{| class="wikitable plainlinks" id="mod-list"
Line 2,688: Line 2,690:
 
! (metadata)
 
! (metadata)
 
|-
 
|-
 +
{{/entry
 +
  |name    = 24hClock
 +
  |author  = Lajna
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/1695
 +
  |source  = https://github.com/LajnaLegenden/Stardew_Valley_Mods
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Adjust Artisan Prices
 +
  |author  = ThatNorthernMonkey
 +
  |url      = https://community.playstarbound.com/resources/smapi-adjust-artisan-prices.3532
 +
  |source  = https://github.com/ThatNorthernMonkey/AdjustArtisanPrices
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = SMAPI 1.9
 +
  |links    = https://github.com/ThatNorthernMonkey/AdjustArtisanPrices/pull/1
 +
}}
 
{{/entry
 
{{/entry
 
   |name    = Advanced Location Loader
 
   |name    = Advanced Location Loader
Line 2,693: Line 2,714:
 
   |url      = https://community.playstarbound.com/resources/smapi-advanced-location-loader.3619
 
   |url      = https://community.playstarbound.com/resources/smapi-advanced-location-loader.3619
 
   |source  = https://github.com/Entoarox/StardewMods
 
   |source  = https://github.com/Entoarox/StardewMods
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Advanced Machines
 +
  |name2    = AdvMachines
 +
  |author  = ANDR55
 +
  |url      = https://community.playstarbound.com/threads/advanced-machines.137132/
 +
  |source  =
 +
  |status  = broken
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Adventure Shop Inventory
 +
  |author  = Hammurabi
 +
  |url      = https://community.playstarbound.com/resources/adventure-shop-inventory.4608
 +
  |source  = https://community.playstarbound.com/resources/adventure-shop-inventory.4608
 
   |status  = soon
 
   |status  = soon
 
   |summary  =  
 
   |summary  =  
Line 2,705: Line 2,745:
 
   |summary  =  
 
   |summary  =  
 
   |broke in = SMAPI 2.0
 
   |broke in = SMAPI 2.0
 +
}}
 +
{{/entry
 +
  |name    = All Crops All Seasons
 +
  |author  = cantorsdust & community
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/170
 +
  |source  = https://github.com/cantorsdust/StardewMods
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = All Professions
 +
  |author  = cantorsdust & community
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/174
 +
  |source  = https://github.com/cantorsdust/StardewMods
 +
}}
 +
{{/entry
 +
  |name    = Almighty Farming Tool
 +
  |author  = momoaau
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/439
 +
  |source  =
 +
  |status  = broken
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Animal Husbandry
 +
  |name2    = Butcher Mod
 +
  |author  = Digus
 +
  |url      = https://rd.nexusmods.com/stardewvalley/mods/1538
 +
  |source  =
 +
  |status  = broken
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 +
}}
 +
{{/entry
 +
  |name    = Animal Sitter
 +
  |author  = jwdred
 +
  |url      = https://www.nexusmods.com/stardewvalley/mods/581
 +
  |source  = https://github.com/jdusbabek/stardewvalley
 +
  |status  = soon
 +
  |summary  =
 +
  |broke in = Stardew Valley 1.3
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,711: Line 2,794:
 
   |url      = https://community.playstarbound.com/threads/smapi-ashley-npc-new-npc.112077
 
   |url      = https://community.playstarbound.com/threads/smapi-ashley-npc-new-npc.112077
 
   |source  = https://github.com/Club559/AshleyMod
 
   |source  = https://github.com/Club559/AshleyMod
−
   |status  = broken
+
   |status  = soon
 
   |summary  =  
 
   |summary  =  
 
   |broke in = SMAPI 2.0
 
   |broke in = SMAPI 2.0
Line 2,918: Line 3,001:
 
   |source  = https://github.com/spacechase0/SleepyEye
 
   |source  = https://github.com/spacechase0/SleepyEye
 
   |status  = soon
 
   |status  = soon
−
   |broke in = Entoarox Framework 2.0
+
   |broke in = Stardew Valley 1.3
 
   |links    = https://github.com/spacechase0/SleepyEye/issues/2
 
   |links    = https://github.com/spacechase0/SleepyEye/issues/2
 
}}
 
}}
Line 3,015: Line 3,098:
 
! compatibility<ref name="compatibility">This only shows whether a mod is ''compatible''; it may have bugs unrelated to SMAPI compatibility.</ref>
 
! compatibility<ref name="compatibility">This only shows whether a mod is ''compatible''; it may have bugs unrelated to SMAPI compatibility.</ref>
 
! (metadata)
 
! (metadata)
−
{{/entry
 
−
  |name    = 24hClock
 
−
  |author  = Lajna
 
−
  |url      = https://www.nexusmods.com/stardewvalley/mods/1695
 
−
  |source  = https://github.com/LajnaLegenden/Stardew_Valley_Mods
 
−
}}
 
 
{{/entry
 
{{/entry
 
   |name    = AccessChestAnywhere
 
   |name    = AccessChestAnywhere
Line 3,030: Line 3,107:
 
   |summary  = use [https://www.nexusmods.com/stardewvalley/mods/518 Chests Anywhere] instead.
 
   |summary  = use [https://www.nexusmods.com/stardewvalley/mods/518 Chests Anywhere] instead.
 
   |broke in = Stardew Valley 1.1
 
   |broke in = Stardew Valley 1.1
−
}}
 
−
{{/entry
 
−
  |name    = Adjust Artisan Prices
 
−
  |author  = ThatNorthernMonkey
 
−
  |hide-url = https://community.playstarbound.com/resources/smapi-adjust-artisan-prices.3532
 
−
  |source  = https://github.com/ThatNorthernMonkey/AdjustArtisanPrices
 
−
  |status  = workaround
 
−
  |summary  = use [https://community.playstarbound.com/attachments/adjustartisanprices-0-2-pathoschild-update-zip.187853/ unofficial update] (<small>0.0.2-pathoschild-update</small>).
 
−
  |links    = https://github.com/ThatNorthernMonkey/AdjustArtisanPrices/pull/1
 
−
  |broke in = SMAPI 1.9
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 3,045: Line 3,112:
 
   |author  = mmanlapat
 
   |author  = mmanlapat
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/1161
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/1161
−
  |source  =
 
−
}}
 
−
{{/entry
 
−
  |name    = Advanced Machines
 
−
  |name2    = AdvMachines
 
−
  |author  = ANDR55
 
−
  |url      = https://community.playstarbound.com/threads/advanced-machines.137132/
 
−
  |source  =
 
−
}}
 
−
{{/entry
 
−
  |name    = Adventure Shop Inventory
 
−
  |author  = Hammurabi
 
−
  |url      = https://community.playstarbound.com/resources/adventure-shop-inventory.4608
 
−
  |source  = https://community.playstarbound.com/resources/adventure-shop-inventory.4608
 
−
}}
 
−
{{/entry
 
−
  |name    = All Crops All Seasons
 
−
  |author  = cantorsdust & community
 
−
  |url      = https://www.nexusmods.com/stardewvalley/mods/170
 
−
  |source  = https://github.com/cantorsdust/StardewMods
 
−
}}
 
−
{{/entry
 
−
  |name    = All Professions
 
−
  |author  = cantorsdust & community
 
−
  |url      = https://www.nexusmods.com/stardewvalley/mods/174
 
−
  |source  = https://github.com/cantorsdust/StardewMods
 
−
}}
 
−
{{/entry
 
−
  |name    = Almighty Farming Tool
 
−
  |author  = momoaau
 
−
  |url      = https://www.nexusmods.com/stardewvalley/mods/439
 
−
  |source  =
 
−
}}
 
−
{{/entry
 
−
  |name    = Animal Husbandry
 
−
  |name2    = Butcher Mod
 
−
  |author  = Digus
 
−
  |url      = https://rd.nexusmods.com/stardewvalley/mods/1538
 
 
   |source  =  
 
   |source  =  
 
}}
 
}}
Line 3,093: Line 3,122:
 
   |summary  = use [https://nexusmods.com/stardewvalley/mods/1597 Mood Guard] instead.
 
   |summary  = use [https://nexusmods.com/stardewvalley/mods/1597 Mood Guard] instead.
 
   |broke in = SMAPI 2.0
 
   |broke in = SMAPI 2.0
−
}}
 
−
{{/entry
 
−
  |name    = Animal Sitter
 
−
  |author  = jwdred
 
−
  |url      = https://www.nexusmods.com/stardewvalley/mods/581
 
−
  |source  = https://github.com/jdusbabek/stardewvalley
 
 
}}
 
}}
 
{{/entry
 
{{/entry

Revision as of 05:27, 15 April 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 (Stardew Valley 1.2)

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 players (Stardew Valley 1.3 beta)

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

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.

This is list doesn't include all known mods yet.

  1. ↑ 1.0 1.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 for Stardew Valley 1.2:

 
 94% are compatible or have a working alternative.
 
 1% have an update coming soon.
 
 6% are broken and not open-source.¹

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

Status of known SMAPI mods for Stardew Valley 1.3:
TBD

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