Difference between revisions of "Modding:Installing SMAPI on Windows"

From Stardew Valley Wiki
Jump to navigation Jump to search
(copy from canimod.com with permission, dual-licensed CC BY-NC-SA for compatibility with wiki. Only author is Pathoschild.)
 
(format & reorganise content for wiki)
Line 1: Line 1:
 
←[[Modding:Index|Index]]
 
←[[Modding:Index|Index]]
  
−
<pre>
+
This page explains how to install SMAPI (the tool which lets you use mods) on Windows. See also:
−
---
+
* [[Modding:Player FAQs|Player FAQs]]
−
layout: default
+
* [[Modding:Installing SMAPI on Linux|Instructions for Linux]]
−
title: Player's guide to using mods » install SMAPI
+
* [[Modding:Installing SMAPI on Mac|Instructions for Mac]]
−
intro: >
 
−
  Welcome to Stardew Valley modding! This guide will help you install mods and
 
−
  fix any problems that come up.
 
−
permalink: /for-players/install-smapi
 
−
redirect_from:
 
−
    - /guides/using-mods
 
−
---
 
  
−
<div class="scroll-box" style="float: right;">
+
==Install SMAPI==
−
    <strong>For players</strong>
+
===Using the installer===
−
    <ul>
+
; Part 1&#58; install SMAPI
−
        <li><a href="/for-players/intro">Intro</a></li>
 
−
        <li><strong>Install SMAPI</strong></li>
 
−
        <li><a href="/for-players/use-mods">Use mods</a></li>
 
−
        <li><a href="/for-players/faqs">Troubleshooting & FAQs</a></li>
 
−
    </ul>
 
