Difference between revisions of "Modding:Installing SMAPI on Windows"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎Install: hide ModDrop/Vortex instructions until they're updated)
(rework "Launch SMAPI through Steam or GOG Galaxy" into a more general "Configure your game client", so we can add GamePass soon (and possibly future sections like WeGame))
Line 8: Line 8:
 
__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).
Line 15: Line 15:
 
:# 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>
Line 40: Line 40:
 
:# 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==
+
<span id="Launch_SMAPI_through_Steam_or_GOG_Galaxy"></span>
−
===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.)
−
===Option B: use ModDrop===
 
−
If you use the [https://www.moddrop.com ModDrop mod manager]:
 
−
# Click ''Update Available'' in the top-right if it appears.
 
−
# Follow the on-screen instructions.
 
−
 
 
−
===Option C: use Vortex===
 
−
If you use the [https://www.nexusmods.com/about/vortex/ Vortex mod manager]:
 
−
# Go to {{nexus mod|2400|SMAPI's mod page}} and download it using the ''Mod Manager Download'' button.
 
−
# Click ''Open Vortex'' when the popup appears.
 
−
# Click the Vortex window, and the notification bell will appear with a notification in the upper right. Click ''install'' and then ''enable''.
 
−
 
 
−
==Uninstall==
 
−
# 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.)
 
−
 
 
−
==Launch SMAPI through Steam or GOG Galaxy==
 
−
If you use Steam or GOG Galaxy, and want them to track your achievements and game time, you can configure them to launch SMAPI.
 
−
 
 
−
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.
 
  
−
===Steam===
+
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>
Line 83: Line 59:
  
 
===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.
Line 95: Line 73:
 
# 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!
 +
 +
==Update SMAPI==
 +
===Option A: use SMAPI's installer===
 +
Just install the new version; the installer will automatically clean up previous versions. (You don't need to configure Steam again.)
 +
 +
===Option B: use ModDrop===
 +
If you use the [https://www.moddrop.com ModDrop mod manager]:
 +
# Click ''Update Available'' in the top-right if it appears.
 +
# Follow the on-screen instructions.
 +
 +
===Option C: use Vortex===
 +
If you use the [https://www.nexusmods.com/about/vortex/ Vortex mod manager]:
 +
# Go to {{nexus mod|2400|SMAPI's mod page}} and download it using the ''Mod Manager Download'' button.
 +
# Click ''Open Vortex'' when the popup appears.
 +
# Click the Vortex window, and the notification bell will appear with a notification in the upper right. Click ''install'' and then ''enable''.
 +
 +
==Uninstall==
 +
# Run [[#Install|run the installer]] again, but choose ''uninstall'' to remove SMAPI.
 +
# If you [[#Configure your game client|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.)
  
 
==Troubleshooting==
 
==Troubleshooting==

Revision as of 16:40, 3 December 2021

Modding:Player Guide/header

This page explains how to install SMAPI (the tool which lets you use mods) on Windows. See also:

Install SMAPI

Option A: use SMAPI's installer

  1. Run the game without SMAPI at least once (so it can do first-time setup).
  2. Install .NET 5 (desktop x64):
    File:Modding - .NET 5 download on Windows.png
    The specific version required.
  3. Download the latest version of SMAPI.
  4. Extract the .zip 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).
  5. Double-click install on Windows.bat¹, and follow the on-screen instructions.
  6. See Configure your game client for the final steps.

¹ To install manually instead, see instructions in the installer's readme.

Option B: use ModDrop

ModDrop isn't updated for Stardew Valley 1.5.5 yet.

Option C: use Vortex

Vortex isn't updated for Stardew Valley 1.5.5 yet.

Configure your game client

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 StardewModdingAPI.exe in your game folder to play with mods.)

Here's how to configure it:

  1. Keep SMAPI's installer window open.
    (If you already closed it, just run it again. No need to uninstall first.)
  2. Copy the text in the installer window that looks like this (see how to copy text):
    Modding - installing SMAPI on Windows - installer Steam text.png
    Make sure you copy the entire line, including both quotation marks " and the %command% part.
    Your final path should look something like this: "Your path here" %command%
  3. In the Steam client, right-click on Stardew Valley and choose Properties:
    Modding - installing SMAPI on Windows - Steam 1.png
  4. Click the textbox under Launch Options:
    Modding - installing SMAPI on Windows - Steam 2.png
  5. Replace anything in the textbox with the text you copied from the installer.
    To paste text, click in the box and press CTRL and V.
  6. This text should consist of "Your SMAPI API Filepath" %command%
    Default for most users is "C:\Program Files (x86)\Steam\steamapps\common\Stardew Valley\StardewModdingAPI.exe" %command%
  7. From now on, just launch the game through Steam to run SMAPI with the Steam overlay and achievements.

GOG Galaxy

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 StardewModdingAPI.exe in your game folder to play with mods.)

Here's how to configure it:

  1. Open Notepad and paste in the following: start "" "C:\Program Files (x86)\GOG Galaxy\Games\Stardew Valley\StardewModdingAPI.exe" If Stardew Valley and SMAPI are not installed at C:\Program Files (x86)\GOG Galaxy\Games\Stardew Valley\, (the default location for most people), replace that location with the location of where you installed Stardew Valley.
  2. Click on File, then Save As...
    Save batch script.png
  3. Navigate to your Stardew Valley installation folder and change the file type from Text Documents to All Files as shown below and then click Save.
    Choose batch extension.png
  4. Then type start.bat for the file name as shown below
    Name batch script.png
  5. In the GOG Galaxy client, click on Stardew Valle' and then the settings icon on the right-hand side of the 'Play' button, then hover over 'Manage installation' and click 'Configure...' as shown below.
    Gog galaxy configure.png
  6. A new menu will appear. Check the "Custom executables / arguments" box.
    Gog galaxy custom launch.png
  7. Then click 'Add another executable / arguments'
    Gog galaxy add exectuable.png
  8. Select start.bat in the window that appears and then click Open.
    Select batch file.png
  9. Finally, click the circle next to 'Default Executable' underneath File 2, then click OK.
    Gog galaxy select default executable.png
  10. From now on, you can launch Stardew Valley through GOG Galaxy and both the SMAPI console and game will load as expected!

Update SMAPI

Option A: use SMAPI's installer

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

Option B: use ModDrop

If you use the ModDrop mod manager:

  1. Click Update Available in the top-right if it appears.
  2. Follow the on-screen instructions.

Option C: use Vortex

If you use the Vortex mod manager:

  1. Go to SMAPI's mod page and download it using the Mod Manager Download button.
  2. Click Open Vortex when the popup appears.
  3. Click the Vortex window, and the notification bell will appear with a notification in the upper right. Click install and then enable.

Uninstall

  1. Run run the installer again, but choose uninstall to remove SMAPI.
  2. If you 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 Stardew Valley.exe directly or rename your Mods folder instead.)

Troubleshooting

"Oops, couldn't find the game automatically"

If the installer shows that message, you can help it find the game folder. To do that:

  1. Exit the installer.
  2. Find your game folder.
  3. Move the installer folder into the game folder. (Make sure you move the whole folder, not just the files inside it!)
  4. Run the installer again and it should auto-detect the game folder now.

You can safely delete the installer folder when it's done.

Issues with SMAPI or mods

See the troubleshooting page for help with issues after installation.

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