Difference between revisions of "Modding:Player Guide"

From Stardew Valley Wiki
Jump to navigation Jump to search
(move some content to 'troubleshooting' page)
(split content to other guide pages, rewrite into intro)
Line 1: Line 1:
 
{{/header}}
 
{{/header}}
  
−
Do you want to play Stardew Valley with mods? This page is for you!
+
Do you want to play Stardew Valley with mods? This guide is for you!
  
 
==Intro==
 
==Intro==
Line 7: Line 7:
 
A ''mod'' is just a package of files which changes Stardew Valley in some way. Mods can add features (like showing NPCs on the map), change game mechanics (like making fences decay more slowly), make cosmetic changes (like making your house look like a hobbit home), and more.
 
A ''mod'' is just a package of files which changes Stardew Valley in some way. Mods can add features (like showing NPCs on the map), change game mechanics (like making fences decay more slowly), make cosmetic changes (like making your house look like a hobbit home), and more.
  
−
There are three types of mods:
+
===Are mods complicated to use?===
−
* '''SMAPI mods''' use SMAPI (the Stardew Valley mod loader) to run code within the game. These mods are powerful and convenient. After installing SMAPI, you can install mods by dropping them into a folder and uninstall them by deleting their folder. You can use multiple SMAPI mods, and they'll rarely conflict.
+
Using mods is easy! You just need to...
−
* '''SMAPI content packs''' are loaded by a SMAPI mod. As a player, you can just install them the same way as SMAPI mods.
+
# 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.
−
* '''XNB mods''' are discouraged and not documented here (see [[Modding:Using XNB mods|using XNB mods]]).
+
# Unzip mods into your <tt>Mods</tt> folder.
  
−
===What is SMAPI?===
+
That's about it!
−
[https://smapi.io/ SMAPI] 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.
 
  
−
===Can I use mods on Linux, Mac, Windows, or consoles?===
+
===Okay, how do I start?===
−
Mod support for each platform:
+
See [[/Getting Started|Getting Started]].
−
{| 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 (including GetDressed, Makeshift Multiplayer, and Save Anywhere). If you avoid those, mods are very unlikely to corrupt your save file. 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.
 
−
 
 
−
In most cases, you can fix save corruption by [[Saves#Undo the last save|undoing the last save]].
 
−
 
 
−
===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|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.
 
−
 
 
−
==Finding the game files==
 
−
===Save files===
 
−
See ''[[Saves]]''.
 
−
 
 
−
===Game folder===
 
−
See ''[[Modding:Player Guide/Getting Started#Find your game folder]]''.
 
−
 
 
−
===SMAPI log===
 
−
The SMAPI log has useful info for troubleshooting problems (like your versions, mods, game path, errors, etc).
 
−
 
 
−
Here's how to share it:
 
−
<ol>
 
−
<li>Find the log file here:
 
−
 
 
−
{| class="wikitable"
 
−
|-
 
−
! Platform
 
−
! Path
 
−
|-
 
−
| Windows
 
−
| <tt>%appdata%\StardewValley\ErrorLogs\SMAPI-latest.txt</tt><br /><small>(Paste "<tt>%appdata%</tt>" into the address bar, Windows knows where it is.)</small>
 
−
|-
 
−
| Linux
 
−
| <tt>~/.config/StardewValley/ErrorLogs/SMAPI-latest.txt</tt><br /><small>(The folder is hidden by default. From Files, click ''Go » Enter Location'' and enter "~/.config".)</small>
 
−
|-
 
−
| Mac
 
−
| <tt>~/.config/StardewValley/ErrorLogs/SMAPI-latest.txt</tt><br /><small>(The folder is hidden by default. From Finder, click ''Go » Go to Folder'' and enter "~/.config".)</small>
 
−
|}
 
−
</li>
 
−
 
 
−
<li>Upload the file to [https://log.smapi.io log.smapi.io] and share the link.</li>
 
−
</ol>
 
  
 
[[zh:使用模组：玩家常见问题]]
 
[[zh:使用模组：玩家常见问题]]

Revision as of 02:34, 28 April 2018

Modding:Player Guide/header

Do you want to play Stardew Valley with mods? This guide is for you!

Intro

What are mods?

A mod is just a package of files which changes Stardew Valley in some way. Mods can add features (like showing NPCs on the map), change game mechanics (like making fences decay more slowly), make cosmetic changes (like making your house look like a hobbit home), and more.

Are mods complicated to use?

Using mods is easy! You just need to...

  1. 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.
  2. Unzip mods into your Mods folder.

That's about it!

Okay, how do I start?

See Getting Started.

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