pokecrystal/INSTALL.md

Instructions

These instructions explain how to set up the tools required to build pokecrystal, including rgbds, which assembles the source files into a ROM.

If you run into trouble, ask for help on IRC or Discord (see README.md).

Windows 10

Download and install Windows Subsystem for Linux. Then open the WSL terminal.

Update WSL's software before continuing. If you chose Debian, Ubuntu, or another distribution that uses apt-get, then enter this command:

apt-get update && apt-get upgrade

WSL has its own file system that's not accessible from Windows, but Windows files are accessible from WSL. So you're going to want to install pokecrystal within Windows. You'll have to change the current working directory every time you open WSL.

For example, if you want to store pokecrystal in C:\Users\<user>\Desktop, enter this command:

cd /mnt/c/Users/<user>/Desktop

(The Windows C:\ drive is called /mnt/c/ in WSL. Replace <user> in the example path with your username.)

If this works, then follow the instructions for Linux below for whatever distribution you installed for WSL.

Otherwise, continue reading below for the older Windows instructions.

Windows

Download Cygwin: setup-x86_64.exe for 64-bit Windows, setup-x86.exe for 32-bit.

Run setup and leave the default settings. At the "Select Packages" step, choose to install the following, all of which are in the "Devel" category:

• make
• git
• gcc-core

Double click on the text that says "Skip" next to each package to select the most recent version to install.

Then follow the rgbds instructions for Windows with Cygwin to install rgbds 0.5.2.

Note: If you already have an older rgbds, you will need to update to 0.5.2. Ignore this if you have never installed rgbds before. If a version newer than 0.5.2 does not work, try downloading 0.5.2.

Now open the Cygwin terminal and enter the following commands.

Cygwin has its own file system that's within Windows, at C:\cygwin64\home\<user>. If you don't want to store pokecrystal there, you'll have to change the current working directory every time you open Cygwin.

For example, if you want to store pokecrystal in C:\Users\<user>\Desktop:

cd /cygdrive/c/Users/<user>/Desktop

(The Windows C:\ drive is called /cygdrive/c/ in Cygwin. Replace <user> in the example path with your username.)

Now you're ready to build pokecrystal.

macOS

Install Homebrew. Follow the official instructions.

Open Terminal and prepare to enter commands.

Then follow the rgbds instructions for macOS to install rgbds 0.5.2.

Now you're ready to build pokecrystal.

Linux

Open Terminal and enter the following commands, depending on which distro you're using.

Debian or Ubuntu

To install the software required for pokecrystal:

sudo apt-get install make gcc git

Then follow the rgbds instructions to build rgbds 0.5.2 from source.

OpenSUSE

To install the software required for pokecrystal:

sudo zypper install make gcc git

Then follow the rgbds instructions to build rgbds 0.5.2 from source.

Arch Linux

To install the software required for pokecrystal:

sudo pacman -S make gcc git rgbds

Then follow the rgbds instructions for Arch Linux to install rgbds 0.5.2.

If you want to compile and install rgbds yourself instead, then follow the rgbds instructions to build rgbds 0.5.2 from source.

Termux

To install the software required for pokecrystal:

sudo apt install make clang git sed

To install rgbds:

sudo apt install rgbds

If you want to compile and install rgbds yourself instead, then follow the rgbds instructions to build rgbds 0.5.2 from source.

Other distros

If your distro is not listed here, try to find the required software in its repositories:

• make
• gcc (or clang)
• git
• rgbds

If rgbds is not available, you'll need to follow the rgbds instructions to build rgbds 0.5.2 from source.

Now you're ready to build pokecrystal.

Build pokecrystal

To download the pokecrystal source files:

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

To build pokecrystal.gbc:

make

To build pokecrystal11.gbc:

make crystal11

Build with a local rgbds version

If you have different projects that require different versions of rgbds, it might not be convenient to install rgbds 0.5.2 globally. Instead, you can put its files in a directory within pokecrystal, such as pokecrystal/rgbds-0.5.2/. Then specify it when you run make:

make RGBDS=rgbds-0.5.2/

make RGBDS=rgbds-0.5.2/ crystal11