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

From Stardew Valley Wiki
Jump to navigation Jump to search
(tweak install guide links)
(Remove the "Configure your Game Client" section, since you can now switch between windows in the Steam Deck's/SteamOS's Game Mode. Also added clarification to the beginning now that there are no Steam Deck-specific instructions.)
Line 1: Line 1:
 
{{Modding:Player Guide/header}}
 
{{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. This guide also applies for the Steam Deck's distribution of Linux, SteamOS. See also:
 
* [[Modding:Installing SMAPI on Android|Instructions for Android]]
 
* [[Modding:Installing SMAPI on Android|Instructions for Android]]
 
* [[Modding:Installing SMAPI on Mac|Instructions for macOS]]
 
* [[Modding:Installing SMAPI on Mac|Instructions for macOS]]
Line 26: Line 26:
  
 
<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>
−
 
−
==Configure your game client==
 
−
===Steam===
 
−
No changes are needed! Just launch the game through Steam like normal, and it'll launch with SMAPI.
 
−
 
−
===Steam Deck===
 
−
: ''See [https://www.youtube.com/watch?v=CrrWtqdbvC4 video tutorial].''
 
−
 
−
You'll also need to hide the SMAPI window to play on the Steam Deck console:
 
−
 
−
# [[Modding:Player Guide/Getting Started#Find your game folder|Open your game folder]].
 
−
# Open the <samp>StardewValley</samp> file (the one with no file extension) in a text editor like Atom.
 
−
# Change <code>SKIP_TERMINAL=false</code> to <code>SKIP_TERMINAL=true</code> and save.
 
−
 
−
Now you can launch the game like usual, and it'll play with mods.
 
−
 
−
'''Note:''' after doing this, you won't see mod update alerts or error messages unless you [https://log.smapi.io/ check the log], and your game won't launch after a crash until you delete the <samp>smapi-internal/StardewModdingAPI.crash.marker</samp> file. You should periodically check the log to make sure everything is working correctly.
 
  
 
==Update SMAPI==
 
==Update SMAPI==

Revision as of 15:18, 27 April 2022

Modding:Player Guide/header

This page explains how to install SMAPI (the tool which lets you use mods) on Linux. This guide also applies for the Steam Deck's distribution of Linux, SteamOS. See also:

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 it the installer asks for your game install path, see how to find your game folder.)
  5. Configure your game client: see the instructions for Steam and Steam Deck.

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=137167"