Jump to content

Modding:Installing SMAPI on Mac Pictorial Guide: Difference between revisions

From Stardew Valley Wiki
imported>SKTor
Added pictoral instructions for manual launch of SMAPI on M1 Macs.
imported>Rogue.toast
 
(20 intermediate revisions by 3 users not shown)
Line 5: Line 5:
From the instructions page: Download the [https://smapi.io/ latest version of SMAPI].
From the instructions page: Download the [https://smapi.io/ latest version of SMAPI].


To start with, you need to pick which option for downloading. The direct download is faster and easier, but you will eventually need to figure out Nexus anyways, so either option is a good option. Please be sure to check which version of SMAPI you need! This screenshot was taken in October 2021 and the latest version number may have changed since then, or you may want a specific version for other purposes.
{| class="wikitable"
|-
! Visual !! Instructions
|-
|
<span style="font-size:180%;">'''STEP 1'''</span>


[[File:8 SMAPI website.png|500px]]
[[File:8 SMAPI website.png|700px]]
|| To start, pick an option for downloading -- any of these listed will work. Please be sure to check which version of SMAPI you need! SMAPI 4.0.0 or later will only work on SDV 1.6. If you are still playing SDV 1.5.6 you will need a previous version of SMAPI, which you can get from [https://github.com/Pathoschild/SMAPI/releases the GitHub Releases page.]


Once you have the zip file downloaded, it may need to be unzipped or it may automatically unzip, depending on your OS version and your settings. If you need to unzip, just double click on the zip file or right click and select open.


[[File:9b SMAPI unzip.png|300px]]
Once downloaded, the file may need to be unzipped or it may automatically unzip, depending on your OS version and your settings. If you need to unzip it, just double click on the zip file or right click and select open.
|-
|


Once it's unzipped, the folder should look something like this. You will need to find the "install on macOS.command" file in the folder.
<span style="font-size:180%;">'''STEP 2'''</span>


[[File:9 SMAPI installer.png|500px]]
[[File:9 SMAPI installer.png|700px]]  
|| Once unzipped, double-click on the folder to open its contents. Locate the <samp>install on macOS.command</samp> file.
|-
|


Once you find the "install on macOS.command" file, you will need to right click (on a trackpad, two finger click) on the file, and select open.
<span style="font-size:180%;">'''STEP 3'''</span>


[[File:10 SMAPI installer open.png|500px]]
[[File:10 SMAPI installer open.png|center|400px]]  
|| Highlight the file, right click on it (on a trackpad, two finger click), and select open.
|-
|


After you select open by right clicking, it will warn you that SMAPI was not made by a big company that registered the app with Apple. This is okay, so press open.
<span style="font-size:180%;">'''STEP 4a'''</span>


[[File:11 SMAPI open warning.png|200px]]
[[File:11 SMAPI open warning.png|center|300px]]  
|| After you select open, you might receive a pop-up warning. This warning alerts you that SMAPI was not made by a big company that registered the app with Apple. This is okay, so select open, and proceed to '''Step 7'''.
|-
|


Once you tell it that it's fine to open, it should open a window in Terminal. If it doesn't, or if the window doesn't look like the next image, just quit Terminal and re-open.
<span style="font-size:180%;">'''STEP 4b'''</span>


[[File:12 SMAPI terminal 1.png|500px]]
[[File:MacOS SMAPI Warning 1.png|center|300px]]
|| After you select open, you might receive a pop-up warning. This warning alerts you that MacOS blocked the opening of the SMAPI installer. Click "done" and proceed to the next step.
|-
|


SMAPI's terminal window will guide you through how to install. The following pictures should be helpful if you get confused at any point.
<span style="font-size:180%;">'''STEP 5'''</span>


[[File:13 SMAPI terminal 2.png|500px]]
[[File:MacOS SMAPI Install.png|center|300px]]
|| To bypass, navigate to System Settings --> Security & Privacy. Scroll down until you see the "Security" section. There you will see a message stating that MacOS has blocked the installer. Select "Open Anyway" and proceed to the next step.
|-
|


[[File:14 SMAPI terminal 3.png|500px]]
<span style="font-size:180%;">'''STEP 6'''</span>


Once you've successfully installed SMAPI, you should get a window that looks like this. This final window includes the game path, so it will be very helpful to copy that and save it for when you want to find your Mods folder. The game path is almost invisible in dark mode, so it's helpful to change to light mode.  
[[File:MacOS SMAPI Warning 2.png|center|300px]]
|| Another warning message will pop-up, alerting you that Apple couldn't verify the safety of the installer. It's safe, so click "Open Anyway" and the installer will start running.
|-
|


[[File:15 SMAPI terminal success.png|500px]]
<span style="font-size:180%;">'''STEP 7'''</span>


Here is the light mode view of the same window.  
[[File:12 SMAPI terminal 1.png|700px]]
|| Next, a new window should open in Terminal. If it doesn't, or if the window doesn't look like the next image, just quit Terminal and re-open the install file.


[[File:16 SMAPI terminal light.png|500px]]


==Find and save your Mods folder==
SMAPI's terminal window will guide you through the installation process.
On a Mac, if you've saved where SMAPI installed mods, you can use Finder functions to get to your Mods folder, then save an alias of your Mods folder somewhere convenient.  
|-
|
 
<span style="font-size:180%;">'''STEP 8'''</span>


Start by going to the Finder menu and going to Go, then Go to Folder.  
[[File:13 SMAPI terminal 2.png|700px]]
|| This step is to select your font color. Select one, input the number, and press enter.
|-
|


[[File:17 Finder go to folder.png|500px]]
<span style="font-size:180%;">'''STEP 9'''</span>


Once you have the menu open, paste in the game path you saved from earlier. If you didn't save it, you can guess it using the pattern from the finding your mods folder page.  
[[File:14 SMAPI terminal 3.png|700px]]
|| The final step is to choose where SMAPI will install. Option 1 is the default MacOS location -- '''Double check the file path is correct.''' For most users, it should read: <samp>/Users/username/Library/Application Support/Steam/steamapps/common/Stardew Valley/Contents/MacOS</samp>.


[[File:18 go to folder path.png|500px]]


Once you hit return, it will take you to your Mods folder. It's inside a folder named MacOS, which is helpful to be able to navigate to later, especially if you want to switch between different sets of mods. To make your life easier, you can make an alias of this folder by right clicking and selecting Make Alias, then moving the alias somewhere convenient like your Documents or Desktop.  
You can choose a custom path, but this is not recommended for first-time users.
|-
|


[[File:19 make alias.png|500px]]
<span style="font-size:180%;">'''STEP 10'''</span>


If you prefer to keep things simple, you can make an alias of just your mods folder. Then all you have to do to add mods is drag and drop their unzipped folders into this folder. It is very important to put mods in this folder and not anywhere else, or they will not work because SMAPI will not find them!
[[File:15 SMAPI terminal success.png|700px]]
|| If successfully installed, you should see that two bundled mods were installed: Console Commands and Save Backup. You will then see "SMAPI is installed!" on the last line. Copy and save the game path at the top of the window for when you want to find your Mods folder.  


[[File:20 make mods alias.png|500px]]


==Manually Launching SMAPI on M1 Mac==
(Note: The game path is almost invisible in dark mode, so you may want to change to light mode.)
|}


Recent versions of MacOS, particularly those that rely on M1 chips, may present an error when attempting to launch SMAPI.
==Find and save your Mods folder==
Using the game path you copied & saved during SMAPI installation, you can direct Finder to go directly to your Mods folder, where you can then save an alias somewhere convenient.  
{| class="wikitable"
|-
! Visual !! Instructions
|-
|


[[File:Nullpermissions.png|220px]]
<span style="font-size:180%;">'''STEP 1'''</span>


This error is telling you that SMAPI's attempt to auto-launch was blocked because of a permissions issue. You can manually override this error. First click on the information button (blue circle with italicized i), which will reveal a file path to the auto-launcher.  
[[File:17 Finder go to folder.png|500px]]
||Start by opening the Finder menu.  


[[File:Nullpermissionsinfo.png|400px]]
Navigate to "Go," then "Go to Folder."
|-
|


Double-click on the document icon to open a Finder window showing the hidden tmp folder with the SMAPI launcher. The tmp folder is in the hidden private folder, so it is easiest to access it directly through the error message.
<span style="font-size:180%;">'''STEP 2'''</span>


If this is the first time you are doing this, your file will likely say open-smapi-terminal.sh (this is the default launcher that is created when installing SMAPI, and will not naturally be read by M1 Terminal).  
[[File:18 go to folder path.png|500px]]
||Paste in the game path you saved from earlier. The default game path is:
<samp>/Users/username/Library/Application Support/Steam/steamapps/common/Stardew Valley/Contents/MacOS</samp>.  
|-
|


[[File:Tmpsh.png|500px]]
<span style="font-size:180%;">'''STEP 3'''</span>


Right-click (two-fingered click on trackpad) on open-smapi-terminal.sh and select Get Info. In the "Open With" section, open the drop-down menu and go all the way to the bottom to select "Other...". Your Applications folder will open.  
[[File:19 make alias.png|500px]]
||Hit return or select "Go," and Finder will take you directly to the /MacOS folder. This is especially helpful if you want to switch between different sets of mods.


[[File:Getinfosh.png|240px]] 
[[File:Openwithother.png|260px]]


In your Applications folder, scroll down to find the Utilities folder and open it. You should find Terminal listed here. Select it and click "Add."  
To make an alias, right click on the folder and select "Make Alias" from the menu. This will create a new folder named "MacOS alias."  


[[File:Utilitiesfolder.png|500px]]


If it is grayed out, use the drop-down menu below the applications list to Enable "All Applications". All applications may temporarily gray out, but they will shortly become available. Select Terminal and click "Add."
Next, move the alias somewhere convenient like your Documents folder or on your Desktop.
|-
|


[[File:Enableall.png|500px]]
<span style="font-size:180%;">'''STEP 4'''</span>


After clicking Add you should be returned to the tmp folder where the SMAPI launcher resides. Double-click on it to launch SMAPI with Terminal.
[[File:20 make mods alias.png|500px]]
||To simplify the process further, you can make an alias of just your Mods folder. Then all you have to do to add mods is drag and drop the unzipped folders into this one. '''It is very important to put mods in this folder and not anywhere else, or they will not work because SMAPI will not find them!'''


You may find you have to manually launch SMAPI every time you want to play. Once you have set Terminal as the launching application, manually launching is as simple as clicking on the info button in the error message, opening the tmp folder, and then double-clicking either the .sh or the .command launcher file. Both will launch SMAPI in terminal.  
Repeat steps 1-3, substituting the Mods folder path in step 2:
<samp>/Users/username/Library/Application Support/Steam/steamapps/common/Stardew Valley/Contents/MacOS/Mods</samp>.
|}


==Manually Launching SMAPI on M1 Mac==
MacOS versions that rely on M1 chips may present an error when attempting to launch SMAPI. This error indicates that SMAPI's attempt to auto-launch was blocked because of a permissions issue. The following should help resolve the error. 
{| class="wikitable"
|-
! Visual !! Instructions
|-
|


==OLD, NOT USED ANYMORE: Install .NET 5==
<span style="font-size:180%;">'''STEP 1'''</span>


In the past, before SMAPI bundled .NET 5.0, these instructions were useful. They should no longer be relevant.  
[[File:Nullpermissions.png|center|220px]]
||First click on the information button (blue circle with italicized i), which will reveal a file path to the auto-launcher.
|-
|


From the instructions page, it says to: Install [https://dotnet.microsoft.com/download/dotnet/5.0/runtime .NET 5].
<span style="font-size:180%;">'''STEP 2'''</span>


If you have an M1 Mac, you may need a different version. See the other section, [[Modding:Installing_SMAPI_on_Mac_Pictorial_Guide#For_M1_Macs_Only:_Install_.NET_5.0.11]]. If you're not sure if you have an M1 Mac, go to the apple in the top left, click "About My Mac", and look under processor. If it says M1, then you have an M1 Mac.
[[File:Nullpermissionsinfo.png|center|400px]]
||Double-click on the '''tmp''' folder icon to bring up a new Finder window for that folder. This folder is hidden, so the easiest way to access it is directly through the error message.  
|-
|


The following image is what the .NET 5 link in the instructions takes you to. Click the download circled in red.
<span style="font-size:180%;">'''STEP 3'''</span>


[[File:Dotnetnewscreenshot.png|500px]]
[[File:Tmpsh.png|center|500px]]
||The first time you do this, you'll need to locate the file likely named <samp>open-smapi-terminal.sh</samp>. (This is the default launcher created when installing SMAPI and isn't automatically read by M1 Terminal.)


Once you download the installer, it will look like this. You should double click on it to open, or right click and select open.  
Right-click (two-fingered click on trackpad) on <samp>open-smapi-terminal.sh</samp> and navigate to ''Get Info''.  
|-
|
<span style="font-size:180%;">'''STEP 4'''</span>


[[File:1b NET installer.png|500px]]
[[File:Getinfosh.png|center|300 px]]
||Locate the "Open With" section and click on the blue arrow box to open the drop-down menu.
|-
|


When you open the installer, it will have a series of steps to walk you through the installation. The following pictures circle which buttons to click along the way.
<span style="font-size:180%;">'''STEP 5'''</span>


[[File:1c NET installer 1.png|500px]]
[[File:Openwithother.png|center|260px]]
||Scroll to the bottom of the list and select "Other...". This will open the Applications folder.


[[File:1d NET installer 2.png|500px]]
(It does not matter what the default application is -- if yours is not Sublime Text, don't worry about it, we're changing it anyway.)
|-
|


Once it finishes, it should look like this. You can delete the .NET 5 installer package if you like.
<span style="font-size:180%;">'''STEP 6'''</span>


[[File:1e NET installer success.png|500px]]
[[File:Utilitiesfolder.png|center|500px]]
||Scroll down to find the "Utilities" folder and double-click to open it. Locate '''Terminal''', select it, and click the blue "Add" button.
|-
|[[File:Enableall.png|center|500px]]
||If '''Terminal''' is grayed out, use the drop-down menu below the applications list to Enable "All Applications". All applications may temporarily gray out, but they will shortly become available. Select '''Terminal''' and click "Add."
|-
|


==OLD, NOT USED ANYMORE: For M1 Macs Only: Install .NET 5.0.11==
<span style="font-size:180%;">'''STEP 7'''</span>


In the past, before SMAPI bundled .NET 5.0, these instructions were useful. They should no longer be relevant.  
[[File:Tmpsh2.png|center|500px]]
||After clicking "Add" you should be returned to the '''tmp''' folder from Step 2. Double-click on the file named <samp>open-smapi-terminal.command</samp> to launch SMAPI with Terminal.  
|}


It seems like, at least for some users on M1 Macs, installing .NET 5.0.11 fixes things. You're going to need to go to [https://github.com/dotnet/core/blob/main/release-notes/5.0/5.0.11/5.0.11.md the .NET 5.0.11 Github] and download the thing circled in red below:
You may find you have to manually launch SMAPI every time you want to play. Once you have set Terminal as the launching application, manually launching is as simple as clicking on the info button in the error message, opening the tmp folder, and then double-clicking either the .sh or the .command launcher file. Both will launch SMAPI in terminal.


[[File:Alternative M1 dotNet.png|500px]]


Once you have downloaded this installer, run it (similar to above). Please note that this is not guaranteed to work! But it is worth a try.


[[Category:Modding]]
[[Category:Modding]]
==History==
{{History|Updated for SMAPI 4.0.0 and later.}}

Latest revision as of 02:09, 11 December 2024

This guide is meant to be a supplement to the page that tells you how to install SMAPI on a Mac, with pictures to help guide the process.

Install SMAPI

From the instructions page: Download the latest version of SMAPI.

Visual Instructions

STEP 1

To start, pick an option for downloading -- any of these listed will work. Please be sure to check which version of SMAPI you need! SMAPI 4.0.0 or later will only work on SDV 1.6. If you are still playing SDV 1.5.6 you will need a previous version of SMAPI, which you can get from the GitHub Releases page.


Once downloaded, the file may need to be unzipped or it may automatically unzip, depending on your OS version and your settings. If you need to unzip it, just double click on the zip file or right click and select open.

STEP 2

Once unzipped, double-click on the folder to open its contents. Locate the install on macOS.command file.

STEP 3

Highlight the file, right click on it (on a trackpad, two finger click), and select open.

STEP 4a

After you select open, you might receive a pop-up warning. This warning alerts you that SMAPI was not made by a big company that registered the app with Apple. This is okay, so select open, and proceed to Step 7.

STEP 4b

After you select open, you might receive a pop-up warning. This warning alerts you that MacOS blocked the opening of the SMAPI installer. Click "done" and proceed to the next step.

STEP 5

To bypass, navigate to System Settings --> Security & Privacy. Scroll down until you see the "Security" section. There you will see a message stating that MacOS has blocked the installer. Select "Open Anyway" and proceed to the next step.

STEP 6

Another warning message will pop-up, alerting you that Apple couldn't verify the safety of the installer. It's safe, so click "Open Anyway" and the installer will start running.

STEP 7

Next, a new window should open in Terminal. If it doesn't, or if the window doesn't look like the next image, just quit Terminal and re-open the install file.


SMAPI's terminal window will guide you through the installation process.

STEP 8

This step is to select your font color. Select one, input the number, and press enter.

STEP 9

The final step is to choose where SMAPI will install. Option 1 is the default MacOS location -- Double check the file path is correct. For most users, it should read: /Users/username/Library/Application Support/Steam/steamapps/common/Stardew Valley/Contents/MacOS.


You can choose a custom path, but this is not recommended for first-time users.

STEP 10

If successfully installed, you should see that two bundled mods were installed: Console Commands and Save Backup. You will then see "SMAPI is installed!" on the last line. Copy and save the game path at the top of the window for when you want to find your Mods folder.


(Note: The game path is almost invisible in dark mode, so you may want to change to light mode.)

Find and save your Mods folder

Using the game path you copied & saved during SMAPI installation, you can direct Finder to go directly to your Mods folder, where you can then save an alias somewhere convenient.

Visual Instructions

STEP 1

Start by opening the Finder menu.

Navigate to "Go," then "Go to Folder."

STEP 2

Paste in the game path you saved from earlier. The default game path is:

/Users/username/Library/Application Support/Steam/steamapps/common/Stardew Valley/Contents/MacOS.

STEP 3

Hit return or select "Go," and Finder will take you directly to the /MacOS folder. This is especially helpful if you want to switch between different sets of mods.


To make an alias, right click on the folder and select "Make Alias" from the menu. This will create a new folder named "MacOS alias."


Next, move the alias somewhere convenient like your Documents folder or on your Desktop.

STEP 4

To simplify the process further, you can make an alias of just your Mods folder. Then all you have to do to add mods is drag and drop the unzipped folders into this one. It is very important to put mods in this folder and not anywhere else, or they will not work because SMAPI will not find them!

Repeat steps 1-3, substituting the Mods folder path in step 2: /Users/username/Library/Application Support/Steam/steamapps/common/Stardew Valley/Contents/MacOS/Mods.

Manually Launching SMAPI on M1 Mac

MacOS versions that rely on M1 chips may present an error when attempting to launch SMAPI. This error indicates that SMAPI's attempt to auto-launch was blocked because of a permissions issue. The following should help resolve the error.

Visual Instructions

STEP 1

First click on the information button (blue circle with italicized i), which will reveal a file path to the auto-launcher.

STEP 2

Double-click on the tmp folder icon to bring up a new Finder window for that folder. This folder is hidden, so the easiest way to access it is directly through the error message.

STEP 3

The first time you do this, you'll need to locate the file likely named open-smapi-terminal.sh. (This is the default launcher created when installing SMAPI and isn't automatically read by M1 Terminal.)

Right-click (two-fingered click on trackpad) on open-smapi-terminal.sh and navigate to Get Info.

STEP 4

Locate the "Open With" section and click on the blue arrow box to open the drop-down menu.

STEP 5

Scroll to the bottom of the list and select "Other...". This will open the Applications folder.

(It does not matter what the default application is -- if yours is not Sublime Text, don't worry about it, we're changing it anyway.)

STEP 6

Scroll down to find the "Utilities" folder and double-click to open it. Locate Terminal, select it, and click the blue "Add" button.
If Terminal is grayed out, use the drop-down menu below the applications list to Enable "All Applications". All applications may temporarily gray out, but they will shortly become available. Select Terminal and click "Add."

STEP 7

After clicking "Add" you should be returned to the tmp folder from Step 2. Double-click on the file named open-smapi-terminal.command to launch SMAPI with Terminal.

You may find you have to manually launch SMAPI every time you want to play. Once you have set Terminal as the launching application, manually launching is as simple as clicking on the info button in the error message, opening the tmp folder, and then double-clicking either the .sh or the .command launcher file. Both will launch SMAPI in terminal.

History