spanakorizo/suyu-macos-builds-script

Zsh script to install needed dependencies, compile and run Suyu, a Nintendo Switch emulator on macOS syetem, preferably Apple Silicon.

Build script for compiling Suyu on Apple Silicon

🇵🇱 Szukasz Polskiego? Kliknij tutaj! You are reading English version! 🇺🇸

This script will build and compile Suyu for macOS on Apple Silicon.

Warning

This script is provided for experimentation purposes.
Don't expect high compatibility, there are reasons why parent project to Suyu didn't get official Mac build.

Get it by pressing the button below or via Releases page :)

Usage:

After downloading, double click the script and follow the prompts.

It is advised to run it from your home directory.

You can check current macOS compatibility with apps and homebrews here.

Note

On a base M1, building takes ~6mins (measured including gathering needed dependencies which differs depending on your internet speed) In case of any permission issues, run:

chmod +x ./build_suyu.sh

Suyu currently does not support a lot of required features.
If a game you are trying to play uses these features, it will crash.
If you want to know what missing feature is causing the crash, run Suyu through Terminal:

/Applications/suyu.app/Contents/MacOS/suyu

You can also find a generated log file in ~/.local/share/suyu/log/suyu_log.txt!

The situation will get better in the future as MoltenVK adds support for more features.

Contribution:

1. Clone the repository to your home directory:

git clone https://github.com/mavethee/suyu-macos-builds-script.git
cd suyu-macos-builds-script

2. Make sure cloned repo is up to date:

git pull origin main

3. Copy the script to a location on your home directory:

ditto build_suyu.sh $HOME/build_suyu.sh

4. Make the script executable:

chmod +x $HOME/build_suyu.sh

5. Run the build script:

$HOME/build_suyu.sh

6. Enjoy!

Note: Remember to repeat STEP 2 for future script changes.

Special thanks to:

• Suyu's macOS build instructions available here

  ...and ChatGPT with GitHub Copilot for making my drunkass zsh scripting public.

• @shinra-electric for helping me maintain it and bringing some code quality 🍺

  If I get sued by Big N, come visit my grave ^^