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

From Stardew Valley Wiki
Jump to navigation Jump to search
m
(→‎Install: change double-click to right-click + open (this allows bypassing some security restrictions for newly downloaded files))
 
(32 intermediate revisions by 10 users not shown)
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 MacOS. See also:
+
This page explains how to install SMAPI (the tool which lets you use mods) on macOS.
* [[Modding:Installing SMAPI on Linux|Instructions for Linux]]
+
 
* [[Modding:Installing SMAPI on Windows|Instructions for Windows]]
+
See instructions for: [[Modding:Installing SMAPI on Android|Android]] • [[Modding:Installing SMAPI on Linux|Linux]] • [[Modding:Installing SMAPI on Steam Deck|Steam Deck]] • [[Modding:Installing SMAPI on Windows|Windows]].
  
 
__TOC__
 
__TOC__
  
 
==Install==
 
==Install==
# Install [https://www.mono-project.com/download/stable/ Mono]. (The 'stable channel' version is fine. If this doesn't work, see [[Modding:Player Guide/Troubleshooting#Linux/Mac: "looks like Mono isn't installed"|Troubleshooting]].)
+
Quick note: As of version 4.0.0, SMAPI uses NET 6.0, which is supported on '''[https://github.com/dotnet/core/blob/main/release-notes/6.0/supported-os.md#macos Mac 10.15 (Catalina) or later]'''. These instructions will fail if you're on Mac 10.12 (Sierra), Mac 10.13 (High Sierra), or 10.14 (Mohave), in which case, see: [[Modding:Player Guide/Troubleshooting#SMAPI doesn't work with the compatibility branch]]
# Download the [https://smapi.io/ latest version of SMAPI].
+
 
# Open the <tt>.zip</tt> file you downloaded to extract its contents.
+
# Download the [https://smapi.io/ latest version of SMAPI] (see [[Modding:Installing SMAPI on Mac Pictorial Guide#Install SMAPI|a pictorial guide]]).
# Enable the installer script:
+
# Extract the <samp>.zip</samp> file somewhere (but not in your game folder!).
## Open [https://support.apple.com/kb/HT202635 Launchpad].
+
# Right-click <samp>install on Mac.command</samp> and choose ''open''.
## Type <tt>Terminal</tt> and select the Terminal app.
+
# Follow the on-screen instructions.¹
## Enter this command: <pre>mdfind -0 'kMDItemFSName = "install on Mac.command" && kMDItemContentType = "com.apple.terminal.shell-script"' | xargs -0 xattr -d com.apple.quarantine</pre>
 
# Double-click <code>install on Mac.command</code> and follow the on-screen instructions.
 
  
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).
  
<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==
Line 25: Line 23:
  
 
==Uninstall==
 
==Uninstall==
# Open the file <code>install on Mac.command</code>.
+
# Launch the installer again (see [[#Install|install steps]]).
# Choose to uninstall SMAPI.
+
# When prompted, choose the ''uninstall'' option.
  
==Special notes for macOS==
+
==Troubleshooting==
* You may need to reinstall Mono when updating macOS.
+
* If you are getting the <code>Operation not permitted: 'internal'</code> error, do the following steps:
* You may need to reinstall SMAPI when the game updates.
+
** Open System Preferences
 +
** Go to "Security and Privacy", then go to the "Privacy" tab.
 +
** Scroll down to "Full Disk Access".
 +
** Click the lock button to make changes, and then use the + button to add Terminal to the list of apps.
 +
** Try again to run <samp>install on MacOS.command</samp>.  
 +
* On Ventura:
 +
** Install [https://iterm2.com/ iTerm] and set it to be your default Terminal. This is not optimal if you like using Terminal, but otherwise seems like a perfectly workable solution.
 +
** OR Temporarily disable System Integrity Protection. This is not a great solution, because it leaves your computer vulnerable, and you should absolutely not leave your computer in this state.
 +
* See the [[Modding:Player Guide/Troubleshooting|troubleshooting page]] for general troubleshooting.
  
 
{{Modding guide footer
 
{{Modding guide footer
Line 38: Line 44:
  
 
[[de:Modding:SMAPI auf Mac]]
 
[[de:Modding:SMAPI auf Mac]]
 +
[[es:Modding:Instalar SMAPI en Mac]]
 +
[[zh:模组:在Mac上安装SMAPI]]

Latest revision as of 00:07, 19 April 2024

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

See instructions for: AndroidLinuxSteam DeckWindows.

Install

Quick note: As of version 4.0.0, SMAPI uses NET 6.0, which is supported on Mac 10.15 (Catalina) or later. These instructions will fail if you're on Mac 10.12 (Sierra), Mac 10.13 (High Sierra), or 10.14 (Mohave), in which case, see: Modding:Player Guide/Troubleshooting#SMAPI doesn't work with the compatibility branch

  1. Download the latest version of SMAPI (see a pictorial guide).
  2. Extract the .zip file somewhere (but not in your game folder!).
  3. Right-click install on Mac.command and choose open.
  4. Follow the on-screen instructions.¹

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 you are getting the Operation not permitted: 'internal' error, do the following steps:
    • Open System Preferences
    • Go to "Security and Privacy", then go to the "Privacy" tab.
    • Scroll down to "Full Disk Access".
    • Click the lock button to make changes, and then use the + button to add Terminal to the list of apps.
    • Try again to run install on MacOS.command.
  • On Ventura:
    • Install iTerm and set it to be your default Terminal. This is not optimal if you like using Terminal, but otherwise seems like a perfectly workable solution.
    • OR Temporarily disable System Integrity Protection. This is not a great solution, because it leaves your computer vulnerable, and you should absolutely not leave your computer in this state.
  • See the troubleshooting page for general troubleshooting.