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

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, move manual install steps to readme)
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 Linux. See also:
−
---
+
* [[Modding:Player FAQs|Player FAQs]]
−
layout: default
+
* [[Modding:Installing SMAPI on Mac|Instructions for Mac]]
−
title: Player's guide to using mods » install SMAPI
+
* [[Modding:Installing SMAPI on Windows|Instructions for Windows]]
−
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;">
+
__TOC__
−
    <strong>For players</strong>
 
−
    <ul>
 
−
        <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)).
+
==Install==
−
It's safely installed alongside your normal game, and you can uninstall it anytime.
+
# Install [http://www.mono-project.com/ Mono].
 +
# 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!).
 +
# Open a terminal in the extracted folder.
 +
# Run <tt>mono install.exe</tt><br />''The installer will detect your game and add SMAPI for you.
  
−
## Install SMAPI
+
That's it! Just launch the game to play with mods. To remove SMAPI later, run <tt>mono install.exe</tt> again and choose ''uninstall''.
−
### On Windows
 
−
[...]
 
  
−
### On Linux
+
<small>To install manually instead, see instructions in the installer's readme.</small>
−
1. Download the [latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases).
 
−
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](http://www.mono-project.com/).)_
 
  
−
That's it! Just launch the game to play with mods. To remove SMAPI later, run `mono install.exe`
+
==Update==
−
again and choose _uninstall_.
+
Just install the new version; the installer will automatically clean up previous versions. (You don't need to configure Steam again.)
  
−
### On Mac
+
==Uninstall==
−
[...]
+
Run <tt>install.exe</tt> 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](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:** 
 
−
    [...]
 
−
  * **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`.
 
−
 
 
−
## 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:55, 20 June 2017

←Index

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

Install

  1. Install Mono.
  2. Download the latest version of SMAPI.
  3. Extract the .zip file somewhere (but not in your game folder!).
  4. Open a terminal in the extracted folder.
  5. Run mono install.exe
    The installer will detect your game and add SMAPI for you.

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

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.

Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Installing_SMAPI_on_Linux&oldid=57041"