Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: use more semantic 'nexus id' field where applicable)
(→‎SMAPI mods: use more semantic 'cf id' field where applicable)
Line 55: Line 55:
 
   |name    = Adjust Artisan Prices
 
   |name    = Adjust Artisan Prices
 
   |author  = ThatNorthernMonkey
 
   |author  = ThatNorthernMonkey
   |url      = https://community.playstarbound.com/resources/smapi-adjust-artisan-prices.3532
+
   |nexus id =
 +
  |cf id    = 3532
 
   |source  = https://github.com/ThatNorthernMonkey/AdjustArtisanPrices
 
   |source  = https://github.com/ThatNorthernMonkey/AdjustArtisanPrices
 
   |status  = broken
 
   |status  = broken
Line 74: Line 75:
 
   |name    = Advanced Location Loader
 
   |name    = Advanced Location Loader
 
   |author  = Entoarox
 
   |author  = Entoarox
   |url      = https://community.playstarbound.com/resources/smapi-advanced-location-loader.3619
+
   |nexus id =
 +
  |cf id    = 3619
 
   |source  = https://github.com/Entoarox/StardewMods
 
   |source  = https://github.com/Entoarox/StardewMods
 
   |status  = broken
 
   |status  = broken
Line 93: Line 95:
 
   |name    = Adventure Shop Inventory  
 
   |name    = Adventure Shop Inventory  
 
   |author  = Hammurabi
 
   |author  = Hammurabi
   |url      = https://community.playstarbound.com/resources/adventure-shop-inventory.4608
+
   |nexus id =
 +
  |cf id    = 4608
 
   |source  = https://community.playstarbound.com/resources/adventure-shop-inventory.4608
 
   |source  = https://community.playstarbound.com/resources/adventure-shop-inventory.4608
 
   |status  = broken
 
   |status  = broken
Line 719: Line 722:
 
   |name    = Colored Chests
 
   |name    = Colored Chests
 
   |author  = Igorious
 
   |author  = Igorious
   |url      = https://community.playstarbound.com/resources/smapi-colored-chests.3684
+
   |nexus id =
 +
  |cf id    = 3684
 
   |source  =  
 
   |source  =  
 
   |status  = obsolete
 
   |status  = obsolete
Line 1,008: Line 1,012:
 
   |name2    = Event Notifications
 
   |name2    = Event Notifications
 
   |author  = dreamsicl
 
   |author  = dreamsicl
   |url      = https://community.playstarbound.com/resources/daily-notifications.3621
+
   |nexus id =
 +
  |cf id    = 3621
 
   |source  =  
 
   |source  =  
 
   |status  = workaround
 
   |status  = workaround
Line 1,171: Line 1,176:
 
   |name    = Entoarox Framework
 
   |name    = Entoarox Framework
 
   |author  = Entoarox
 
   |author  = Entoarox
   |url      = https://community.playstarbound.com/resources/4228
+
   |nexus id =
 +
  |cf id    = 4228
 
   |source  = https://github.com/Entoarox/StardewMods
 
   |source  = https://github.com/Entoarox/StardewMods
 
   |status  = broken
 
   |status  = broken
Line 1,219: Line 1,225:
 
   |name    = Extended BusSystem
 
   |name    = Extended BusSystem
 
   |author  = Tondorian
 
   |author  = Tondorian
   |url      = https://community.playstarbound.com/resources/smapi-extended-bussystem.4373
+
   |nexus id =
 +
  |cf id    = 4373
 
   |source  =  
 
   |source  =  
 
   |status  = broken
 
   |status  = broken
Line 1,238: Line 1,245:
 
   |name    = Extended Minecart
 
   |name    = Extended Minecart
 
   |author  = Entoarox
 
   |author  = Entoarox
   |url      = https://community.playstarbound.com/resources/smapi-extended-minecart.4359
+
   |nexus id =
 +
  |cf id    = 4359
 
   |source  = https://github.com/Entoarox/StardewMods
 
   |source  = https://github.com/Entoarox/StardewMods
 
   |status  = broken
 
   |status  = broken
