Skip to content

Latest commit

 

History

History
154 lines (96 loc) · 4.16 KB

INSTALL.md

File metadata and controls

154 lines (96 loc) · 4.16 KB
Raw

Instructions

These instructions explain how to set up the tools required to build pokegold, 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.

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 pokegold within Windows. You'll have to change the current working directory every time you open WSL.

For example, if you want to store pokegold 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 successful, follow the regular Linux instructions below for whatever distribution you installed for WSL.

Otherwise, continue reading below for the regular 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 download rgbds: specifically version 0.4.0 - older versions will not work and newer versions can cause strange incompatibility issues - download win64.zip or win32.zip depending on your install. Extract it and put all the exe and dll files individually in C:\cygwin64\usr\local\bin.

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 pokegold there, you'll have to change the current working directory every time you open Cygwin.

For example, if you want to store pokegold 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 pokegold.

macOS

Install Homebrew. Follow the official instructions.

Open Terminal and enter the following commands.

To install rgbds:

brew install rgbds

Now you're ready to build pokegold.

Linux

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

Debian or Ubuntu

To install the software required for pokegold:

sudo apt-get install make gcc git

To install rgbds:

sudo apt-get install pkg-config flex bison libpng-dev
git clone -b v0.4.0 --depth=1 https://github.com/rednex/rgbds
sudo make -C rgbds install

OpenSUSE

To install the software required for pokegold:

sudo zypper install make gcc git

To install rgbds:

sudo zypper install pkg-config flex bison libpng16-devel
git clone -b v0.4.0 --depth=1 https://github.com/rednex/rgbds
sudo make -C rgbds install

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 also need these:

  • pkg-config
  • flex
  • bison
  • libpng (and the development headers)

To install rgbds:

git clone -b v0.4.0 --depth=1 https://github.com/rednex/rgbds
sudo make -C rgbds install

Now you're ready to build pokegold.

Build pokegold

To download the pokegold source files:

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

To build pokegold.gbc:

make gold

To build pokesilver.gbc:

make silver

To build both ROMs:

make