Files
Poke_Transporter_GB/BUILDING.md
2026-07-24 11:43:58 -04:00

2.0 KiB

Prerequisites

Windows

  1. Install Docker Desktop.

  2. Install a WSL 2 distro.

  3. Enable Docker integration with your WSL distro:

  4. Install git.

  5. Open a WSL shell and install jq and dialog through your package manager.

  6. Continue with Cloning the Repository.

Make sure to stay inside the WSL shell for the rest of this tutorial!

Linux

  1. Install Docker Engine
  2. Install jq, dialog, and git through your package manager.
  3. Continue with Cloning the Repository.

macOS

  1. Install Docker Desktop.
  2. Install gmake, jq, dialog, and git through Homebrew.
  3. Continue with Cloning the Repository.

Cloning the Repository

  • cd to the directory you want to clone the repository: cd ~/path/where/repo/will/be/cloned/

The repository folder will be stored in this directory (i.e. ~/path/where/repo/will/be/cloned/Poke_Transporter_GB)

  • Clone the repository and enter its directory: git clone https://github.com/Striaton-Lab-Team/Poke_Transporter_GB.git

  • Update all submodules: git submodule update --init --recursive

  • Continue with Building

Building

If you are on macOS, use gmake instead of make!

  1. View available targets with make help:
Targets
help: Display this help message
setup: Setup all required dependencies
configure: Specify ROM Language, ROM Type, and Text Source
clean: Cleans the build directory
build: Builds the ROM
  1. Setup the build environment with make setup.
  2. Configure which ROM to build with make configure.
  3. Build the ROM with make build.