Line 1,321: Line 1,329:
 
   |name    = Faster Paths
 
   |name    = Faster Paths
 
   |author  = Entoarox
 
   |author  = Entoarox
   |url      = https://community.playstarbound.com/resources/smapi-faster-paths.3641
+
   |nexus id =
 +
  |cf id    = 3641
 
   |source  = https://github.com/Entoarox/StardewMods
 
   |source  = https://github.com/Entoarox/StardewMods
 
   |status  = broken
 
   |status  = broken
Line 1,378: Line 1,387:
 
   |name    = Fishing Tuner Redux
 
   |name    = Fishing Tuner Redux
 
   |author  = Hammurabi
 
   |author  = Hammurabi
   |url      = https://community.playstarbound.com/resources/fishing-tuner-redux.4578
+
   |nexus id =
 +
  |cf id    = 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 -->
 
   |status  = workaround
 
   |status  = workaround
Line 1,434: Line 1,444:
 
   |name    = Furniture Anywhere
 
   |name    = Furniture Anywhere
 
   |author  = Entoarox
 
   |author  = Entoarox
   |url      = https://community.playstarbound.com/resources/smapi-furniture-anywhere.4324
+
   |nexus id =
 +
  |cf id    = 4324
 
   |source  = https://github.com/Entoarox/StardewMods
 
   |source  = https://github.com/Entoarox/StardewMods
 
   |status  = broken
 
   |status  = broken
Line 1,720: Line 1,731:
 
   |name    = Interaction Helper
 
   |name    = Interaction Helper
 
   |author  = Hammurabi
 
   |author  = Hammurabi
   |url      = https://community.playstarbound.com/resources/interaction-helper.4640
+
   |nexus id =
 +
  |cf id    = 4640
 
   |source  = https://community.playstarbound.com/resources/interaction-helper.4640/updates
 
   |source  = https://community.playstarbound.com/resources/interaction-helper.4640/updates
 
   |status  = broken
 
   |status  = broken
Line 1,920: Line 1,932:
 
   |name2    = ChatMod
 
   |name2    = ChatMod
 
   |author  = Kithio
 
   |author  = Kithio
   |url      = https://community.playstarbound.com/resources/message-box-api.4296
+
   |nexus id =
 +
  |cf id    = 4296
 
   |source  =  
 
   |source  =  
 
   |status  = abandoned
 
   |status  = abandoned
Line 2,075: Line 2,088:
 
   |name    = New Machines
 
   |name    = New Machines
 
   |author  = Igorious
 
   |author  = Igorious
   |url      = https://community.playstarbound.com/resources/smapi-new-machines-flour-sugar-vinegar-rice.3683
+
   |nexus id =
 +
  |cf id    = 3683
 
   |source  = https://github.com/Igorious/StardevValleyNewMachinesMod
 
   |source  = https://github.com/Igorious/StardevValleyNewMachinesMod
 
   |status  = broken
 
   |status  = broken
Line 2,430: Line 2,444:
 
   |name    = Regeneration
 
   |name    = Regeneration
 
   |author  = Hammurabi
 
   |author  = Hammurabi
   |url      = https://community.playstarbound.com/resources/regeneration.4584
+
   |nexus id =
 +
  |cf id    = 4584
 
   |source  = https://community.playstarbound.com/resources/regeneration.4584/updates
 
   |source  = https://community.playstarbound.com/resources/regeneration.4584/updates
 
   |status  = broken
 
   |status  = broken
Line 2,457: Line 2,472:
 
   |name    = Relationships Enhanced
 
   |name    = Relationships Enhanced
 
   |author  = rodrigovaz
 
   |author  = rodrigovaz
   |url      = https://community.playstarbound.com/resources/smapi-relationships-enhanced.4435
+
   |nexus id =
 +
  |cf id    = 4435
 
   |source  =  
 
   |source  =  
 
   |status  = workaround
 
   |status  = workaround
