Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Instructions for macOS

  1. If the Xcode Command Line Tools are not installed, download the tools here, open your Terminal, and run the following command:

    xcode-select --install
    
  2. Optional: To run tests, if the homebrew environment is not installed, install the package manager using this reference. Open your terminal and run the following commands:

    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
    brew install coreutils
    
  3. Optional: To run tests via Rosetta

    • You probably don't want to do this as it's much slower. Most users can use native tools, but some may have other reasons to use this setup such as working with Intel-only custom tooling.
    • You will need an Intel-compatible homebrew installation. Understanding how to get one can be found here.
    • Install coreutils like in step 3, but using your Intel-compatible installation of homebrew.

Installing libpng (macOS)

Note for advanced users...

This guide installs libpng via Homebrew as it is the easiest method, however advanced users can install libpng through other means if they so desire.

  1. Open the Terminal.

  2. If Homebrew is not installed, then install Homebrew by following the instructions on the website.

  3. Run the following command to install libpng.

    brew install libpng
    

    libpng is now installed.

    Continue to Installing pkg-config (macOS) if pkg-config is not installed. Otherwise, continue to Installing devkitARM (macOS) if devkitARM is not installed.

    If both pkg-config and devkitARM are already installed, go to Choosing where to store pokeemerald-expansion (macOS).

Installing pkg-config (macOS)

Note for advanced users...

This guide installs pkg-config via Homebrew as it is the easiest method, however advanced users can install pkg-config through other means if they so desire.

  1. Open the Terminal.

  2. If Homebrew is not installed, then install Homebrew by following the instructions on the website.

  3. Run the following command to install libpng.

    brew install pkg-config
    

    pkg-config is now installed.

    Continue to Installing devkitARM (macOS) if devkitARM is not installed, otherwise, go to Choosing where to store pokeemerald-expansion (macOS).

Installing devkitARM (macOS)

  1. Download the devkitpro-pacman-installer.pkg package from here.

  2. Open the package to install devkitPro pacman.

  3. In the Terminal, run the following commands to install devkitARM:

    sudo dkp-pacman -Sy
    sudo dkp-pacman -S gba-dev
    sudo dkp-pacman -S devkitarm-rules
    

    The command with gba-dev will ask for the selection of packages to install. Just press Enter to install all of them, followed by entering Y to proceed with the installation.

  4. After the tools are installed, devkitARM must now be made accessible from anywhere by the system. To do so, run the following commands:

    export DEVKITPRO=/opt/devkitpro
    echo "export DEVKITPRO=$DEVKITPRO" >> ~/.zshrc
    export DEVKITARM=$DEVKITPRO/devkitARM
    echo "export DEVKITARM=$DEVKITARM" >> ~/.zshrc
    
    echo "if [ -f ~/.zshrc ]; then . ~/.zshrc; fi" >> ~/.zprofile
    

    Note: Starting with macOS 10.15, the default Unix shell is now zsh. If you migrated from an older version of macOS, you might still be using bash. You can check my running echo $0 in the terminal.

    If your terminal is using bash instead of zsh...
    export DEVKITPRO=/opt/devkitpro
    echo "export DEVKITPRO=$DEVKITPRO" >> ~/.bashrc
    export DEVKITARM=$DEVKITPRO/devkitARM
    echo "export DEVKITARM=$DEVKITARM" >> ~/.bashrc
    
    echo "if [ -f ~/.bashrc ]; then . ~/.bashrc; fi" >> ~/.bash_profile
    

Installing Python (macOS)

  1. Download the latest Python package from here.
  2. Open the package to install Python.

Python is now installed.