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

From Stardew Valley Wiki
Jump to navigation Jump to search
(copy from canimod.com with permission, dual-licensed CC BY-NC-SA for compatibility with wiki. Main author is Pathoschild, with contributions from Kriana.)
 
(→‎Install: change double-click to right-click + open (this allows bypassing some security restrictions for newly downloaded files))
 
(49 intermediate revisions by 13 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
+
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]]
−
[...]
 
  
−
### On Linux
+
# 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.¹
  
−
### On Mac
+
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).
−
1. Download the [latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases).
 
−
2. Extract the `.zip` file somewhere (but not in your game folder!).
 
−
3. Open a terminal in the extracted folder and run `mono install.exe`. 
 
−
  _Here's how: (1) open the Terminal app; (2) type `mono` then a space; (3) drag & drop the
 
−
  `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`
+
<small>¹To install manually instead, see instructions in the installer's readme.</small>
−
again and choose _uninstall_.
 
  
−
### Manual install
+
==Update==
−
The installer is the recommended way to install SMAPI, but you can also install it manually.
+
Just install the new version; the installer will automatically clean up previous versions.
  
−
1. Download the [latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases).
+
==Uninstall==
−
2. Unzip the `.zip` file somewhere.
+
# Launch the installer again (see [[#Install|install steps]]).
−
3. Copy the files from the `internal/Mono` folder (if Linux/Mac) or `internal/Windows` folder (if
+
# When prompted, choose the ''uninstall'' option.
−
  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
+
==Troubleshooting==
−
To update SMAPI, just install the new version. The installer will automatically clean up previous
+
* If you are getting the <code>Operation not permitted: 'internal'</code> error, do the following steps:
−
versions. (If you use Steam, you don't need to set the launch options again.)
+
** 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.
  
−
## Uninstall SMAPI
+
{{Modding guide footer
−
To remove SMAPI, just run `install.exe` again and choose _uninstall_. If you need to uninstall
+
  |prev = [[Modding:Player Guide/Getting Started|Getting Started]]
−
manually, just do the opposite of _[manual install](#manual-install)_.
+
  |next =
 +
}}
  
−
<div class="scroll-box" style="display: inline-block;">
+
[[de:Modding:SMAPI auf Mac]]
−
<big><strong>next:</strong> <a href="/for-players/use-mods">Use mods →</a></big>
+
[[es:Modding:Instalar SMAPI en Mac]]
−
</div>
+
[[zh:模组:在Mac上安装SMAPI]]
−
</pre>
 
−
 
 
−
[[Category:Modding]]
 

Latest revision as of 00:07, 19 April 2024

← Modding:Index
Player's guide to using mods SMAPI mascot.png

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

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.
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Installing_SMAPI_on_Mac&oldid=167989"