Difference between revisions of "Modding:Using XNB mods"

From Stardew Valley Wiki
Jump to navigation Jump to search
(emphasise deprecation)
(→‎Alternatives using Content Patcher: moved to compatibility page)
Line 63: Line 63:
 
[https://www.nexusmods.com/stardewvalley/mods/1915 Content Patcher] is a SMAPI mod that makes XNB-like changes with all the benefits of [[Modding:Content packs|SMAPI content packs]]. Many XNB mods have a Content Patcher equivalent, or have been updated unofficially to use it. Consider using these instead where available.
 
[https://www.nexusmods.com/stardewvalley/mods/1915 Content Patcher] is a SMAPI mod that makes XNB-like changes with all the benefits of [[Modding:Content packs|SMAPI content packs]]. Many XNB mods have a Content Patcher equivalent, or have been updated unofficially to use it. Consider using these instead where available.
  
'''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!
+
See [[Modding:SMAPI compatibility#XNB mods]].
 
 
{| class="wikitable plainlinks sortable"
 
|-
 
! mod name
 
! original author
 
! Content Patcher equivalent
 
! links
 
|-
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
{{/entry
 
  |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
 
}}
 
|}
 
  
 
==Using XNB mods==
 
==Using XNB mods==

Revision as of 17:42, 30 April 2018

Index

XNB mods are an older type of mod and are no longer recommended. SMAPI cannot validate them for compatibility. Use XNB mods at your own risk.

An XNB mod replaces some of your game's .xnb files to change the game in some way.

FAQs

What are XNB mods?

XNB mods work by replacing your game's data files (which have a .xnb extension). For example, let's say you want to change Abigail's portraits; you can replace Content/Portraits/Abigail.xnb with a modded version to do it. (See editing XNB files for more info on the XNB format.)

Why are they discouraged?

XNB mods have a lot of limitations, often conflict with each other, usually break when the game updates, are hard to install and remove, etc.

Consider only using SMAPI mods and content packs. These have several benefits over XNB mods:

feature XNB mods SMAPI mods SMAPI content packs
ease of installation ✘ different for every mod ✓ drop into Mods
ease of uninstallation ✘ manually restore original files ✓ remove from Mods
update checks ✘ none ✓ automatic alert in SMAPI console
compatibility checks ✘ none ✓ incompatible mods are disabled before they cause problem
compatibility list is regularly updated with updates and workarounds
mod compatibility ✘ each file can only be replaced once ✓ almost universal ✓ high
translation support ✘ difficult to translate ✓ built-in translation API (depends on the content pack)
game compatibility ✘ broken by most game updates ✓ SMAPI automatically rewrites many mods for compatibility
✓ open-source mods are updated quickly

Do they work on Linux, Mac, Windows, or consoles?

XNB mods work equally on Linux, Mac, and Windows. Consoles aren't supported.

Can they corrupt my save?

Yes, but it's uncommon. Make sure you back up your save files occasionally, and remove any custom content before uninstalling an XNB mod. In most cases, you can fix save corruption by undoing the last save.

Do they disable Steam achievements?

Nope.

Alternatives using Content Patcher

Content Patcher is a SMAPI mod that makes XNB-like changes with all the benefits of SMAPI content packs. Many XNB mods have a Content Patcher equivalent, or have been updated unofficially to use it. Consider using these instead where available.

See Modding:SMAPI compatibility#XNB mods.

Using XNB mods

Find mods

If you're looking for mods, the most popular are a good place to start.

You can find mods in a few places:

site description
Nexus Mods Most mods are released here.
(Registering an account is free, just don't choose a package when you register.)
Chucklefish mods Some mods are released here (most are also on Nexus).
Stardew Valley forums Some mods are posted directly in the forums. Some hidden gems are only here, but finding them can be a challenge.

Before you download a mod...

  • Does it work with the latest version of the game? XNB mods may be outdated and cause problems. Try checking the mod description or comments. Generally avoid any XNB mod not updated after the last game update.
  • Don't download from stardewvalleymods.net. (Mods here are usually outdated, since the site republishes mods without permission for ad revenue.)

Install mods

Installation is different for each mod; check its mod description for details. But in general:

  1. Download the XNB mod and unzip it somewhere (not in your game folder!).
  2. It should contain some .xnb files.
  3. Find your game folder.
  4. Replace the existing .xnb files under Content with the ones from the mod. Make sure you replace the correct files! There are different files with the same name (like Content/Data/hats.xnb and Content/Characters/hats.xnb), and replacing the wrong file will cause in-game errors or crashes.

Uninstall mods

Either restore the original files that mod replaced (hope you kept track!), or reset your game files.

Troubleshooting

Reset content files

If you know which mod caused the problem, uninstall it.

If you're not sure, the simplest option is:

  1. reset your game files;
  2. reinstall each XNB mod one by one;
  3. test after each install to make sure it didn't cause problems.

Other issues

See Modding:Player FAQs#Troubleshooting for more suggestions.