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

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎Install: tweak)
 
(39 intermediate revisions by 16 users not shown)
Line 1: Line 1:
−
←[[Modding:Index|Index]]
+
{{modding player guide header}}
  
−
This page explains how to install SMAPI (the tool which lets you use mods) on Linux. See also:
+
This page explains how to install SMAPI (the tool which lets you use mods) on Linux.
−
* [[Modding:Player FAQs|Player FAQs]]
+
 
−
* [[Modding:Installing SMAPI on Mac|Instructions for Mac]]
+
See instructions for: [[Modding:Installing SMAPI on Android|Android]] • [[Modding:Installing SMAPI on Mac|macOS]] • [[Modding:Installing SMAPI on Steam Deck|Steam Deck]] • [[Modding:Installing SMAPI on Windows|Windows]].
−
* [[Modding:Installing SMAPI on Windows|Instructions for Windows]]
 
  
 
__TOC__
 
__TOC__
  
 
==Install==
 
==Install==
−
# Install [http://www.mono-project.com/ Mono].
+
<ol>
−
# Download the [https://smapi.io/ latest version of SMAPI].
+
<li>Download the [https://smapi.io/ latest version of SMAPI].</li>
−
# Extract the <tt>.zip</tt> file somewhere (but not in your game folder!).
+
<li>Extract the <samp>.zip</samp> file somewhere (but not in your game folder!).</li>
−
# Run the <tt>install on Linux.sh</tt> file, and follow the on-screen instructions.<br />''The installer will detect your game and add SMAPI for you.''
+
<li>If you installed Steam through Flatpak, see these instructions:
−
 
+
{{collapse|instructions for Flatpak|content=When using Flatpak, you need to change the default game location:
−
That's it! Just launch the game to play with mods. '''You don't need to change your Steam launch options''' (that's only needed on Windows).
+
# Open Steam.
 +
# Go to ''Steam > Settings > Downloads''.
 +
# Click ''Steam Library Folders'' under ''Content Libraries''.
 +
# Navigate to <samp>/home/[your username]/.local/share/Steam</samp>, and click ''Select''.
 +
# Make sure the new location you just created is selected, then click "''...''" and select ''Make Default''.
 +
# You may need to uninstall & reinstall the game to move it to the correct folder.
 +
}}</li>
 +
<li>Run the <samp>install on Linux.sh</samp> file, and follow the on-screen instructions.<br />(If the installer asks for your game install path, see [[Modding:Player Guide/Getting Started#Find your game folder|how to find your game folder]].)</li>
 +
</ol>
  
 
<small>To install manually instead, see instructions in the installer's readme.</small>
 
<small>To install manually instead, see instructions in the installer's readme.</small>
  
−
==Update==
+
==Update SMAPI==
 
Just install the new version; the installer will automatically clean up previous versions.
 
Just install the new version; the installer will automatically clean up previous versions.
  
 
==Uninstall==
 
==Uninstall==
−
Run <tt>mono install.exe</tt> and choose ''uninstall''.
+
# Launch the installer again (see [[#Install|install steps]]).
 +
# When prompted, choose the ''uninstall'' option.
 +
 
 +
==Troubleshooting==
 +
* If the SMAPI window no longer appears after a game update, reinstall SMAPI to fix the launcher.
 +
* SMAPI tries to find a compatible terminal or use your default terminal, but some terminals aren't compatible. If the installer or launcher don't launch a terminal, try installing xterm (doesn't need to be your default terminal).
 +
* See the [[Modding:Player Guide/Troubleshooting|troubleshooting page]] for general troubleshooting.
 +
 
 +
* If you're trying to install SMAPI for Stardew 1.5.6, be forewarned you need to install libssl1.x. See below for instructions:
 +
 
 +
{| class="wikitable"
 +
|-
 +
! distros
 +
! prerequisites
 +
|-
 +
| Debian-based<br /><small>(Debian, Ubuntu, Linux Mint)</small>
 +
| Install LibSSL 1.1 by running <code>sudo apt install libssl1.1</code> in a terminal.
 +
|-
 +
| Arch-based<br /><small>(Arch, Manjaro, EndeavourOS)</small>
 +
| Install OpenSSL 1.1 by running <code>sudo pacman -S openssl-1.1</code> in a terminal.
 +
|-
 +
| NixOS
 +
| Use [https://search.nixos.org/packages?channel=unstable&show=steam-run&type=packages steam-run] to run <samp>install on Linux.sh</samp> in the steps below.<br /><small>(Make sure your system has steam-run installed, or create a temporary nix-shell with steam-run by executing <code>export NIXPKGS_ALLOW_UNFREE=1 && nix-shell -p steam-run</code>. Then run <code>steam-run ./install\ on\ Linux.sh</code> in a terminal to start the installation.)</small>
 +
|-
 +
| Fedora
 +
| Install OpenSSL 1.1 by running <code>sudo dnf install openssl1.1</code> in a terminal.
 +
|-
 +
| Gentoo
 +
| Install OpenSSL 1.1 compatibility by running <code>sudo emerge --ask dev-libs/openssl-compat</code> in a terminal.
 +
|-
 +
| RHEL 8-based <br /><small>(RHEL 8, CentOS 8, Rocky 8, Alma 8)</small>
 +
| Install OpenSSL 1.1 by running <code>sudo dnf install openssl</code> in a terminal.
 +
|}
 +
 
 +
{{Modding guide footer
 +
  |prev = [[Modding:Player Guide/Getting Started|Getting Started]]
 +
  |next =
 +
}}
  
−
[[Category:Modding]]
+
[[de:Modding:SMAPI auf Linux]]
 +
[[es:Modding:Instalar SMAPI en Linux]]
 +
[[fr:Modding:Installer SMAPI sur Linux]]
 +
[[zh:模组:在Linux上安装SMAPI]]

Latest revision as of 01:47, 18 April 2024

← Modding:Index
Player's guide to using mods SMAPI mascot.png

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

See instructions for: Android • macOS • Steam Deck • Windows.

Install

  1. Download the latest version of SMAPI.
  2. Extract the .zip file somewhere (but not in your game folder!).
  3. If you installed Steam through Flatpak, see these instructions:
    instructions for Flatpak 
    When using Flatpak, you need to change the default game location:
    1. Open Steam.
    2. Go to Steam > Settings > Downloads.
    3. Click Steam Library Folders under Content Libraries.
    4. Navigate to /home/[your username]/.local/share/Steam, and click Select.
    5. Make sure the new location you just created is selected, then click "..." and select Make Default.
    6. You may need to uninstall & reinstall the game to move it to the correct folder.
  4. Run the install on Linux.sh file, and follow the on-screen instructions.
    (If the installer asks for your game install path, see how to find your game folder.)

To install manually instead, see instructions in the installer's readme.

Update SMAPI

Just install the new version; the installer will automatically clean up previous versions.

Uninstall

  1. Launch the installer again (see install steps).
  2. When prompted, choose the uninstall option.

Troubleshooting

  • If the SMAPI window no longer appears after a game update, reinstall SMAPI to fix the launcher.
  • SMAPI tries to find a compatible terminal or use your default terminal, but some terminals aren't compatible. If the installer or launcher don't launch a terminal, try installing xterm (doesn't need to be your default terminal).
  • See the troubleshooting page for general troubleshooting.
  • If you're trying to install SMAPI for Stardew 1.5.6, be forewarned you need to install libssl1.x. See below for instructions:
distros prerequisites
Debian-based
(Debian, Ubuntu, Linux Mint) 		Install LibSSL 1.1 by running sudo apt install libssl1.1 in a terminal.
Arch-based
(Arch, Manjaro, EndeavourOS) 		Install OpenSSL 1.1 by running sudo pacman -S openssl-1.1 in a terminal.
NixOS Use steam-run to run install on Linux.sh in the steps below.
(Make sure your system has steam-run installed, or create a temporary nix-shell with steam-run by executing export NIXPKGS_ALLOW_UNFREE=1 && nix-shell -p steam-run. Then run steam-run ./install\ on\ Linux.sh in a terminal to start the installation.)
Fedora Install OpenSSL 1.1 by running sudo dnf install openssl1.1 in a terminal.
Gentoo Install OpenSSL 1.1 compatibility by running sudo emerge --ask dev-libs/openssl-compat in a terminal.
RHEL 8-based
(RHEL 8, CentOS 8, Rocky 8, Alma 8) 		Install OpenSSL 1.1 by running sudo dnf install openssl in a terminal.
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Installing_SMAPI_on_Linux&oldid=167808"