Difference between revisions of "Modding:Player Guide/Getting Started"

From Stardew Valley Wiki
Jump to navigation Jump to search
(+ player guide header)
(integrate some content from the old FAQs page (main author is Pathoschild with contributions by tstaples))
Line 1: Line 1:
 
{{../header}}
 
{{../header}}
  
For help installing, updating, or removing SMAPI:
+
Now that [[../|you know the basics of moddings]], here's how to get started!
 +
 
 +
==Getting started==
 +
===Install SMAPI===
 +
First you'll need to install the mod loader, SMAPI. Click the right link for more info:
 +
 
 
* [[Modding:Installing SMAPI on Linux|Instructions for Linux]]
 
* [[Modding:Installing SMAPI on Linux|Instructions for Linux]]
 
* [[Modding:Installing SMAPI on Mac|Instructions for Mac]]
 
* [[Modding:Installing SMAPI on Mac|Instructions for Mac]]
 
* [[Modding:Installing SMAPI on Windows|Instructions for Windows]]
 
* [[Modding:Installing SMAPI on Windows|Instructions for Windows]]
 +
 +
===Find mods===
 +
Next you need to choose the mods you want. See the [http://www.nexusmods.com/stardewvalley/mods/topalltime/ most popular mods] or these [https://gist.github.com/Pathoschild/b608892d3e60bd25d0eea71ca7584649 recommendations for a first playthrough]. You can also search for mods here:
 +
{| class="wikitable"
 +
|-
 +
! site
 +
! description
 +
|-
 +
| '''[http://nexusmods.com/stardewvalley/ Nexus Mods]'''
 +
| Most mods are released here.<br /><small>(Registering an account is free, just don't choose a package when you register.)</small>
 +
|-
 +
| [http://community.playstarbound.com/resources/categories/stardew-valley.22/ Chucklefish mods]
 +
| Some mods are released here (most are also on Nexus).
 +
|-
 +
| [https://www.moddrop.com ModDrop]
 +
| Pretty new. Not many mods yet, but you can install those it has very quickly through their (Windows-only) client.
 +
|-
 +
| [http://community.playstarbound.com/forums/mods.215/ 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? (SMAPI will automatically disable most incompatible SMAPI mods, but you're on your own with XNB mods. Try checking the mod description or comments.)
 +
* Don't download from stardewvalleymods.net. (Mods here are usually outdated, since the site republishes mods without permission for ad revenue.)
 +
 +
===Find your game folder===
 +
Next you'll need to open your game folder (the one containing Stardew Valley's <tt>.exe</tt> file). Here's where to find it:
 +
 +
{| class="wikitable"
 +
|-
 +
! Platform
 +
! Path
 +
|-
 +
| Windows
 +
| GOG: <tt>C:\Program Files (x86)\GalaxyClient\Games\Stardew Valley</tt><br />Steam: <tt>C:\Program Files (x86)\Steam\steamapps\common\Stardew Valley</tt>
 +
|-
 +
| Linux
 +
| GOG: <tt>~/GOG Games/Stardew Valley/game</tt><br />Steam: <tt>~/.local/share/Steam/steamapps/common/Stardew Valley</tt>
 +
|-
 +
| Mac
 +
| GOG: <tt>/Applications/Stardew Valley.app/Contents/MacOS</tt><br />Steam: <tt>~/Library/Application Support/Steam/steamapps/common/Stardew Valley/Contents/MacOS</tt><br /><br />On Mac, the <tt>Content</tt> folder is stored separately:<br />GOG: <tt>/Applications/Stardew Valley.app/Resources/Content</tt><br />Steam: <tt>~/Library/Application Support/Steam/steamapps/common/Stardew Valley/Resources/Content</tt>
 +
|}
 +
 +
Not there? Here are some other ways to find it:
 +
 +
{{collapse|more options|content=&#32;
 +
; Option 2&#58; find it through SMAPI
 +
 +
:# Launch SMAPI.
 +
:# Enter this command in the SMAPI console (the second window that opens with the game): <pre>show_game_files</pre>
 +
 +
; Option 3&#58; find it through Steam
 +
 +
:# Open the Steam client.
 +
:# Right-click on ''Stardew Valley''.
 +
:# Click ''Properties''.
 +
:# Click the ''Local Files'' tab.
 +
:# Click the ''Browse Local Files...'' button to open the game folder.
 +
 +
; Option 4&#58; find it through GOG Galaxy
 +
 +
:# Open the GOG Galaxy client.
 +
:# In the game sidebar, right-click on ''Stardew Valley''.
 +
:# Choose ''Manage Installation > Show Folder'' to open the game folder.
 +
}}
 +
 +
===Install mods===
 +
To install a mod, just unzip it into the <tt>Mods</tt> folder in [[#Find your game folder|your game folder]]. Make sure each mod has its own subfolder. For example, if you have a <tt>PineapplesEverywhere</tt> mod, you should have a file structure like this:
 +
<pre>
 +
Stardew Valley/
 +
  Mods/
 +
      PineapplesEverywhere/
 +
        PineapplesEverywhere.dll
 +
        manifest.json
 +
</pre>
 +
 +
===Configure mods===
 +
Some mods have a <tt>config.json</tt> file in their mod folder. It might be created the first time you launch the game with that mod. This file lets you customise the mod settings.
 +
 +
To edit the <tt>config.json</tt> file, just open it in a text editor. Make sure the game isn't running when you edit it, or your changes might not take effect. See a [http://www.w3schools.com/js/js_json_syntax.asp basic guide to JSON]; basically make sure your values are surrounded by quotes (like <tt>"value"</tt>). You can use this [https://jsonformatter.curiousconcept.com/ JSON validator] to make sure the format is correct.
 +
 +
===Manage mods===
 +
* To update a mod, download the latest version and copy the new files into the existing folder. That should replace the older files, but keep any config or data files it generated for you.
 +
* To remove a mod, just remove it from the <tt>Mods</tt> folder.
  
 
[[zh:使用模组:安装SMAPI]]
 
[[zh:使用模组:安装SMAPI]]

Revision as of 01:59, 28 April 2018

Modding:Player Guide/header

Now that you know the basics of moddings, here's how to get started!

Getting started

Install SMAPI

First you'll need to install the mod loader, SMAPI. Click the right link for more info:

Find mods

Next you need to choose the mods you want. See the most popular mods or these recommendations for a first playthrough. You can also search for mods here:

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).
ModDrop Pretty new. Not many mods yet, but you can install those it has very quickly through their (Windows-only) client.
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? (SMAPI will automatically disable most incompatible SMAPI mods, but you're on your own with XNB mods. Try checking the mod description or comments.)
  • Don't download from stardewvalleymods.net. (Mods here are usually outdated, since the site republishes mods without permission for ad revenue.)

Find your game folder

Next you'll need to open your game folder (the one containing Stardew Valley's .exe file). Here's where to find it:

Platform Path
Windows GOG: C:\Program Files (x86)\GalaxyClient\Games\Stardew Valley
Steam: C:\Program Files (x86)\Steam\steamapps\common\Stardew Valley
Linux GOG: ~/GOG Games/Stardew Valley/game
Steam: ~/.local/share/Steam/steamapps/common/Stardew Valley
Mac GOG: /Applications/Stardew Valley.app/Contents/MacOS
Steam: ~/Library/Application Support/Steam/steamapps/common/Stardew Valley/Contents/MacOS

On Mac, the Content folder is stored separately:
GOG: /Applications/Stardew Valley.app/Resources/Content
Steam: ~/Library/Application Support/Steam/steamapps/common/Stardew Valley/Resources/Content

Not there? Here are some other ways to find it:

more options 
Option 2: find it through SMAPI
  1. Launch SMAPI.
  2. Enter this command in the SMAPI console (the second window that opens with the game):
    show_game_files
Option 3: find it through Steam
  1. Open the Steam client.
  2. Right-click on Stardew Valley.
  3. Click Properties.
  4. Click the Local Files tab.
  5. Click the Browse Local Files... button to open the game folder.
Option 4: find it through GOG Galaxy
  1. Open the GOG Galaxy client.
  2. In the game sidebar, right-click on Stardew Valley.
  3. Choose Manage Installation > Show Folder to open the game folder.

Install mods

To install a mod, just unzip it into the Mods folder in your game folder. Make sure each mod has its own subfolder. For example, if you have a PineapplesEverywhere mod, you should have a file structure like this:

Stardew Valley/
   Mods/
      PineapplesEverywhere/
         PineapplesEverywhere.dll
         manifest.json

Configure mods

Some mods have a config.json file in their mod folder. It might be created the first time you launch the game with that mod. This file lets you customise the mod settings.

To edit the config.json file, just open it in a text editor. Make sure the game isn't running when you edit it, or your changes might not take effect. See a basic guide to JSON; basically make sure your values are surrounded by quotes (like "value"). You can use this JSON validator to make sure the format is correct.

Manage mods

  • To update a mod, download the latest version and copy the new files into the existing folder. That should replace the older files, but keep any config or data files it generated for you.
  • To remove a mod, just remove it from the Mods folder.