Changes

__TOC__

__TOC__

==Install==

==Install SMAPI==

===Option A: use SMAPI's installer===

===Option A: use SMAPI's installer===

:# Run the game without SMAPI at least once (so it can do first-time setup).

:# Run the game without SMAPI at least once (so it can do first-time setup).

:# Extract the <samp>.zip</samp> file somewhere '''(but not in your game folder, any subfolder of your game folder, or in a folder with parentheses in the path!)''' (Your downloads folder is a fine choice).

:# Extract the <samp>.zip</samp> file somewhere '''(but not in your game folder, any subfolder of your game folder, or in a folder with parentheses in the path!)''' (Your downloads folder is a fine choice).

:# Double-click <samp>install on Windows.bat</samp>¹, and follow the on-screen instructions.

:# Double-click <samp>install on Windows.bat</samp>¹, and follow the on-screen instructions.

:# See [[#Launch SMAPI through Steam or GOG Galaxy|Launch SMAPI through Steam or GOG Galaxy]] for the final steps.

:# See [[#Configure your game client|Configure your game client]] for the final steps.

<small>¹ To install manually instead, see instructions in the installer's readme.</small>

<small>¹ To install manually instead, see instructions in the installer's readme.</small>

:# Click the notification bell in the upper-right hand corner, which will prompt you to download and install SMAPI.

:# Click the notification bell in the upper-right hand corner, which will prompt you to download and install SMAPI.

:# After SMAPI is installed in Vortex, click ''enable'' and you're done!

:# After SMAPI is installed in Vortex, click ''enable'' and you're done!

:# See [[#Launch SMAPI through Steam or GOG Galaxy|Launch SMAPI through Steam or GOG Galaxy]] for the final steps.

:# See [[#Configure your game client|Configure your game client]] for the final steps.

-->

-->

==Update SMAPI==

===Option A: use SMAPI's installer===

==Configure your game client==

Just install the new version; the installer will automatically clean up previous versions. (You don't need to configure Steam again.)

===Steam===

 

You need to launch SMAPI through Steam if you want the Steam overlay, achievements, and playtime tracking to work. (If you don't care about achievements or tracking game time, you can just launch <samp>StardewModdingAPI.exe</samp> in [[Modding:Player Guide/Getting Started#Find your game folder|your game folder]] to play with mods.)

# Click ''Update Available'' in the top-right if it appears.

 

If you use the [https://www.nexusmods.com/about/vortex/ Vortex mod manager]:

 

# Run [[#Install|run the installer]] again, but choose ''uninstall'' to remove SMAPI.

# If you [[#Launch SMAPI through Steam or GOG Galaxy|configured Steam or GOG Galaxy]] to launch SMAPI, undo your changes:

#* '''Steam:''' in the Steam client: right-click on ''Stardew Valley'', choose ''Properties > General > Set Launch Options'', and blank the launch options textbox.

#* '''GOG Galaxy:''' in the GOG Galaxy client: click on Stardew Valley, click the settings icon next to the 'Play' button, click ''Manage installation > Configure'', and clear the ''Custom executables / arguments'' checkbox.

 

(If you want to play without mods temporarily, you can just launch <samp>Stardew Valley.exe</samp> directly or rename your <samp>Mods</samp> folder instead.)

 

 

If you don't care about achievements or tracking game time, you can just launch <samp>StardewModdingAPI.exe</samp> in [[Modding:Player Guide/Getting Started#Find your game folder|your game folder]] to play with mods.

Here's how to configure it:

You can launch SMAPI through the Steam client to enable the overlay and achievements.

# Keep SMAPI's installer window open.<br /><small>(If you already closed it, just run it again. No need to uninstall first.)</small>

# Keep SMAPI's installer window open.<br /><small>(If you already closed it, just run it again. No need to uninstall first.)</small>

===GOG Galaxy===

===GOG Galaxy===

You can use SMAPI through the GOG Galaxy client to track your play time. The steps below tell GOG Galaxy to launch a batch script, which in turn launches StardewModdingAPI.exe. This is because telling GOG Galaxy to launch StardewModdingAPI.exe directly causes the SMAPI console to be invisible, which can hide important errors and warning messages.

You need to launch SMAPI through GOG Galaxy if you want its playtime tracking to work. (If you don't care about tracking game time, you can just launch <samp>StardewModdingAPI.exe</samp> in [[Modding:Player Guide/Getting Started#Find your game folder|your game folder]] to play with mods.)

 

Here's how to configure it:

# Open Notepad and paste in the following: <code>start "" "C:\Program Files (x86)\GOG Galaxy\Games\Stardew Valley\StardewModdingAPI.exe"</code> If Stardew Valley and SMAPI are not installed at <code>C:\Program Files (x86)\GOG Galaxy\Games\Stardew Valley\</code>, (the default location for most people), replace that location with the location of where you installed Stardew Valley.

# Open Notepad and paste in the following: <code>start "" "C:\Program Files (x86)\GOG Galaxy\Games\Stardew Valley\StardewModdingAPI.exe"</code> If Stardew Valley and SMAPI are not installed at <code>C:\Program Files (x86)\GOG Galaxy\Games\Stardew Valley\</code>, (the default location for most people), replace that location with the location of where you installed Stardew Valley.

# Finally, click the circle next to 'Default Executable' underneath File 2, then click OK. <br />[[File:Gog_galaxy_select_default_executable.png|400px]]

# Finally, click the circle next to 'Default Executable' underneath File 2, then click OK. <br />[[File:Gog_galaxy_select_default_executable.png|400px]]

# From now on, you can launch Stardew Valley through GOG Galaxy and both the SMAPI console and game will load as expected!

# From now on, you can launch Stardew Valley through GOG Galaxy and both the SMAPI console and game will load as expected!

==Troubleshooting==

==Troubleshooting==