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

From Stardew Valley Wiki
Jump to navigation Jump to search
(Updating as per Discord user Maximo#3952)
(copyedit new changes, match other OS pages where possible, add 'special notes for macOS' section)
Line 8: Line 8:
  
 
==Install==
 
==Install==
# Install the "stable channel" version of [https://www.mono-project.com/download/stable/ Mono]. (If this doesn't work, see [[Modding:Player Guide/Troubleshooting#Linux/Mac: "looks like Mono isn't installed"|Troubleshooting]].)
+
# 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]].)
# Download [https://smapi.io/ SMAPI].
+
# Download the [https://smapi.io/ latest version of SMAPI].
# Open the Zip file you downloaded in the previous step to extract its contents.
+
# Open the <tt>.zip</tt> file you downloaded to extract its contents.
# Open Terminal, and then enter the following command:<br/><br/><kbd>mdfind -0 'kMDItemFSName = "install on Mac.command" && kMDItemContentType = "com.apple.terminal.shell-script"' | xargs -0 xattr -d com.apple.quarantine</kbd>
+
# Open Terminal, and 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>''This is needed because [https://support.apple.com/kb/HT202491 Gatekeeper] prevents you from opening unsigned script files you download by default. To open Terminal: open [https://support.apple.com/kb/HT202635 Launchpad], type <tt>Terminal</tt>, and then press <tt>return</tt>.''
# In Finder, open the file <code>install on Mac.command</code>, and then follow the on-screen instructions.
+
# In Finder, open the file <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).
 
'''Note''':
 
 
* Step 4 is necessary because, by default, [https://support.apple.com/kb/HT202491 Gatekeeper] will prevent you from opening unsigned script files downloaded via the Internet.
 
* To open Terminal, open [https://support.apple.com/kb/HT202635 Launchpad], type <kbd>Terminal</kbd>, and then press <kbd><kbd>return</kbd></kbd>.
 
* You must reinstall Mono whenever you update macOS.
 
  
 
<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>
Line 30: Line 24:
 
# Open the file <code>install on Mac.command</code>.
 
# Open the file <code>install on Mac.command</code>.
 
# Choose to uninstall SMAPI.
 
# Choose to uninstall SMAPI.
 +
 +
==Special notes for macOS==
 +
* You may need to reinstall Mono when updating macOS.
 +
* You may need to reinstall SMAPI when the game updates.
  
 
{{Modding guide footer
 
{{Modding guide footer

Revision as of 16:42, 31 October 2018

Modding:Player Guide/header

This page explains how to install SMAPI (the tool which lets you use mods) on MacOS. See also:

Install

  1. Install Mono. (The 'stable channel' version is fine. If this doesn't work, see Troubleshooting.)
  2. Download the latest version of SMAPI.
  3. Open the .zip file you downloaded to extract its contents.
  4. Open Terminal, and enter this command:
    mdfind -0 'kMDItemFSName = "install on Mac.command" && kMDItemContentType = "com.apple.terminal.shell-script"' | xargs -0 xattr -d com.apple.quarantine
    This is needed because Gatekeeper prevents you from opening unsigned script files you download by default. To open Terminal: open Launchpad, type Terminal, and then press return.
  5. In Finder, open the file install on Mac.command, 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).

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. Open the file install on Mac.command.
  2. Choose to uninstall SMAPI.

Special notes for macOS

  • You may need to reinstall Mono when updating macOS.
  • You may need to reinstall SMAPI when the game updates.