Line 2,495: Line 2,511:
 
   |name    = ReRegeneration
 
   |name    = ReRegeneration
 
   |author  = littleraskol
 
   |author  = littleraskol
   |url      = https://community.playstarbound.com/resources/reregeneration.4465
+
   |nexus id =
 +
  |cf id    = 4465
 
   |source  =  
 
   |source  =  
 
   |status  = broken
 
   |status  = broken
Line 2,596: Line 2,613:
 
   |name    = Scroll To Blank
 
   |name    = Scroll To Blank
 
   |author  = Caraxian
 
   |author  = Caraxian
   |url      = https://community.playstarbound.com/resources/scroll-to-blank.4405
+
   |nexus id =
 +
  |cf id    = 4405
 
   |source  =  
 
   |source  =  
 
   |status  = workaround
 
   |status  = workaround
Line 2,620: Line 2,638:
 
   |name    = Seasonal Immersion
 
   |name    = Seasonal Immersion
 
   |author  = Entoarox
 
   |author  = Entoarox
   |url      = https://community.playstarbound.com/resources/4262
+
   |nexus id =
 +
  |cf id    = 4262
 
   |source  = https://github.com/Entoarox/StardewMods
 
   |source  = https://github.com/Entoarox/StardewMods
 
   |status  = broken
 
   |status  = broken
Line 2,717: Line 2,736:
 
   |name    = Shop Expander
 
   |name    = Shop Expander
 
   |author  = Entoarox
 
   |author  = Entoarox
   |url      = https://community.playstarbound.com/resources/shop-expander.4381
+
   |nexus id =
 +
  |cf id    = 4381
 
   |source  = https://github.com/Entoarox/StardewMods
 
   |source  = https://github.com/Entoarox/StardewMods
 
   |status  = broken
 
   |status  = broken
Line 2,726: Line 2,746:
 
   |name    = Showcase
 
   |name    = Showcase
 
   |author  = Igorious
 
   |author  = Igorious
   |url      = https://community.playstarbound.com/resources/showcase.4487
+
   |nexus id =
 +
  |cf id    = 4487
 
   |source  = https://github.com/Igorious/Stardew_Valley_Showcase_Mod/
 
   |source  = https://github.com/Igorious/Stardew_Valley_Showcase_Mod/
 
   |status  = broken
 
   |status  = broken
Line 2,910: Line 2,931:
 
   |name    = Sprinkles
 
   |name    = Sprinkles
 
   |author  = Platonymous
 
   |author  = Platonymous
   |url      = https://community.playstarbound.com/resources/smapi-sprinkles.4592
+
   |nexus id =
 +
  |cf id    = 4592
 
   |source  =  
 
   |source  =  
 
   |status  = workaround
 
   |status  = workaround
Line 2,949: Line 2,971:
 
   |name    = Sprint and Dash Redux
 
   |name    = Sprint and Dash Redux
 
   |author  = littleraskol
 
   |author  = littleraskol
   |url      = https://community.playstarbound.com/resources/4201
+
   |nexus id =
 +
  |cf id    = 4201
 
   |source  = https://community.playstarbound.com/resources/4201
 
   |source  = https://community.playstarbound.com/resources/4201
 
}}
 
}}
Line 3,071: Line 3,094:
 
   |name    = Stephan's Lots of Crops
 
   |name    = Stephan's Lots of Crops
 
   |author  = stephanreiken
 
   |author  = stephanreiken
   |url      = https://community.playstarbound.com/resources/4314
+
   |nexus id =
 +
  |cf id    = 4314
 
   |source  =  
 
   |source  =  
 
   |status  = broken
 
   |status  = broken
Line 3,154: Line 3,178:
 
   |name    = Teleporter
 
   |name    = Teleporter
 
   |author  = Bifibi
 
   |author  = Bifibi
   |url      = https://community.playstarbound.com/resources/4374
