Modding:Installing SMAPI on Windows

From Stardew Valley Wiki
Jump to: navigation, search

Index

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

Install

Part 1: install SMAPI
  1. Run the game without SMAPI at least once so it can do first-time setup.
  2. Download the latest version of SMAPI.
  3. Extract the .zip file somewhere (but not in your game folder!).
  4. Double-click install.exe¹, and follow the on-screen instructions.
    The installer will detect your game and add SMAPI for you.
  5. If you use Steam, continue to the next section. Otherwise just run StardewModdingAPI.exe in your game folder to play with mods.
Part 2: configure Steam
You can use SMAPI through the Steam client to enable the overlay and achievements. This requires a few more steps.
  1. Open your game folder, select the full address, and press CTRL + C to copy it:
    Modding - installing SMAPI on Windows - Steam 3.png
  2. In the Steam client, right-click on Stardew Valley and choose Properties:
    Modding - installing SMAPI on Windows - Steam 1.png
  3. Click General > Set Launch Options:
    Modding - installing SMAPI on Windows - Steam 2.png
  4. In the textbox...
    1. Type a single quote (").
    2. Press CTRL + V to paste the path you copied in step 1.
    3. Then type this after the path:
      \StardewModdingAPI.exe" %command%
    4. It should look something like this (with your game path filled in):
      Modding - installing SMAPI on Windows - Steam 4.png
  5. Click OK to save your changes.
  6. From now on, just launch the game through Steam to run SMAPI with the Steam overlay and achievements.

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

Update

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

Uninstall

  1. Run install.exe and choose uninstall.
  2. Blank the Steam launch options (if you changed them).

(If you want to play without mods temporarily, you can just launch Stardew Valley.exe directly instead.)