Difference between revisions of "Modding:Installing SMAPI on Windows"
Jump to navigation
Jump to search
Pathoschild (talk | contribs) (copy from canimod.com with permission, dual-licensed CC BY-NC-SA for compatibility with wiki. Only author is Pathoschild.) |
Pathoschild (talk | contribs) (format & reorganise content for wiki) |
||
Line 1: | Line 1: | ||
←[[Modding:Index|Index]] | ←[[Modding:Index|Index]] | ||
− | + | This page explains how to install SMAPI (the tool which lets you use mods) on Windows. See also: | |
− | + | * [[Modding:Player FAQs|Player FAQs]] | |
− | + | * [[Modding:Installing SMAPI on Linux|Instructions for Linux]] | |
− | + | * [[Modding:Installing SMAPI on Mac|Instructions for Mac]] | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | ==Install SMAPI== | |
− | + | ===Using the installer=== | |
− | + | ; Part 1: install SMAPI | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | SMAPI | + | :# Run the game without SMAPI at least once so it can do first-time setup. |
− | + | :# 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. | ||
− | + | ; Part 2: configure Steam | |
− | |||
− | |||
− | |||
− | 2 | ||
− | |||
− | |||
− | |||
− | + | : You can use SMAPI through the Steam client to enable the overlay and achievements. This requires a few more steps. | |
− | + | :# 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. | ||
− | + | ===Manually=== | |
− | + | The installer is the best way to install SMAPI, but you can also install it manually. | |
− | |||
− | + | # 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. | ||
− | + | ==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 <tt>install.exe<tt> again and choose ''uninstall''. | |
− | + | * Manually: reverse the [[#Manually|manual install steps]]. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
[[Category:Modding]] | [[Category:Modding]] |
Revision as of 00:28, 20 June 2017
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
- Run the game without SMAPI at least once so it can do first-time setup.
- Download the latest version of SMAPI.
- Extract the .zip file somewhere (but not in your game folder!).
- Double-click install.exe, and follow the on-screen instructions.
The installer will detect your game and add SMAPI for you. - 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.
- Open your game folder, select the full address, and press CTRL + C to copy it:
File:Modding - installing SMAPI on Windows - Steam 3.png - In the Steam client, right-click on Stardew Valley and choose Properties:
- Click General > Set Launch Options:
- In the textbox...
- Type a single quote (").
- Press CTRL + V to paste the path you copied in step 1.
- Then type this after the path:
\StardewModdingAPI.exe" %command%
- It should look something like this (with your game path filled in):
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.
- Open your game folder, select the full address, and press CTRL + C to copy it:
Manually
The installer is the best way to install SMAPI, but you can also install it manually.
- Download the latest version of SMAPI.
- Unzip the .zip file somewhere.
- 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.
- 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.