Jump to content

Modding:Installing SMAPI on Mac: Difference between revisions

From Stardew Valley Wiki
imported>Pathoschild
copyedit new changes, match other OS pages where possible, add 'special notes for macOS' section
imported>Atravita
 
(61 intermediate revisions by 13 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]].)
===Minimum requirements===
# Download the [https://smapi.io/ latest version of SMAPI].
* Newer versions of the game use NET 6.0, which is supported on '''[https://github.com/dotnet/core/blob/main/release-notes/6.0/supported-os.md#macos macOS 10.15 Catalina or later]'''. Unfortunately there's no way to use SMAPI on older versions of macOS (including Sierra, High Sierra, or Mohave) since [[Modding:Player Guide/Troubleshooting#SMAPI doesn't work with the compatibility branch|it doesn't work with the compatibility branch]].
# Open the <tt>.zip</tt> file you downloaded to extract its contents.
 
# 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>.''
===Enable macOS security permissions===
# In Finder, open the file <code>install on Mac.command</code>, and follow the on-screen instructions.
''If you get the SMAPI is Malware warning, you will need to restart your computer before attempting to install it again.''
 
# Go to ''System Settings > Privacy and Security''.
# Make sure ''Developer Tools'' is visible ([[:File:Fix macOS security permissions 1.png|see screenshot]]). If you don't see it, open Terminal through Spotlight and enter this command: <syntaxhighlight lang="sh">spctl developer-mode enable-terminal</syntaxhighlight>
# Click ''Developer Tools''.
# Add Terminal to the list, and enable it ([[:File:Fix macOS security permissions 2.png|see screenshot]]).<br />''If you use a custom terminal like iTerm, add that terminal to the list too. If you use the Stardrop mod manager, add that to the list too.''
# Restart your computer.
 
''Still doesn't work? Try force closing steam before installing SMAPI.''


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).
===Install SMAPI===
# Download the [https://smapi.io/ latest version of SMAPI] (see [[Modding:Installing SMAPI on Mac Pictorial Guide#Install SMAPI|a pictorial guide]]).
# Extract the <samp>.zip</samp> file somewhere (but not in your game folder!).
# Right-click <samp>install on Mac.command</samp> and choose ''open''.
# Follow the on-screen instructions.¹


<small>To install manually instead, see instructions in the installer's readme.</small>
That's it! Just launch the game to play with mods. If you play on Steam, make sure to launch the game through the Steam client to avoid issues.
 
'''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>


==Update==
==Update==
Line 22: Line 38:


==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.
===Warning message: "'install on macOS.command' Not Opened"===
* You may need to reinstall SMAPI when the game updates.
This message means that macOS blocked the installation because it cannot verify if SMAPI is safe. To bypass, you will need to manually approve in System Settings.
# Click on the "Done" button in the warning message.
# Open System Settings
# Navigate to "Privacy & Security" — scroll down until you find the "Security" section. You should have a notice that "'install on macOS.command' was blocked to protect your Mac." Click on the "Open Anyway" button.
# Another warning will pop up with the same statement. Click on the "Open Anyway" option, and you will be prompted to enter your password.
# Enter password and the installer should start running.
 
See also [[Modding:Installing SMAPI on Mac Pictorial Guide#Install SMAPI|pictorial guide]].
 
===Error message: "Operation not permitted: 'internal'"===
To fix that error:
# Open System Preferences.
# Go to "Security and Privacy" and then the "Privacy" tab.
# Scroll down to "Full Disk Access".
# Click the lock button to make changes.
# Use the <code>+</code> button to add Terminal to the list of apps.
#* Try again to run <samp>install on MacOS.command</samp>.
 
===Other issues===
* See the [[Modding:Player Guide/Troubleshooting|troubleshooting page]] for general troubleshooting.


{{Modding guide footer
{{Modding guide footer
Line 33: Line 68:
   |next =  
   |next =  
}}
}}
[[Category:Modding]]
[[de:Modding:SMAPI auf Mac]]
[[es:Modding:Instalar SMAPI en Mac]]
[[tr:Modlama:Mac'te SMAPI İndirme]]
[[zh:模组:在Mac上安装SMAPI]]

Latest revision as of 02:22, 18 February 2025

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

See instructions for: Android • Linux • Steam Deck • Windows.

Install

Minimum requirements

Enable macOS security permissions

If you get the SMAPI is Malware warning, you will need to restart your computer before attempting to install it again.

  1. Go to System Settings > Privacy and Security.
  2. Make sure Developer Tools is visible (see screenshot). If you don't see it, open Terminal through Spotlight and enter this command:
    spctl developer-mode enable-terminal
    
  3. Click Developer Tools.
  4. Add Terminal to the list, and enable it (see screenshot).
    If you use a custom terminal like iTerm, add that terminal to the list too. If you use the Stardrop mod manager, add that to the list too.
  5. Restart your computer.

Still doesn't work? Try force closing steam before installing SMAPI.

Install SMAPI

  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. If you play on Steam, make sure to launch the game through the Steam client to avoid issues.

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

Warning message: "'install on macOS.command' Not Opened"

This message means that macOS blocked the installation because it cannot verify if SMAPI is safe. To bypass, you will need to manually approve in System Settings.

  1. Click on the "Done" button in the warning message.
  2. Open System Settings
  3. Navigate to "Privacy & Security" — scroll down until you find the "Security" section. You should have a notice that "'install on macOS.command' was blocked to protect your Mac." Click on the "Open Anyway" button.
  4. Another warning will pop up with the same statement. Click on the "Open Anyway" option, and you will be prompted to enter your password.
  5. Enter password and the installer should start running.

See also pictorial guide.

Error message: "Operation not permitted: 'internal'"

To fix that error:

  1. Open System Preferences.
  2. Go to "Security and Privacy" and then the "Privacy" tab.
  3. Scroll down to "Full Disk Access".
  4. Click the lock button to make changes.
  5. Use the + button to add Terminal to the list of apps.
    • Try again to run install on MacOS.command.

Other issues