Jump to content

Modding:Mod compatibility: Difference between revisions

From Stardew Valley Wiki
imported>Pathoschild
→SMAPI mods: + source links for Teban100's mods
imported>Pathoschild
Line 3,529: Line 3,529:
   |url      = https://www.nexusmods.com/stardewvalley/mods/1326
   |url      = https://www.nexusmods.com/stardewvalley/mods/1326
   |source  = https://github.com/rockinrolla/ZoomMod
   |source  = https://github.com/rockinrolla/ZoomMod
}}
|}
===XNB mods===
'''XNB mods are an older type of mod and are no longer recommended.''' This section shows SMAPI or [https://www.nexusmods.com/stardewvalley/mods/1915 Content Patcher] mods you can use instead. (Content Patcher is a SMAPI mod that makes XNB-like changes with all the benefits of [[Modding:Content packs|SMAPI content packs]].)
'''Modders:''' when migrating XNB mods, only use <tt>Action: Load</tt> if you actually need to replace the whole file (e.g. portrait mods). Don't use <tt>Action: Load</tt> for dialogue mods or to change a small part of a file!
{| class="wikitable plainlinks sortable"
|-
! mod name
! original author
! Content Patcher equivalent
! links
|-
{{/xnb
  |original name  = Abigail Portrait With Subtle Bow and More Accurate Bow Sprites
  |original author = Androxilogin
  |original url    = https://www.nexusmods.com/stardewvalley/mods/320
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3258748
  |update author  = MouseyPounds
  |update version  = 1.1
}}
{{/xnb
  |original name  = Animal Crossing Digspot - Worm Replacement
  |original author = yuiidragon
  |original url    = https://www.nexusmods.com/stardewvalley/mods/18
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3259191
  |update author  = MouseyPounds
  |update version  = 1.1
}}
{{/xnb
  |original name  = Badass Sam
  |original author = Apogirl02
  |original url    = https://www.nexusmods.com/stardewvalley/mods/1606
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3259170
  |update author  = paradigmnomad
  |update version  = 1.0
}}
{{/xnb
  |original name  = Bath House Hot Spring
  |original author = MiniPantsu
  |original url    = https://www.nexusmods.com/stardewvalley/mods/558
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3258917
  |update author  = paradigmnomad
  |update version  = 1.0
}}
{{/xnb
  |original name  = Bathroom After 2nd House Upgrade
  |original author = DevilBro
  |original url    = https://www.nexusmods.com/stardewvalley/mods/299
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3258748
  |update author  = MouseyPounds
  |update version  = 1.4
}}
{{/xnb
  |original name  = Bernese Mountain Dog
  |original author = Gweniaczek
  |original url    = https://www.nexusmods.com/stardewvalley/mods/1848
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3258738
  |update author  = paradigmnomad
  |update version  = 1.0
}}
{{/xnb
  |original name  = Better Artifact Digspots
  |original author = joyous1ariella
  |original url    = https://www.nexusmods.com/stardewvalley/mods/774
  |update name    = Bouncy Chests
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3258840
  |update author  = ShneekeyTheLost
  |update version  = 1.0
}}
{{/xnb
  |original name  = Better Grass Visibility
  |original author = mmanlapat
  |original url    = https://www.nexusmods.com/stardewvalley/mods/1118
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3258748
  |update author  = MouseyPounds
  |update version  = 1.1
}}
{{/xnb
  |original name  = Better Void Chicken
  |original author = vvillow
  |original url    = https://www.nexusmods.com/stardewvalley/mods/1355
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3258738
  |update author  = paradigmnomad
  |update version  = 1.0
}}
{{/xnb
  |original name  = Bird Replacments for Babies and Toddlers
  |original author = Ankokou
  |original url    = https://www.nexusmods.com/stardewvalley/mods/309
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3258948
  |update author  = paradigmnomad
  |update version  = 1.0
}}
{{/xnb
  |original name  = Darker Wood and Gold Craftables
  |original author = Eemie
  |original url    = https://www.nexusmods.com/stardewvalley/mods/687/
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/page-2#post-3261049
  |update author  = Fyn
  |update version  = 1.0
}}
{{/xnb
  |original name  = Emily Sprite and Portrait Overhaul
  |original author = tolerdesigns
  |original url    = https://www.nexusmods.com/stardewvalley/mods/1004
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3258748
  |update author  = MouseyPounds
  |update version  = 1.0
}}
{{/xnb
  |original name  = Eemie Classy Interior
  |original author = Eemie
  |original url    = https://www.nexusmods.com/stardewvalley/mods/854
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/page-2#post-3263281
  |update author  = Asher404
  |update version  = 1.0
}}
{{/xnb
  |original name  = Haywrites Narrative Overhaul - Year One Edition
  |original author = Haywrites
  |original url    = https://www.nexusmods.com/stardewvalley/mods/1978
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/page-2#post-3263281
  |update author  = Asher404
  |update version  = 1.0
}}
{{/xnb
  |original name  = Hobbit Hole
  |original author = Pathoschild
  |original url    = https://community.playstarbound.com/threads/lemons-characters-more-update-clint.109961
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/lemons-characters-more-update-clint.109961/page-5#post-3268689
  |update author  = Pathoschild
  |update version  = 1.0-unofficial.1-pathoschild
}}
{{/xnb
  |original name  = Improved Shed Mod
  |original author = wintrparkgrl
  |original url    = https://www.reddit.com/r/StardewValley/comments/55x9hj/improved_shed_mod/
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3258682
  |update author  = ShneekeyTheLost
  |update version  = 1.0
}}
{{/xnb
  |original name  = Kitty Scarecrow Replacements
  |original author = Jinxiewinxie
  |original url    = https://www.nexusmods.com/stardewvalley/mods/191/
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/page-2#post-3262154
  |update author  = f4iTh
  |update version  = 1.0
}}
{{/xnb
  |original name  = Linus With Clothes
  |original author = Goodledoodoo
  |original url    = https://www.nexusmods.com/stardewvalley/mods/1512
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3259170
  |update author  = paradigmnomad
  |update version  = 1.0
}}
{{/xnb
  |original name  = Marshmallow Unicorn
  |original author = summonercat
  |original url    = https://community.playstarbound.com/threads/marshmallow-unicorn.116854/#post-3134876
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3258738
  |update author  = paradigmnomad
  |update version  = 1.0
}}
{{/xnb
  |original name  = Matching Slime Hutch
  |original author = SlushieSlowpoke
  |original url    = https://www.nexusmods.com/stardewvalley/mods/111
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3258748
  |update author  = MouseyPounds
  |update version  = 1.0-Final
}}
{{/xnb
  |original name  = More Accurate Dwarf
  |original author = spacedoggity
  |original url    = https://www.nexusmods.com/stardewvalley/mods/1470
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3258748
  |update author  = MouseyPounds
  |update version  = 1.0
}}
{{/xnb
  |original name  = Nerdy Hot Maru
  |original author = tolerdesigns
  |original url    = https://www.nexusmods.com/stardewvalley/mods/1029
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3258748
  |update author  = MouseyPounds
  |update version  = 1.2
}}
{{/xnb
  |original name  = No More Bowlegs
  |original author = Chrysanthe
  |original url    = https://www.nexusmods.com/stardewvalley/mods/346
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3259723
  |update author  = f4iTh
  |update version  = 1.0
}}
{{/xnb
  |original name  = Non-Default Replacement Chickens
  |original author = Lavapulse
  |original url    = https://community.playstarbound.com/threads/non-default-replacement-chickens-silkie-orpington-barred-rock.109826/
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3258738
  |update author  = paradigmnomad
  |update version  = 1.0
}}
{{/xnb
  |original name  = Realistic Animal Replacements
  |original author = Crucifigo
  |original url    = https://community.playstarbound.com/threads/new-free-to-edit-wips-crucifigos-livestock-semi-realistic-animal-replacers.109480/
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3259729
  |update author  = paradigmnomad
  |update version  = 1.0
}}
{{/xnb
  |original name  = Rocky Junimo Hut
  |original author = Gweniaczek
  |original url    = https://www.nexusmods.com/stardewvalley/mods/1870
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3258738
  |update author  = paradigmnomad
  |update version  = 1.0
}}
{{/xnb
  |original name  = Sebastian - New Hair and Moto Jacket
  |original author = ktruong
  |original url    = https://www.nexusmods.com/stardewvalley/mods/877
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3259170
  |update author  = paradigmnomad
  |update version  = 1.0
}}
{{/xnb
  |original name  = Slime Animals
  |original author = Sabishi1985
  |original url    = https://community.playstarbound.com/threads/slime-animals-last-update-09-10-2016.110931/
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3258724
  |update author  = paradigmnomad
  |update version  = 1.0
}}
{{/xnb
  |original name  = Spouse Rooms Redesigned
  |original author = endermaryn
  |original url    = https://community.playstarbound.com/resources/spouse-rooms-redesigned.3675/
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3260091
  |update author  = Fyn
  |update version  = 6.0
}}
{{/xnb
  |original name  = Tokiri's Pet Replacements - Dog (Fox)
  |original author = Tokiri
  |original url    = https://community.playstarbound.com/threads/tokiris-pet-replacements-fox-wolf-red-panda-update-red-panda-finished.110263/
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/page-2#post-3262199
  |update author  = magicalgirl44
  |update version  = 1.0
}}
{{/xnb
  |original name  = Tokiri's Pet Replacements - Horse (Ridable wolf)
  |original author = Tokiri
  |original url    = https://community.playstarbound.com/threads/tokiris-pet-replacements-fox-wolf-red-panda-update-red-panda-finished.110263/
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/page-2#post-3262199
  |update author  = magicalgirl44
  |update version  = 1.0
}}
{{/xnb
  |original name  = Villagers Anime Portrait
  |original author = Bunnihime
  |original url    = https://www.nexusmods.com/stardewvalley/mods/97
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3259723
  |update author  = f4iTh
  |update version  = 1.0
}}
{{/xnb
  |original name  = Yet Another Dog Mod
  |original author = captain kaltz+
  |original url    = https://community.playstarbound.com/threads/yet-another-dog-mod-pomeranian%E2%AD%90bull-terrier%E2%AD%90more.137293/
  |update name    = unofficial update
  |update url      = https://community.playstarbound.com/threads/migrating-xnb-mods-to-content-patcher-packs.141577/#post-3258738
  |update author  = paradigmnomad
  |update version  = 1.0
}}
}}
|}
|}

Revision as of 17:41, 30 April 2018

Modding:Player Guide/header

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.

Check the section applicable to you:

For players (Stardew Valley 1.3 beta)

The following describes the upcoming Stardew Valley 1.3, and may change before release.
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!

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/xnb
  1. ↑ This only shows whether a mod is compatible; it may have bugs unrelated to SMAPI compatibility.

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

For Stardew Valley 1.3
 
30% are compatible or have a working alternative.
 
43% have an update coming soon.
 
27% are broken and not open-source.¹

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

For Stardew Valley 1.2
 
94% are compatible or have a working alternative.
 
1% have an update coming soon.
 
5% are broken and not open-source.¹
¹ Many of these broke due to a Stardew Valley update. Some may be updated by their authors later.

Modding:Player Guide/footer