mirror
/
pokeplatinum
mirror of https://github.com/pret/pokeplatinum
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pokeplatinum/INSTALL.md

9.2 KiB
Raw Permalink Blame History

Installation Instructions

This document details the steps necessary to build a copy of Pokémon Platinum (EN-US) using this repository.

Table of Contents

1. Setting Up Your Development Environment

Windows Subsystem for Linux

[!IMPORTANT] If you intend to store your project on the Windows file system (or do not know what that means), then use these instructions, which will guide you through installing WSL version 1. If you intend to use WSL version 2, then instead follow the instructions for Linux.

New Installs

Follow these instructions if you do not have an existing install of WSL.

  1. Open Windows PowerShell as Administrator. Paste (Right Click or Shift+Insert) the following command:

    wsl --install -d Ubuntu

  2. Once the process finishes, you will be prompted to restart your machine. Accept.

  3. After rebooting, reopen PowerShell and run the following command to downgrade WSL to version 1:

    wsl --set-version Ubuntu 1

    WSL version 1 is preferred for most WSL users due to its increased performance when accessing files in the Windows file system.

  4. Open Ubuntu from your Start menu.

  5. Ubuntu will set up its own installation when it runs for the first time. Once finished, it will ask for a username and password as input.

    [!NOTE] When typing the password, there will be no visible response; this is normal, and the terminal is still reading your input.

  6. Update Ubuntu's package registry:

    sudo apt update && sudo apt upgrade

  7. Install build dependencies.

Existing Installs

Follow these instructions if you have an existing install of WSL, specifically Ubuntu.

Older versions of Ubuntu (e.g., 20.04) ship with an outdated version of Python, which is not supported. To remedy this, you can upgrade your existing install to a more recent version of Ubuntu:

  1. Run the following inside Ubuntu:

    sudo apt upgrade && sudo apt full-upgrade

  2. Open PowerShell and run the following commands to restart Ubuntu:

    wsl -t Ubuntu
wsl -d Ubuntu

  3. Re-open Ubuntu and run the following to start a system upgrade:

    sudo do-release-upgrade

    This process may take a long time.

  4. Once Ubuntu is done upgrading, update Ubuntu's package registry:

    sudo apt update && sudo apt upgrade

  5. Install build dependencies.

Install Build Dependencies

  1. Run the following to install build dependencies from the Ubuntu package registry:

    sudo apt install bison flex g++ gcc-arm-none-eabi git lib32zl make ninja-build pkg-config python3 p7zip

  2. Download the repository.

Windows with MSYS2

If you are unable to run Windows Subsystem for Linux due to performance reasons or lacking virtualization requirements, then MSYS2 may be an option for you.

  1. Download the MSYS2 installer from the official website and install it on your system.

  2. Once the installation is complete, a terminal should automatically pop up. To update your package registry, enter the following command:

    pacman -Syu

    Press 'Y' when prompted to confirm the update. This process may take a few minutes. Once completed, the terminal will automatically close.

  3. Re-open an MSYS terminal (the pink icon) from your Start Menu, then enter the following commands to install necessary build dependencies:

    echo 'export PATH=${PATH}:/mingw64/bin' >> ~/.bashrc
source ~/.bashrc
pacman -S bison flex gcc git make ninja python mingw-w64-x86_64-arm-none-eabi-gcc p7zip

    Press 'Y' when prompted to confirm the installation.

  4. Download the repository.

MacOS

  1. Apple bundles a number of the requisite utilities into Xcode Command Line Tools; to install these, run:

    xcode-select --install

  2. Install Homebrew.

  3. Run the following commands to install additional dependencies:

    brew update
brew install gcc@14 ninja libpng pkg-config arm-none-eabi-gcc xz
brew install --cask wine-stable

  4. You may need to authorize the Wine installation to satisfy MacOS security requirements. To do this, open the Applications folder in Finder and locate the Wine Stable application. Control-Click on this icon to open the context menu, then Control-Click on Open and grant the requested permissions.

  5. If your MacOS installation is Monterey (12) or earlier, then you may also need GNU coreutils installed to run the build scripts:

    brew install coreutils

  6. Download the repository.

Linux

[!NOTE] Precise packages to be installed will vary by Linux distribution and package registry. A handful of common distributions are listed below for convenience.

Once you have installed all of the listed dependencies, proceed to downloading the repository.

Debian (and derivatives, e.g., Ubuntu, Mint)

  1. Enable 32-bit installations using dpkg:

    sudo dpkg --add-architecture i386

  2. Install the following packages via apt:

    sudo apt install bison flex g++ gcc-arm-none-eabi git make ninja-build pkg-config wget python3 xz-utils nasm libc6:i386

Arch Linux (and derivatives, e.g., Manjaro, Endeavour)

  1. Enable the multilib repository.

  2. Install dependencies via pacman:

    sudo pacman -S arm-none-eabi-gcc bison flex gcc git make ninja python wget xz lib32-glibc

Fedora (and derivatives, e.g., AlmaLinux, Red Hat Enterprise Linux)

sudo dnf install arm-none-eabi-gcc-cs bison flex gcc-c++ git make ninja-build python3 wget2 xz glibc32

2. Downloading the Repository

From your terminal, navigate to the path in which you will store the repository. Users of WSL 1 should ensure that their target is on the Windows file drive.

git clone https://github.com/pret/pokeplatinum
cd pokeplatinum

3. Building the Repository

To build the ROM, run:

make

If everything works, then the following ROM should be built:

Optionally, the repository can be configured to build a "revision 0" ROM (sha1: ce81046eda7d232513069519cb2085349896dec7). This revision matches the original retail version that was shipped in North America; it contains an error in the GTS code where the game will not display the level range of a wanted Pokémon. This error was patched as part of a second shipment of cartridges for the North American release; it is not present in any other localization.

To build this revision, instead of the above command, run the following:

ROM_REVISION=0 make

If you need further assistance, feel free to ask a question in the #pokeplatinum channel of the pret Discord (see README.md for contact information) or open an issue.

4. Debugger Support

This step is optional, but useful. pokeplatinum ships with support for GDB debugging and a target to build a debug-enabled ROM:

make debug

For convenience, a template launch.json configuration for VS Code is provided in the .vscode folder of the repository.

Due to the nature of the Nintendo DS, use of standard builds of GDB for debugging is insufficient. A fork of binutils-gdb which supports the overlay system employed by the console is available here.

For installation instructions, refer to the README.md.

Troubleshooting FAQ

My Build is Failing After Merging from Main

It is likely that your subprojects are out of date; update them with the following command:

make update

And then try rebuilding.