Changes

1,855 bytes added , 28 April

m

spelling correction

Line 1: Line 1: −

+

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

Line 14: Line 14:

==Getting started==

===Install SMAPI===

−

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

+

First you'll need to install the mod loader, SMAPI.

−

* [[Modding:Installing SMAPI on ~~Android~~|~~Instructions for Android~~]]

+

See the instructions for:

−

* [[Modding:Installing SMAPI on Linux|~~Instructions for~~ Linux]]

+

* [[Modding:Installing SMAPI on Windows|Windows]];

−

* [[Modding:Installing SMAPI on ~~Mac~~|~~Instructions for Mac~~]]

+

* [[Modding:Installing SMAPI on Mac|macOS]];

−

* [[Modding:Installing SMAPI on ~~Windows~~|~~Instructions for Windows~~]]

+

* [[Modding:Installing SMAPI on Linux|Linux]];

+

* [[Modding:Installing SMAPI on Steam Deck|Steam Deck]] (the handheld console);

+

* or [[Modding:Installing SMAPI on Android|Android]].

===Find mods===

Line 25: Line 27:

<ul>

−

<li>[~~http~~://www.nexusmods.com/stardewvalley/mods/topalltime/ most popular mods on Nexus];</li>

+

<li>[https://www.nexusmods.com/stardewvalley/mods/topalltime/ most popular mods on Nexus];</li>

<li>[https://gist.github.com/Pathoschild/b608892d3e60bd25d0eea71ca7584649 recommendations for a first playthrough];</li>

+

<li>[https://stardewmodding.wiki.gg/wiki/Category:Recommendations recommendations from other players];</li>

<li>search for mods here:

{| class="wikitable"

Line 33: Line 36:

! description

|-

−

| '''[~~http~~://nexusmods.com/stardewvalley/ Nexus Mods]'''

+

| '''[https://nexusmods.com/stardewvalley/ Nexus Mods]'''

| Most mods are released here. An account is required, but it's free; just don't choose a package when you register. You can use their [https://www.nexusmods.com/site/mods/1?tab=files Vortex client] (Windows only) to install/manage your mods, or download them manually.

|-

| [https://www.moddrop.com/stardew-valley/ ModDrop]

−

| Many mods are released here. You can use their ModDrop client (Windows only) to install/manage/auto-update your mods~~, or download mods directly from the website without registration needed~~.

+

| Many mods are released here. You can use their ModDrop client (Windows only) to install/manage/auto-update your mods.

−

|-

−

~~| [http://community.playstarbound.com/resources/categories/stardew-valley.22/ Chucklefish mods]~~

−

~~| Some older mods are released here, though most are also on Nexus or ModDrop.~~

|-

| [https://forums.stardewvalley.net/index.php?resources/ Official forums]

| Some mods are released here, though most are also on Nexus or ModDrop.

|-

−

| [~~http~~://community.playstarbound.com/forums/mods.215/ Chucklefish forums]

+

| [https://community.playstarbound.com/resources/categories/stardew-valley.22/ Chucklefish mods]

+

| Some older mods are released here, though most are also on Nexus or ModDrop.

+

|-

+

| [https://community.playstarbound.com/forums/mods.215/ Chucklefish forums]

| Some older mods are posted directly in the Chucklefish forums. Some hidden gems are only here, but finding them can be a challenge.

|}</li>

Line 53: Line 56:

===Find your game folder===

−

Next you'll need to open your game folder (the one containing Stardew Valley~~'s <code>.exe</code> file~~). Here's where to find it by default:

+

Next you'll need to open your game folder (the one containing {{executable name|Stardew Valley}} or {{executable name|StardewValley}}). Here's where to find it by default:

{| class="wikitable"

Line 61: Line 64:

|-

| Windows

−

| GOG: <code>C:\Program Files (x86)\GOG Galaxy\Games\Stardew Valley</code> or <code>C:\GOG Games\Stardew Valley</code> Steam: <code>C:\Program Files (x86)\Steam\steamapps\common\Stardew Valley</code>

+

| GOG: <code>C:\Program Files (x86)\GOG Galaxy\Games\Stardew Valley</code> or <code>C:\GOG Games\Stardew Valley</code> Steam: <code>C:\Program Files (x86)\Steam\steamapps\common\Stardew Valley</code> Xbox App：<code>C:\XboxGames\Stardew Valley</code>

|-

| Android

Line 71: Line 74:

| Mac

| GOG: <code>/Applications/Stardew Valley.app/Contents/MacOS</code> Steam: <code>~/Library/Application Support/Steam/SteamApps/common/Stardew Valley/Contents/MacOS</code>

+

See also a [[Modding:Installing SMAPI on Mac Pictorial Guide#Find and save your Mods folder|pictorial guide to finding the folder on macOS]].

|}

Line 94: Line 99:

:# In the game sidebar, right-click on ''Stardew Valley''.

:# Choose ''Manage Installation > Show Folder'' to open the game folder.

−

}}

−

~~====Finding and Saving Your Game~~ Folder ~~on a Mac====~~

+

; Option 5: finding it through Xbox Gamepass

+

:# Open the Xbox game client.

+

:# On the main page for the game, click the ''...'' button.

+

:# Select ''Open Mods Folder''

−

~~If you need help finding or saving your Mods folder on a Mac~~, ~~you can try this pictorial guide:~~ [[Modding:~~Installing_SMAPI_on_Mac_Pictorial_Guide~~#~~Finding_and_Saving_Your_Mods_Folder~~]]

+

For images, please see [[Modding:Installing_SMAPI_on_Windows#Xbox_app]]

+

}}

===Install mods===

To install a mod, just unzip it into the <code>Mods</code> folder in [[#Find your game folder|your game folder]]. Make sure each mod has its own subfolder, without trailing numbers. For example, if you have a <code>PineapplesEverywhere</code> mod, you should have a file structure like this:

<pre>

−

Stardew Valley/

+

📁 Stardew Valley/

−

Mods/

+

📁 Mods/

−

PineapplesEverywhere/

+

📁 PineapplesEverywhere/

−

PineapplesEverywhere.dll

+

🗎 PineapplesEverywhere.dll

−

manifest.json

+

🗎 manifest.json

</pre>

Tips:

<ul>

−

<li>If you have a lot of mods, you can optionally ~~organise~~ them into subfolders. SMAPI will automatically search inside each folder until it finds one with files.

+

<li>If you have a lot of mods, you can optionally organize them into subfolders. SMAPI will automatically search inside each folder until it finds one with files.

<pre>

−

Stardew Valley/

+

📁 Stardew Valley/

−

Mods/

+

📁 Mods/

−

Fruit mods/

+

📁 Fruit mods/

−

PineapplesEverywhere/

+

📁 PineapplesEverywhere/

−

PineapplesEverywhere.dll

+

🗎 PineapplesEverywhere.dll

−

manifest.json

+

🗎 manifest.json

−

ApplesNowhere/

+

📁 ApplesNowhere/

−

ApplesNowhere.dll

+

🗎 ApplesNowhere.dll

−

manifest.json

+

🗎 manifest.json

</pre></li>

<li>To disable a folder, just add a dot in front of the folder name (like <code>.disabled mods</code>). If Windows doesn't let you do that, put a dot at the end too and it'll let you (like <code>.disabled mods.</code>).</li>

Line 132: Line 141:

Some mods have a <code>config.json</code> file in their mod folder, which lets you customise the mod settings. The file is usually created the first time you launch the game with that mod installed.

−

To edit the <code>config.json</code> 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 <code>"value"</code>). You can use this [https://jsonformatter.curiousconcept.com/ JSON validator] to make sure the format is correct.

+

To edit the <code>config.json</code> 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 [https://www.w3schools.com/js/js_json_syntax.asp basic guide to JSON]; basically make sure your values are surrounded by quotes (like <code>"value"</code>). You can use this [https://jsonformatter.curiousconcept.com/ JSON validator] to make sure the format is correct.

===Update mods===

Line 168: Line 177:

| ✓ fully supported

|-

−

|rowspan="3"| console

+

|rowspan="5"| console

| Nintendo Switch

| ✖ no mod support

Line 174: Line 183:

| PS4

| ✖ no mod support

+

|-

+

| PS Vita

+

| ✖ no mod support

+

|-

+

| Steam Deck

+

| ✓ fully supported, but may increase power usage

|-

| XBox One

Line 187: Line 202:

Almost all mods will work on any supported platform, since SMAPI rewrites them for compatibility.

+

(For more technical info, see the [https://github.com/Pathoschild/SMAPI/issues/632 SMAPI tracking ticket].)

===Can mods corrupt my save?===

Line 207: Line 224:

|-

!style="text-align: left;"| type of mod

−

!style="text-align: left;"| ~~effects~~

+

!style="text-align: left;"| affects

!style="text-align: left;"| summary

|-

Line 256: Line 273:

===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 and (unofficially) Android, 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 is the mod loader for Stardew Valley. It works fine with GOG and Steam achievements, it's compatible with Linux/Mac/Windows and (unofficially) Android, you can uninstall it anytime, and there's a friendly community if you need help. SMAPI is required for most types of Stardew Valley mods.

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.

+

# Load mods into the game and provide APIs they can use. Many types of mods aren't possible without SMAPI.

# Rewrite mods for crossplatform compatibility, so you can use almost any mod on any platform.

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

Line 273: Line 290:

===Can I have different mod groups?===

Yep, SMAPI has built-in support for different mod groups. The instructions may seem complex, but it's easy once you get the hang of it:

+

For simplicity, you can also just rename the Mods folder to something else.

{| class="wikitable"

Line 282: Line 301:

|  

# Create a separate folder for each mod group in [[#Find your game folder|your game folder]], like <code>Mods</code> and <code>Mods (multiplayer)</code>.

−

# Create a shortcut to the ~~<samp>~~StardewModdingAPI~~.exe</samp>~~ file ~~(that <samp>.exe</samp> is inside~~ [[#Find your game folder|your game folder]]).

+

# Create a shortcut to the {{executable name|StardewModdingAPI}} file in [[#Find your game folder|your game folder]].

# Right-click the shortcut, choose <samp>Properties</samp>, and add this to the end of the <samp>Target</samp> field: <code> --mods-path "Mods (multiplayer)"</code> (changing folder name as needed). '''Don't delete any of the existing text in that field! This should be added to the end of what's already there.''' Done correctly, it should look something like <code>"your-path-here\SteamLibrary\steamapps\common\Stardew Valley\StardewModdingAPI.exe" --mods-path "Mods (multiplayer)"</code>.

# Double-click that shortcut to launch SMAPI with the specified mod folder.

Line 290: Line 309:

|  

# Create a separate folder for each mod group in [[#Find your game folder|your game folder]], like <code>Mods</code> and <code>Mods (multiplayer)</code>.

−

# Create a shortcut to your ~~<samp>~~steam~~.exe</samp>~~ file.

+

# Create a shortcut to your {{executable name|steam}} file.

# Right-click the shortcut, choose <samp>Properties</samp>, and add this to the end of the <samp>Target</samp> field: <code>-applaunch 413150 --mods-path "Mods (multiplayer)"</code> (changing folder name as needed). '''Don't delete any of the existing text in that field! This should be added to the end of what's already there.''' Done correctly, it should look something like <code>"your-path-here\Steam\steam.exe" -applaunch 413150 --mods-path "Mods (multiplayer)"</code>.

# Optionally you can click the <samp>"Change Icon..."</samp> button and browse to your Stardew Valley folder to change the icon of the shortcut from the Steam icon to the Stardew Valley Icon.

# Double-click that shortcut to make Steam launch SMAPI with the specified mod folder and all steam features.

+

|-

+

|-

+

| Windows (Steam, Non-Steam Game Method)

+

|  

+

# Create a separate folder for each mod group in [[#Find your game folder|your game folder]], like <code>Mods</code> and <code>Mods (multiplayer)</code>.

+

# Add SMAPI as a Non-Steam Game to your library a second time. Follow the second set of instructions in [[Modding:Installing SMAPI on Windows#Steam|installing SMAPI on Windows]] - it is highly suggested you alter the title in your Steam Library to differentiate between mod groups, such as "Stardew Valley Modded" and "Stardew Valley Modded Multiplayer".

+

# Right-click the new SMAPI entry in your Steam Library, select "Properties", and add this to the end of the Target field: <code> --mods-path "Mods (multiplayer)"</code>. '''Don't delete any of the existing text in that field! This should be added to the end of what's already there.''' Done correctly, it should look something like <code>"your-path-here\SteamLibrary\steamapps\common\Stardew Valley\StardewModdingAPI.exe" --mods-path "Mods (multiplayer)"</code>.

+

# Click the "Play" button in the new SMAPI entry in Steam to make Steam launch SMAPI with the specified mod folder and all Steam features.

|-

| Linux

Line 308: Line 335:

</ol>

|-

−

| Mac

+

| Mac (non-Steam)

| <ol>

−

<li>Create a separate folder for each mod group in [[#Find your game folder|your game folder]], like <code>Mods</code> and <code>Mods (multiplayer)</code>.</li>

+

<li>Create a separate folder for each mod group in [[#Find your game folder|your game folder]], like <code>Mods</code> and <code>Mods(multiplayer)</code> (no spaces).</li>

−

<li>Create a file <samp>SMAPI_multiplayer~~.command~~</samp> ~~on your desktop~~.</li>

+

<li>Create a text file on your desktop with the same name as the mod group, for example <samp>SMAPI_multiplayer</samp> and format as Plain Text.</li>

−

<li>~~Edit the file and set the text to this (change the~~ folder ~~name as needed, and replace <samp>/~~path~~/to/StardewValley/StardewModdingAPI.bin.osx</samp> with the full path to the <samp>StardewModdingAPI.bin.osx</samp> file in~~ [[#Find your game folder|your game folder]]):

+

<li>Input ~ followed by your folder path ([[#Find your game folder|your game folder]]). Add the following text to the end of the string:

−

+

<syntaxhighlight lang="bash"> --mods-path "Mods(multiplayer)"

−

~~/path/to/StardewValley/StardewModdingAPI.bin.osx~~ --mods-path "Mods (multiplayer)"

</syntaxhighlight></li>

−

<li>Example: <code>~/Library/Application\ Support/Steam/steamapps/common/Stardew\ Valley/Contents/MacOS/StardewModdingAPI~~.bin.osx~~ --mods-path "Mods (multiplayer)"</code></li>

+

<li>Example: <code>~/Library/Application\ Support/Steam/steamapps/common/Stardew\ Valley/Contents/MacOS/StardewModdingAPI --mods-path "Mods(multiplayer)"</code></li>

−

<li>~~Mark~~ the file executable (see [https://support.apple.com/en-ca/guide/terminal/apdd100908f-06b3-4e63-8a87-32e71241bab4/mac instructions for Linux or Mac]).</li>

+

<li>Save the file, then mark the file executable (see [https://support.apple.com/en-ca/guide/terminal/apdd100908f-06b3-4e63-8a87-32e71241bab4/mac instructions for Linux or Mac]).</li>

<li>If you get the error: "The file “SMAPI multiplayer.command” could not be executed because you do not have appropriate access privileges. To view or change access privileges, select the file in the Finder and choose File > Get Info." Then use the following code in the terminal: <samp>chmod u+x /path/to/SMAPI multiplayer.command</samp> to give yourself these access privileges.</li>

−

<li>Double-click the script to launch SMAPI with the specified mod folder.</li>

+

<li>Double-click the script on your desktop to launch SMAPI with the specified mod folder.</li>

</ol>

|-

Line 326: Line 352:

<li>Create a separate folder for each mod group in [[#Find your game folder|your game folder]], like <code>Mods</code> and <code>Mods(multiplayer)</code>. Note there shouldn't be a space between "Mods" and "(multiplayer)".</li>

<li>Create a file <samp>SMAPI_multiplayer.command</samp> on your desktop.</li>

−

<li>Edit the file and set the text to this (change the folder name as needed, and replace <samp>/path/to/steam_osx</samp> with the full path to the <samp>steam_osx</samp> file (you can find the path for <samp>steam_osx</samp> by using <samp>sudo find / -name steam_osx</samp>):

+

<li>Edit the file and set the text to this (change the folder name as needed, and replace <samp>/path/to/steam_osx</samp> with the full path to the <samp>steam_osx</samp> file (you can find the path for <samp>steam_osx</samp> by using <samp>find /Applications -name steam_osx</samp> or if that does not work use the longer search <samp>sudo find / -name steam_osx</samp>):

/path/to/steam_osx -applaunch 413150 --mods-path "Mods(multiplayer)"

Line 344: Line 370:

|next = [[../Troubleshooting|Troubleshooting]]

}}

+

[[Category:Modding]]

[[de:Modding:Spieleranleitung/Erste Schritte]]

−

[[es: Modding:Guía del jugador/Introducción]]

+

[[es:Modding:Guía del jugador/Introducción]]

−

[[ko:모드:~~플레이어 가이드~~/~~시작|모드 사용법~~]]

+

[[fr:Modding:Guide Joueur/Commencer]]

[[pt:Modificações:Guia do Jogador/Começando]]

[[ru:Модификации:Руководство по использованию модификаций/Введение]]

[[zh:模组:使用指南/入门]]

Rikai

5

edits

Changes

Modding:Player Guide/Getting Started (view source)

Revision as of 01:29, 28 April 2024