How to install SplatCrab on Mac

Before you start

These are one-time installs. If you have used Terminal before, you may have them already — the first step checks.

1. 1

   Install Git

   Apple opens a small installer.

   Type this into Terminal, then press Return.

   Copy

   xcode-select --install

   You know this worked when: Git responds with a version number

2. 2

   Install Node LTS

   Choose the macOS Installer (.pkg).

   Open download ↗

   You know this worked when: Node responds with a version number

Install SplatCrab

1. 3

   Open Terminal

   Keep it open beside this page.

   You know this worked when: Terminal is open

2. 4

   Check Git and Node

   Git and the current Node LTS are required.

   Type this into Terminal, then press Return.

   Copy

   git --version
   node --version

   You know this worked when: Git and Node respond with version numbers

3. 5

   Install Rust

   Run the single command the page shows, then reopen Terminal.

   Open rustup ↗

   You know this worked when: cargo responds with a version number

4. 6

   Copy SplatCrab to this Mac

   Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.

   Copy

   cd ~
   if [ ! -d splatcrab/.git ]; then
   git clone https://github.com/MH1044/splatcrab.git
   fi

   You know this worked when: A splatcrab folder appears

5. 7

   Open the SplatCrab folder

   Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.

   Copy

   cd ~
   cd splatcrab

   You know this worked when: Your terminal prompt is inside the splatcrab folder

6. 8

   Use the reviewed version

   Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.

   Copy

   cd ~/splatcrab
   git checkout b48997fb21e621ed0c673f3c950e8150bc85159b

   You know this worked when: Git reports the reviewed commit

7. 9

   Install dependencies

   Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.

   Copy

   cd ~/splatcrab
   cargo fetch

   You know this worked when: The command finishes without an error

8. 10

   Build the app

   The first build can take a while.

   Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.

   Copy

   cd ~/splatcrab
   cargo build --release

   You know this worked when: A SplatCrab app appears in the bundle folder

9. 11

   Open SplatCrab

   Find the built app in the bundle folder the build printed, then open it.

   You know this worked when: SplatCrab opens

10. 12

    Try it

    SplatCrab should be open and ready to use.

    You know this worked when: SplatCrab works

If something goes wrong

Nothing here can damage your computer, and every step can be run again safely. If a command fails, the usual cause is the step before it not having finished.

Still stuck? Tell us what happened and we will fix the guide. Include the step number and we can usually reproduce it.