« back to index

Player's guide to using mods » install SMAPI

Welcome to Stardew Valley modding! This guide will help you install mods and fix any problems that come up.
For players

SMAPI is the tool which launches the game with mods (which are downloaded separately). It’s safely installed alongside your normal game, and you can uninstall it anytime. To update SMAPI, just install the latest version.

Automatic install

On Windows

Part 1: install SMAPI

  1. Download the latest version of SMAPI.
  2. Extract the .zip file somewhere (but not in your game folder!).
  3. Double-click install.exe, and follow the on-screen instructions.
    The installer will detect your game and add SMAPI for you.

From now on, just run StardewModdingAPI.exe in your game folder to play with mods. To remove SMAPI later, just run install.exe again and choose uninstall.

Part 2: configure Steam

If you use Steam, you can launch SMAPI from the Steam client to enable the Steam overlay and achievements. This requires a few more steps.

  1. In the Steam client, right-click on Stardew Valley and choose Properties:

  2. Click General > Set Launch Options:

  3. In the textbox, enter this text exactly as shown:

    "\StardewModdingAPI.exe" %command%

  4. Open your game folder, select the full address, and press CTRL + C to copy it. (Your path is probably different; that’s fine.)

  5. In the textbox right before \, press CTRL + V to paste the address. The textbox should now look something like this:

  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.

On Linux

  1. Download the latest version of SMAPI.
  2. Extract the .zip file somewhere (but not in your game folder!).
  3. Open a terminal in the extracted folder and run mono install.exe.
    The installer will detect your game and add SMAPI for you. (If you get an error like ‘mono: command not found’, you need to install Mono.)

That’s it! Just launch the game to play with mods. To remove SMAPI later, run mono install.exe again and choose uninstall.

On Mac

  1. Download the latest version of SMAPI.
  2. Extract the .zip file somewhere (but not in your game folder!).
  3. Open a terminal in the extracted folder and run mono install.exe.
    Here’s how: (1) open the Terminal app; (2) type mono then a space; (3) drag & drop the install.exe file onto the Terminal window to paste its file path; (4) press enter on your keyboard.
    (If you get an error like ‘mono: command not found’, you need to install Mono first.)

That’s it! Just launch the game to play with mods. To remove SMAPI later, run mono install.exe again and choose uninstall.

Manual install

The installer is the recommended way to install SMAPI, but you can also install it manually.

  1. Download the latest version of SMAPI.
  2. Unzip the .zip file somewhere.
  3. Copy the files from the internal/Mono folder (if Linux/Mac) or internal/Windows folder (if Windows) into your game folder. If you did it properly, the StardewModdingAPI.exe file should be right next to the game’s executable.
  4. Make sure the game launches with SMAPI.
    • Scenario A: you play on Windows:
      See part 2 in the Windows instructions.
    • Scenario B: you play on Linux or Mac:
      1. Open the game folder.
      2. Rename the StardewValley file (with no extension) to StardewValley-original.
      3. Rename the StardewModdingAPI file (with no extension) to StardewValley.
next: Use mods →