−
</div>
 
  
−
SMAPI is the tool which launches the game with mods (which are [downloaded separately](#using-mods)).
+
:# Run the game without SMAPI at least once so it can do first-time setup.
−
It's safely installed alongside your normal game, and you can uninstall it anytime.
+
:# Download the [https://github.com/Pathoschild/SMAPI/releases latest version of SMAPI].
 +
:# Extract the <tt>.zip</tt> file somewhere (but not in your game folder!).
 +
:# Double-click <tt>install.exe</tt>, and follow the on-screen instructions.<br />''The installer will detect your game and add SMAPI for you.''
 +
:# If you use Steam, continue to the next section. Otherwise just run <tt>StardewModdingAPI.exe</tt> in [[Modding:Player FAQs#Game folder|your game folder]] to play with mods.
  
−
## Install SMAPI
+
; Part 2&#58; configure Steam
−
### On Windows
 
−
#### Part 1: install SMAPI
 
−
1. Run the game without SMAPI at least once so it can do first-time setup if needed.
 
−
2. Download the [latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases).
 
−
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._
 
  
−
**If you have Steam, continue to the next section.** Otherwise just run `StardewModdingAPI.exe`
+
: You can use SMAPI through the Steam client to enable the overlay and achievements. This requires a few more steps.
−
in [your game folder](http://canimod.com/for-players/faqs#game-folder) to play with mods.
+
:# Open [[Modding:Player FAQs#Game folder|your game folder]], select the full address, and press <tt>CTRL</tt> + <tt>C</tt> to copy it:<br />[[File:Modding - installing SMAPI on Windows - Steam 3.png]]
 +
:# In the Steam client, right-click on ''Stardew Valley'' and choose ''Properties'':<br />[[File:Modding - installing SMAPI on Windows - Steam 1.png]]
 +
:# Click ''General > Set Launch Options'':<br />[[File:Modding - installing SMAPI on Windows - Steam 2.png]]
 +
:# In the textbox...
 +
:## Type a single quote (<tt>"</tt>).
 +
:## Press <tt>CTRL</tt> + <tt>V</tt> to paste the path you copied in step 1.
 +
:## Then type this after the path: <pre>\StardewModdingAPI.exe" %command%</pre>
 +
:## It should look something like this (with your game path filled in):<br />[[File:Modding - installing SMAPI on Windows - Steam 4.png]]
 +
:# Click OK to save your changes.
 +
:# From now on, just launch the game through Steam to run SMAPI with the Steam overlay and achievements.
  
−
#### Part 2: configure Steam
+
===Manually===
−
If you use Steam, you can launch SMAPI from the Steam client to enable the Steam overlay and
+
The installer is the best way to install SMAPI, but you can also install it manually.
−
achievements. This requires a few more steps.
 
  
−
1. In the Steam client, right-click on _Stardew Valley_ and choose _Properties_:
+
# Download the [https://github.com/Pathoschild/SMAPI/releases latest version of SMAPI].
 +
# Unzip the <tt>.zip</tt> file somewhere.
 +
# Copy the files from the <tt>internal/Windows</tt> folder into [http://canimod.com/for-players/faqs#game-folder your game folder]. If you did it properly, the `StardewModdingAPI.exe` file should be right next to the game's executable.
 +
# If you use Steam, continue to the next section. Otherwise just run <tt>StardewModdingAPI.exe</tt> in [[Modding:Player FAQs#Game folder|your game folder]] to play with mods.
  
−
  > ![](images/install-smapi/steam-right-click.png)
+
==Update SMAPI==
 +
To update SMAPI, just install the new version. The installer will automatically clean up previous versions. (You don't need to configure Steam again.)
  
−
2. Click _General > Set Launch Options_:
+
==Uninstall SMAPI==
−
 
+
To remove SMAPI...
−
  > ![](images/install-smapi/steam-launch-options.png)
+
* Using the installer: run <tt>install.exe<tt> again and choose ''uninstall''.
−
 
+
* Manually: reverse the [[#Manually|manual install steps]].
−
3. In the textbox, enter this text exactly as shown:
 
−
 
 
−
  ```"\StardewModdingAPI.exe" %command%```
 
−
 
 
−
4. Open [your game folder](http://canimod.com/for-players/faqs#game-folder), select the full
 
−
  address, and press `CTRL` + `C` to copy it. (Your path is probably different; that's fine.)
 
−
 
 
−
  > ![](images/install-smapi/steam-copy-path.png)
 
−
 
 
−
5. In the textbox right before `\`, press `CTRL` + `V` to paste the address. The textbox should now
 
−
  look something like this:
 
−
 
 
−
  > ![](images/install-smapi/steam-launch-options-filled.png)
 
−
 
 
−
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
 
−
[...]
 
−
 
 
−
### On Mac
 
−
[...]
 
−
 
 
−
### 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](https://github.com/Pathoschild/SMAPI/releases).
 
−
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](http://canimod.com/for-players/faqs#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](#on-windows).
 
−
  * **Scenario B: you play on Linux or Mac:** 
 
−
    [...]
 
−
 
 
−
## Update SMAPI
 
−
To update SMAPI, just install the new version. The installer will automatically clean up previous
 
−
versions. (If you use Steam, you don't need to set the launch options again.)
 
−
 
 
−
## Uninstall SMAPI
 
−
To remove SMAPI, just run `install.exe` again and choose _uninstall_. If you need to uninstall
 
−
manually, just do the opposite of _[manual install](#manual-install)_.
 
−
 
 
−
<div class="scroll-box" style="display: inline-block;">
 
−
<big><strong>next:</strong> <a href="/for-players/use-mods">Use mods →</a></big>
 
−
</div>
 
−
</pre>
 
  
 
[[Category:Modding]]
 
[[Category:Modding]]

Revision as of 00:28, 20 June 2017

←Index

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

Install SMAPI

Using the installer

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

Manually

The installer is the best 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/Windows folder into your game folder. If you did it properly, the `StardewModdingAPI.exe` file should be right next to the game's executable.
  4. If you use Steam, continue to the next section. Otherwise just run StardewModdingAPI.exe in your game folder to play with mods.

Update SMAPI

To update SMAPI, just install the new version. The installer will automatically clean up previous versions. (You don't need to configure Steam again.)

Uninstall SMAPI

To remove SMAPI...

  • Using the installer: run install.exe again and choose uninstall.
  • Manually: reverse the manual install steps.
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Installing_SMAPI_on_Windows&oldid=57037"