Modding:Installing SMAPI on Windows

←Index

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

• Player FAQs
• Instructions for Linux
• Instructions for Mac

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. In the Steam client, right click on Stardew Valley and choose Properties:
   
2. Click Set Launch Options:
   File:Modding - Installing SMAPI on Windows.png
3. In the text box, type the following:

   StardewModdingAPI %command%

4. Click OK to save your changes.
5. 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

Run install.exe and choose uninstall.