Modding:Installing SMAPI on Mac Pictorial Guide

From Stardew Valley Wiki
Jump to navigation Jump to search

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.

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.

8 SMAPI website.png

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.

9b SMAPI unzip.png

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.

9 SMAPI installer.png

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.

10 SMAPI installer open.png

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.

11 SMAPI open warning.png

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.

12 SMAPI terminal 1.png

SMAPI's terminal window will guide you through how to install. The following pictures should be helpful if you get confused at any point.

13 SMAPI terminal 2.png

14 SMAPI terminal 3.png

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.

15 SMAPI terminal success.png

Here is the light mode view of the same window.

16 SMAPI terminal light.png

Find and save your Mods folder

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.

Start by going to the Finder menu and going to Go, then Go to Folder.

17 Finder go to folder.png

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. The game path will be /Users/<username>/Library/Application Support/Steam/steamapps/common/Stardew Valley/Contents/MacOS and the Mods folder will be /Users/<username>/Library/Application Support/Steam/steamapps/common/Stardew Valley/Contents/MacOS/Mods

18 go to folder path.png

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.

19 make alias.png

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!

20 make mods alias.png

Manually Launching SMAPI on M1 Mac

Recent versions of MacOS, particularly those that rely on M1 chips, may present an error when attempting to launch SMAPI.

Nullpermissions.png

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.

Nullpermissionsinfo.png

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.

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).

Tmpsh.png

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.

Getinfosh.png Openwithother.png

(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. It must be set to Terminal for SMAPI to launch.)

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."

Utilitiesfolder.png

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."

Enableall.png

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.

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.

OLD, NOT USED ANYMORE: Install .NET 5

In the past, before SMAPI bundled .NET 5.0, these instructions were useful. They should no longer be relevant.

From the instructions page, it says to: Install .NET 5.

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.

The following image is what the .NET 5 link in the instructions takes you to. Click the download circled in red.

Dotnetnewscreenshot.png

Once you download the installer, it will look like this. You should double click on it to open, or right click and select open.

1b NET installer.png

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.

1c NET installer 1.png

1d NET installer 2.png

Once it finishes, it should look like this. You can delete the .NET 5 installer package if you like.

1e NET installer success.png

OLD, NOT USED ANYMORE: For M1 Macs Only: Install .NET 5.0.11

In the past, before SMAPI bundled .NET 5.0, these instructions were useful. They should no longer be relevant.

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 the .NET 5.0.11 Github and download the thing circled in red below:

Alternative M1 dotNet.png

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.