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

From Stardew Valley Wiki
Jump to navigation Jump to search
(push edit blocked by new user external links filter)
(→‎Install: merge per-distro instructions into the main steps for readability)
Line 9: Line 9:
 
==Install==
 
==Install==
 
<ol>
 
<ol>
−
<li>See the [[#Distribution Specific Instructions|Distribution Specific Instructions]] for your Distribution.</li>
+
<li>Apply distro-specific prerequisites if needed:
 +
 
 +
{| 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>
 +
|}
 +
</li>
 
<li>Download the [https://smapi.io/ latest version of SMAPI].</li>
 
<li>Download the [https://smapi.io/ latest version of SMAPI].</li>
 
<li>Extract the <samp>.zip</samp> file somewhere (but not in your game folder!).</li>
 
<li>Extract the <samp>.zip</samp> file somewhere (but not in your game folder!).</li>
Line 25: Line 41:
  
 
<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>
−
 
−
===Distribution Specific Instructions===
 
−
Many Linux distributions may need additional steps to work, such as installing an older version of OpenSSL.
 
−
 
−
====Debian-Based (Ubuntu, Linux Mint, Debian)====
 
−
On Ubuntu, Debian, Linux Mint, and other Debian-based installations, install <code>libssl1.1</code>.
 
−
Run <code>sudo apt install libssl1.1</code> in a terminal.
 
−
 
−
====Arch-Based (Arch Linux, Manjaro Linux, EndeavourOS)====
 
−
On Arch Linux and its derivatives, install <code>openssl-1.1</code> by running <code>sudo pacman -S openssl-1.1</code>.
 
−
 
−
====NixOS====
 
−
On [https://nixos.org NixOS] you need to use [https://search.nixos.org/packages?channel=unstable&show=steam-run&type=packages steam-run] to execute the Installer Script.
 
−
* 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>.
 
−
* Run <code>steam-run ./install\ on\ Linux.sh</code> in a terminal to start the installation.
 
  
 
==Update SMAPI==
 
==Update SMAPI==

Revision as of 17:20, 21 July 2023

← 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. Apply distro-specific prerequisites if needed:
    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.)
  2. Download the latest version of SMAPI.
  3. Extract the .zip file somewhere (but not in your game folder!).
  4. 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.
  5. 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.
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Installing_SMAPI_on_Linux&oldid=149349"