translators
8,404
edits
Changes
Modding:Player Guide/Getting Started (view source)
Revision as of 16:58, 13 October 2018
, 16:58, 13 October 2018move 'getting started' to top, tweaks
Using mods is easy! You just need to...
Using mods is easy! You just need to...
# Install SMAPI. This is the mod loader for Stardew Valley — it launches the game with mod support and lets mods interact directly with the game code. It's safely installed alongside your normal game, and you can uninstall it anytime.
# Install SMAPI. That's the mod loader for Stardew Valley — it launches the game with mod support and lets mods interact directly with the game code. It's safely installed alongside your normal game, and you can uninstall it anytime.
# Unzip mods into your <tt>Mods</tt> folder.
# Unzip mods into your <tt>Mods</tt> folder.
See below for common questions and help getting started.
See [[#Frequent questions|frequent questions below]], or keep reading to get started!
!style="text-align: left;"| effects
==Getting started==
==Getting started==
==XNB mods==
==XNB mods==
XNB mods replace files in your game's <code>Content</code> folder with custom versions. If a mod has some <code>.xnb</code> files and no <code>manifest.json</code>, it's an XNB mod. This is an older type of mod that's no longer recommended, but see [[Modding:Using XNB mods]] if you're still interested.
XNB mods replace files in your game's <code>Content</code> folder with custom versions. If a mod has some <code>.xnb</code> files and no <code>manifest.json</code>, it's an XNB mod. This is an older type of mod that's no longer recommended, but see [[Modding:Using XNB mods]] if you're still interested.
==Frequent questions==
===Can I use mods on Linux, Mac, Windows, or consoles?===
Mod support for each platform:
{| class="wikitable"
|-
! Platform
! Mod support
|-
| Linux
| ✓ fully supported
|-
| Mac
| ✓ fully supported
|-
| Windows
| ✓ fully supported
|-
| Nintendo Switch
| ✖ no mod support
|-
| PS4
| ✖ no mod support
|-
| XBox One
| ✖ no mod support
|}
Almost all mods will work on any supported platform, since SMAPI rewrites them for compatibility.
===Can mods corrupt my save?===
Yes, but it's extremely rare. Only a few mods affect your save file at all. If you avoid those, mods are very unlikely to corrupt your save file. In most cases, you can fix save corruption by [[Saves#Undo the last save|undoing the last save]].
If you're worried, just back up [[#Save files|your save files]] occasionally. That's strongly recommended even if you don't use mods, since save corruption is almost always caused by the game itself. SMAPI also creates a daily backup of your saves automatically; you can retrieve those from the <tt>Mods/SaveBackup</tt> folder.
===Can I stop using mods later?===
Yep. With a few exceptions (see previous question), mods don't directly affect your save file so you can stop using them anytime.
===Do mods disable Steam achievements?===
Steam achievements work fine, as long as you launch SMAPI through Steam. Make sure you follow the [[Modding:Installing SMAPI on Windows|install instructions]] to configure Steam on Windows (no Steam changes needed on Linux or Mac). If the Steam overlay works, the achievements should work too.
===Do mods work in multiplayer?===
Yep. Stardew Valley 1.3 is still new, so check the [[Modding:SMAPI compatibility|SMAPI compatibility list]] to see if the mod is compatible.
How they work depends on the mod. Usually each player can have their own mods, and you can mix modded and vanilla players. Some mods don't work (or work poorly) in multiplayer, or affect other players too. Try checking the mod description for details about multiplayer (often under a 'compatibility' header).
Here are some ''approximate'' rules for mods that don't specify:
{| class="wikitable"
|-
!style="text-align: left;"| type of mod
!style="text-align: left;"| effects
!style="text-align: left;"| summary
|-
| Content Patcher
| ''depends''
| See [https://github.com/Pathoschild/StardewMods/tree/develop/ContentPatcher#multiplayer ''Multiplayer'' in the Content Patcher readme] (applies for XNB mods too).
|-
| Map replacements
| local
| That includes mods which replace an existing map (without adding special logic with SMAPI). These are only visible to players who install them. Players without the custom map will see the normal map and will be subject to the normal bounds (e.g. they may see other players walk through walls, but they won't be able to follow).
|-
| Visual changes
| local
| That includes custom portraits and sprites, custom farmer appearance (except GetDressed or Kisekae), recolors, etc. These mods only affect the players who installed them. Other players won't be affected. If both players have the same mods, they'll see the same visual changes though.
|-
| Time changes
| global
| That includes any mod which pauses time, changes the current time, or changes the rate of time. These mods only work when installed by the main player, but will affect all players. They will have no effect when used by farmhands.
|-
| Custom UI
| local
| That includes mods that add new icons, tooltips, and menus. These mods only affect the players who installed them. Other players won't be affected.
|-
| World changes
| global
| That includes any mods which edit things in the world — durable fences, monster stat changes, etc. These mods affect all players, no matter who installs them.
|-
| Other mods
| ''depends''
| See the mod's description for details, or ask the author.
|}
===What is SMAPI?===
SMAPI is the mod loader for Stardew Valley. It works fine with GOG and Steam achievements, it's compatible with Linux/Mac/Windows, you can uninstall it anytime, and there's a friendly community if you need help. SMAPI is required for most types of Stardew Valley mod.
SMAPI does a lot for you. For example, it will...
# Load mods into the game and provide APIs they can use. Many types of mod aren't possible without SMAPI.
# Rewrite mods for crossplatform compatibility, so you can use almost any mod on Linux/Mac/Windows.
# Intercept errors. If a mod crashes or causes an error, SMAPI will intercept the error, show the error details in the console window, and in most cases automatically recover the game.
# Provide update checks. SMAPI automatically alerts you when a new version of a mod is available.
# Provide compatibility checks. SMAPI automatically detects when a mod is incompatible and disables it before it causes problems.
===Where are my...===
* Game folder: see ''[[#Find your game folder|Getting Started#Find your game folder]]''.
* SMAPI log: see ''[[Modding:Player Guide/Troubleshooting#Find your SMAPI log|Troubleshooting#Find your SMAPI log]]''.
* Save files: see ''[[Saves]]''.
{{Modding guide footer
{{Modding guide footer