Difference between revisions of "Modding:Installing SMAPI on Steam Deck"

From Stardew Valley Wiki
Jump to navigation Jump to search
(copy common content from Modding:Installing SMAPI on Linux (main content author: User:Pathoschild, with edits by LenneDalben))
 
(update for Steam Deck)
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. This guide also applies for the Steam Deck's distribution of Linux, SteamOS. See also:
+
This page explains how to install SMAPI (the tool which lets you use mods) on Steam Deck.
−
* [[Modding:Installing SMAPI on Android|Instructions for Android]]
+
 
−
* [[Modding:Installing SMAPI on Mac|Instructions for macOS]]
+
See instructions for: [[Modding:Installing SMAPI on Android|Android]] • [[Modding:Installing SMAPI on Linux|Linux]] • [[Modding:Installing SMAPI on Mac|macOS]] • [[Modding:Installing SMAPI on Windows|Windows]].
−
* [[Modding:Installing SMAPI on Windows|Instructions for Windows]]
 
  
 
__TOC__
 
__TOC__
  
 
==Install==
 
==Install==
−
<ol>
+
Before you install SMAPI, you need to know which version of the game you're running: ''native'' (Linux version) or ''Proton'' (Windows version). If you're not sure, see [https://www.youtube.com/watch?v=f1GvONkE9S0 this video tutorial].
−
<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>
+
===Stardew Valley in native mode===
−
<li>Run the <samp>install on Linux.sh</samp> file, and follow the on-screen instructions.<br />(If it 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>
+
# Download the [https://smapi.io/ latest version of SMAPI].
−
</ol>
+
# Extract the <samp>.zip</samp> file somewhere (but not in your game folder!).
 +
# Run the <samp>install on Linux.sh</samp> file, and follow the on-screen instructions.<br />(If it the installer asks for your game install path, see [[Modding:Player Guide/Getting Started#Find your game folder|how to find your game folder]].)
  
 
<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>
 +
 +
===Stardew Valley in Proton===
 +
'''TODO'''
  
 
==Update SMAPI==
 
==Update SMAPI==
Line 25: Line 28:
  
 
==Troubleshooting==
 
==Troubleshooting==
−
* If the SMAPI window no longer appears after a game update, reinstall SMAPI to fix the launcher.
+
===SMAPI window no longer appears after game update===
−
* 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).
+
# Run the SMAPI installer again to fix the launcher.
−
* See the [[Modding:Player Guide/Troubleshooting|troubleshooting page]] for general troubleshooting.
+
 
 +
===Can't launch game when SMAPI is installed===
 +
# Open a terminal in [[Modding:Player Guide/Getting Started#Find your game folder|your game folder]].
 +
# Run <code>./StardewModdingAPI</code> in the terminal to see what the error is:
 +
#* If you see "''The library 'libhostpolicy.so' required to execute the application was not found''", you have the Linux version of SMAPI with the Proton version of the game. See the [[#Install|instructions for Proton]] above.
 +
#* If you see a different error, check whether the [[Modding:Player Guide/Troubleshooting|troubleshooting page]] has a section for it. If not, see the 'get help' section there.
 +
 
 +
===Other issues===
 +
See the [[Modding:Player Guide/Troubleshooting|troubleshooting page]] for general troubleshooting.
  
 
{{Modding guide footer
 
{{Modding guide footer

Revision as of 18:05, 5 June 2022

Modding:Player Guide/header

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

See instructions for: Android • Linux • macOS • Windows.

Install

Before you install SMAPI, you need to know which version of the game you're running: native (Linux version) or Proton (Windows version). If you're not sure, see this video tutorial.

Stardew Valley in native mode

  1. Download the latest version of SMAPI.
  2. Extract the .zip file somewhere (but not in your game folder!).
  3. 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.)

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

Stardew Valley in Proton

TODO

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

SMAPI window no longer appears after game update

  1. Run the SMAPI installer again to fix the launcher.

Can't launch game when SMAPI is installed

  1. Open a terminal in your game folder.
  2. Run ./StardewModdingAPI in the terminal to see what the error is:
    • If you see "The library 'libhostpolicy.so' required to execute the application was not found", you have the Linux version of SMAPI with the Proton version of the game. See the instructions for Proton above.
    • If you see a different error, check whether the troubleshooting page has a section for it. If not, see the 'get help' section there.

Other issues

See the troubleshooting page for general troubleshooting.

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