Modding:Installing SMAPI on Mac: Difference between revisions
imported>Pathoschild m →Install from source: fix redundant command |
imported>Pathoschild update for new developer tools workaround, comment out previous workarounds (no longer needed if the new one works) |
||
| Line 8: | Line 8: | ||
==Install== | ==Install== | ||
===Minimum requirements=== | |||
* 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]]. | |||
===Enable macOS security permissions=== | |||
# 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]]). | |||
# Restart your computer. | |||
===Install SMAPI=== | |||
# Download the [https://smapi.io/ latest version of SMAPI] (see [[Modding:Installing SMAPI on Mac Pictorial Guide#Install SMAPI|a pictorial guide]]). | # 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!). | # Extract the <samp>.zip</samp> file somewhere (but not in your game folder!). | ||
# Right-click <samp>install on Mac.command</samp> and choose ''open'' | # Right-click <samp>install on Mac.command</samp> and choose ''open''. | ||
# Follow the on-screen instructions.¹ | # 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 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> | <small>¹To install manually instead, see instructions in the installer's readme.</small> | ||
| Line 27: | Line 38: | ||
==Troubleshooting== | ==Troubleshooting== | ||
<!-- | |||
===Warning message: "'install on macOS.command' Not Opened"=== | ===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. | 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. | ||
| Line 61: | Line 73: | ||
(This only 'signs' SMAPI so it can be played, it does not disable security or antivirus checks.) | (This only 'signs' SMAPI so it can be played, it does not disable security or antivirus checks.) | ||
--> | |||
===Error message: "Operation not permitted: 'internal'"=== | ===Error message: "Operation not permitted: 'internal'"=== | ||
To fix that error: | To fix that error: | ||
| Line 70: | Line 82: | ||
# Use the <code>+</code> button to add Terminal to the list of apps. | # Use the <code>+</code> button to add Terminal to the list of apps. | ||
#* Try again to run <samp>install on MacOS.command</samp>. | #* Try again to run <samp>install on MacOS.command</samp>. | ||
===Other issues=== | |||
* See the [[Modding:Player Guide/Troubleshooting|troubleshooting page]] for general troubleshooting. | |||
<!-- | |||
===Can't launch installer on Ventura=== | ===Can't launch installer on Ventura=== | ||
| Line 75: | Line 91: | ||
* Install [https://iterm2.com/ iTerm] and set it to be your default Terminal. | * Install [https://iterm2.com/ iTerm] and set it to be your default Terminal. | ||
* ''Or'' temporarily disable System Integrity Protection. This isn't a great solution because it leaves your computer vulnerable, and you absolutely shouldn't leave your computer in this state. | * ''Or'' temporarily disable System Integrity Protection. This isn't a great solution because it leaves your computer vulnerable, and you absolutely shouldn't leave your computer in this state. | ||
==Install from source== | ==Install from source== | ||
| Line 115: | Line 123: | ||
<li>When it finishes, the last line will say "''Done! Package created in ...''". You can unzip and run the installer in that folder to install SMAPI.</li> | <li>When it finishes, the last line will say "''Done! Package created in ...''". You can unzip and run the installer in that folder to install SMAPI.</li> | ||
</ul> | </ul> | ||
--> | |||
{{Modding guide footer | |||
|prev = [[Modding:Player Guide/Getting Started|Getting Started]] | |||
|next = | |||
}} | |||
[[Category:Modding]] | [[Category:Modding]] | ||
Revision as of 17:05, 16 December 2024
Player's guide to using mods 
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
- Newer versions of the game use NET 6.0, which is supported on 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 it doesn't work with the compatibility branch.
Enable macOS security permissions
- Go to System Settings > Privacy and Security.
- 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
- Click Developer Tools.
- Add Terminal to the list, and enable it (see screenshot).
- Restart your computer.
Install SMAPI
- Download the latest version of SMAPI (see a pictorial guide).
- Extract the .zip file somewhere (but not in your game folder!).
- Right-click install on Mac.command and choose open.
- 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
- Launch the installer again (see install steps).
- When prompted, choose the uninstall option.
Troubleshooting
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
+button to add Terminal to the list of apps.- Try again to run install on MacOS.command.
Other issues
- See the troubleshooting page for general troubleshooting.