pokepinball/INSTALL.md
2022-05-28 13:33:38 -05:00

2.2 KiB

Instructions

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

Linux

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

Debian or Ubuntu

To install the software required for pokepinball:

sudo apt-get install make gcc git

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

After that, you're ready to build pokepinball.

Arch Linux

To install the software required for pokepinball:

sudo pacman -S make gcc git rgbds

Now you're ready to build pokepinball.

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

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 pokepinball.

Windows

To build on Windows, install Cygwin with the default settings.

Dependencies are downloaded in the installer rather than the command line. Select the following packages:

  • make
  • git
  • gcc-core

The latest pokepinball-compatible version of rgbds is 0.5.2. To install, put each of the files in the download in C:\cygwin\usr\local\bin.

Now you're ready to build pokepinball.

Build pokepinball

To download the pokepinball source files:

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

To build pokepinball.gbc:

make

To remove all generated files by the build process:

make clean

To compare the built pokepinball.gbc to the original ROM:

make compare