Modding:Installing SMAPI on Windows

From Stardew Valley Wiki
Jump to: navigation, search
Player's guide to using mods SMAPI mascot.png


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

Install

Option A: use SMAPI's installer

See also unofficial video guide.
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 on Windows.bat¹, 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. 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 quotes and the %command% part.)
  3. In the Steam client, right-click on Stardew Valley and choose Properties:
    Modding - installing SMAPI on Windows - Steam 1.png
  4. Click General > Set 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. Click OK to save your changes.
  7. 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.

Option B: use ModDrop

ModDrop is a mod manager which supports SMAPI and Stardew Valley mods. It can install SMAPI and keep it updated for you.

  1. Install ModDrop and open the client.
  2. In the top-right corner, click Install SMAPI or Update Available.
  3. A window should appear that says something like "A new version of SMAPI is available." Click the Install button and follow the on-screen instructions.

Update

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, click Update Available in the top-right if it appears and follow the on-screen instructions.

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