+
   |nexus id =
 +
  |cf id    = 4374
 
   |source  =  
 
   |source  =  
 
   |status  = workaround
 
   |status  = workaround
Line 3,348: Line 3,373:
 
   |name    = Wallpaper Fix
 
   |name    = Wallpaper Fix
 
   |author  = Travoos
 
   |author  = Travoos
   |url      = https://community.playstarbound.com/resources/smapi-wallpaper-fix.4211
+
   |nexus id =
 +
  |cf id    = 4211
 
   |source  =  
 
   |source  =  
 
   |status  = broken
 
   |status  = broken
Line 3,443: Line 3,469:
 
   |name    = Xnb Loader
 
   |name    = Xnb Loader
 
   |author  = Entoarox
 
   |author  = Entoarox
   |url      = https://community.playstarbound.com/resources/xnb-loader.4506
+
   |nexus id =
 +
  |cf id    = 4506
 
   |source  = https://github.com/Entoarox/StardewMods
 
   |source  = https://github.com/Entoarox/StardewMods
 
   |status  = broken
 
   |status  = broken
Line 3,452: Line 3,479:
 
   |name    = zDailyIncrease
 
   |name    = zDailyIncrease
 
   |author  = thakyZ
 
   |author  = thakyZ
   |url      = https://community.playstarbound.com/resources/4247
+
   |nexus id =
 +
  |cf id    = 4247
 
   |source  = https://github.com/thakyZ/zDailyIncrease
 
   |source  = https://github.com/thakyZ/zDailyIncrease
 
   |status  = broken
 
   |status  = broken

Revision as of 19:48, 18 May 2018

Modding:Player Guide/header

This page is for Stardew Valley 1.3 beta only. If you haven't opted in to the beta, see compatibility for Stardew Valley 1.2 instead.
SMAPI mod compatibility, July 2017 to April 2018. The two main events are Stardew Valley 1.2 in July 2017, and Stardew Valley 1.3 in April 2018.

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.

For players (Stardew Valley 1.3 beta)

Note: during the Stardew Valley 1.3 beta, mods may provide an optional update without changing their main version. SMAPI won't show an update alert in those cases, but the updates will be listed here.

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.6+ and Stardew Valley 1.3+. Content packs aren't listed unless incompatible. It's updated periodically for new mod releases.

XNB mods

XNB mods are an older type of mod and are no longer recommended. This section shows SMAPI or Content Patcher mods you can use instead. (Content Patcher is a SMAPI mod that makes XNB-like changes with all the benefits of SMAPI content packs.)

Modders: when migrating XNB mods, only use Action: Load if you actually need to replace the whole file (e.g. portrait mods). Don't use Action: Load for dialogue mods or to change a small part of a file! Always check the official mod page to see if a conversion has been officially uploaded. This list excludes mods native to Content Patcher.

Modding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnb

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 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).

Overall compatibility

 
48% are compatible or have a working alternative.
 
34% have an update coming soon.
 
18% are broken and not open-source.¹

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

Footnotes

  1. This only shows whether a mod is compatible; it may have bugs unrelated to SMAPI compatibility.
  2. 2.00 2.01 2.02 2.03 2.04 2.05 2.06 2.07 2.08 2.09 2.10 2.11 2.12 2.13 2.14 2.15 2.16 2.17 2.18 2.19 2.20 2.21 2.22 2.23 2.24 2.25 2.26 2.27 2.28 2.29 2.30 2.31 2.32 2.33 2.34 2.35 2.36 2.37 2.38 2.39 2.40 2.41 2.42 2.43 2.44 2.45 2.46 2.47 2.48 2.49 2.50 2.51 2.52 2.53 2.54 2.55 2.56 2.57 2.58 2.59 2.60 2.61 2.62 2.63 2.64 If a mod says "use optional download", its main version isn't compatible but there's an official optional update. If the mod is on Nexus, click "Files" on the mod page and check for a newer version (often under 'optional files').

Modding:Player Guide/footer