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

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎Install: condense instructions & copyedit)
Line 9: Line 9:
  
 
==Install==
 
==Install==
−
<!--# Install [https://dotnet.microsoft.com/download/dotnet/5.0/runtime .NET 5].
+
<ol>
−
#* For Ubuntu: <code>sudo snap install dotnet-sdk --classic --channel=5.0</code>-->
+
<li>Download the [https://smapi.io/ latest version of SMAPI].</li>
−
# Download the [https://smapi.io/ latest version of SMAPI].
+
<li>Extract the <samp>.zip</samp> file somewhere (but not in your game folder!).</li>
−
# Extract the <samp>.zip</samp> file somewhere (but not in your game folder!).
+
<li>If you installed Steam through Flatpak, see these instructions:
−
# Run the <samp>install on Linux.sh</samp> file, and follow the on-screen instructions.<br />''The installer will detect your game and add SMAPI for you.''<br />Note: if you get the error <code>"Where is your game folder? Oops, couldn't find the game automatically. Type the file path to the game directory (the one containing 'Stardew Valley.exe'), then press enter."</code>, you can go to [[Modding:Player Guide/Getting Started#Find your game folder|this page]] to find your game folder.
+
{{collapse|instructions for Flatpak|content=When using Flatpak, you need to change the default game location:
 +
# 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 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>
 +
</ol>
  
 
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).
 
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).
−
 
−
''Special Instructions for Flatpak''<br />If you have the Flatpak version of Steam installed, you will need to change the default location of your game library to /Home/[USERNAME]/.local/share/Steam prior to Step 3 above.
 
−
# Open Steam.
 
−
# Go to Steam > Settings > Downloads.
 
−
# Click on "Steam Library Folders" under Content Libraries.
 
−
# Navigate to /home/[your username]/.local/share/Steam, then hit the "Select" button.
 
−
# Make sure the new location you just created is selected, then click the "..." and select "Make Default".<br /> Note: You may need to uninstall/reinstall Stardew Valley after making the above changes so the game and its folders end up in the new location prior to running the SMAPI installer.
 
  
 
<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>

Revision as of 20:21, 4 March 2022

Modding:Player Guide/header

This page explains how to install SMAPI (the tool which lets you use mods) on Linux. 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.)

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).

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.

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