Jump to content

Modding:Installing SMAPI on Mac: Difference between revisions

From Stardew Valley Wiki
imported>Pathoschild
copy from canimod.com with permission, dual-licensed CC BY-NC-SA for compatibility with wiki. Main author is Pathoschild, with contributions from Kriana.
 
imported>Atravita
 
(75 intermediate revisions by 15 users not shown)
Line 1: Line 1:
←[[Modding:Index|Index]]
{{modding player guide header}}


<pre>
This page explains how to install SMAPI (the tool which lets you use mods) on macOS.
---
layout: default
title: Player's guide to using mods » install SMAPI
intro: >
  Welcome to Stardew Valley modding! This guide will help you install mods and
  fix any problems that come up.
permalink: /for-players/install-smapi
redirect_from:
    - /guides/using-mods
---


<div class="scroll-box" style="float: right;">
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]].
    <strong>For players</strong>
    <ul>
        <li><a href="/for-players/intro">Intro</a></li>
        <li><strong>Install SMAPI</strong></li>
        <li><a href="/for-players/use-mods">Use mods</a></li>
        <li><a href="/for-players/faqs">Troubleshooting & FAQs</a></li>
    </ul>
</div>


SMAPI is the tool which launches the game with mods (which are [downloaded separately](#using-mods)).
__TOC__
It's safely installed alongside your normal game, and you can uninstall it anytime.


## Install SMAPI
==Install==
### On Windows
===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]].


### On Linux
===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.''


### On Mac
# Go to ''System Settings > Privacy and Security''.
1. Download the [latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases).
# 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>
2. Extract the `.zip` file somewhere (but not in your game folder!).
# Click ''Developer Tools''.
3. Open a terminal in the extracted folder and run `mono install.exe`.
# 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.''
  _Here's how: (1) open the Terminal app; (2) type `mono` then a space; (3) drag & drop the
# Restart your computer.
  `install.exe` file onto the Terminal window to paste its file path; (4) press enter on your
  keyboard._ 
  _(If you get an error like 'mono: command not found', you need to install
  [Mono](http://www.mono-project.com/) first.)_


That's it! Just launch the game to play with mods. To remove SMAPI later, run `mono install.exe`
''Still doesn't work? Try force closing steam before installing SMAPI.''
again and choose _uninstall_.


### Manual install
===Install SMAPI===
The installer is the recommended way to install SMAPI, but you can also install it manually.
# 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.¹


1. Download the [latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases).
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.
2. Unzip the `.zip` file somewhere.
3. Copy the files from the `internal/Mono` folder (if Linux/Mac) or `internal/Windows` folder (if
  Windows) into [your game folder](http://canimod.com/for-players/faqs#game-folder). If you did it
  properly, the `StardewModdingAPI.exe` file should be right next to the game's executable.
4. Make sure the game launches with SMAPI.
  * **Scenario A: you play on Windows:** 
    [...]
  * **Scenario B: you play on Linux or Mac:** 
    1. Open the game folder.
    2. Rename the `StardewValley` file (with no extension) to `StardewValley-original`.
    3. Rename the `StardewModdingAPI` file (with no extension) to `StardewValley`.


## Update SMAPI
'''You don't need to change your Steam launch options''' (that's only needed on Windows).
To update SMAPI, just install the new version. The installer will automatically clean up previous
versions. (If you use Steam, you don't need to set the launch options again.)


## Uninstall SMAPI
<small>¹To install manually instead, see instructions in the installer's readme.</small>
To remove SMAPI, just run `install.exe` again and choose _uninstall_. If you need to uninstall
manually, just do the opposite of _[manual install](#manual-install)_.


<div class="scroll-box" style="display: inline-block;">
==Update==
<big><strong>next:</strong> <a href="/for-players/use-mods">Use mods →</a></big>
Just install the new version; the installer will automatically clean up previous versions.
</div>
 
</pre>
==Uninstall==
# Launch the installer again (see [[#Install|install steps]]).
# 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.
# 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
  |prev = [[Modding:Player Guide/Getting Started|Getting Started]]
  |next =
}}


[[Category:Modding]]
[[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