Modding:Installing SMAPI on Windows

From Stardew Valley Wiki
Revision as of 22:22, 5 July 2018 by Pathoschild (talk | contribs) (→‎Install: update)
Jump to navigation Jump to search

Modding:Player Guide/header

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¹ (or install on Windows.exe in SMAPI 2.6), 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 this text (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.

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

Modding:Player Guide/footer