Skip to main content

Building RGBDS from source

RGBDS is open-source, which means you can always compile it yourself, for example if no pre-built solution is available to you, or if you want a specific version.

caution

Some of the build steps vary between systems, so the instructions provided here are somewhat generic. Windows works largely differently from everything else, so some expertise is expected if attempting this on Windows.

1. Get the source code​

You first need to get the source files to be compiled, using one of the methods below.

  1. Go the latest release (or pick a specific version)
  2. Under "Assets" at the bottom, download any of the last three listed files (rgbds-<version>.tar.gz, "Source code (zip)", or "Source code (tar.gz)").
  3. Extract ("unzip") the file.

2. Build​

The following are required to build RGBDS; most of those should already be installed on your system.

  • make and/or cmake, depending on what method you choose below
  • The bash shell
  • A C++ compiler compatible with C++20, typically g++ or clang++ (and/or a C compiler prior to RGBDS 0.8.0)
  • bison (or yacc/byacc prior to RGBDS 0.5.0)
  • pkg-config (if you are using make)
  • libpng's development headers (if you are building RGBGFX), typically called libpng-dev, libpng-devel, or just libpng (a 16 or 1.6 suffix may also be present)

Two build systems are supported: plain old make, and CMake. Both can be used on most systems, but Windows users will almost certainly need to use cmake.

caution

Make sure to run all of the following commands from the root directory of the sources! That directory should contain a file called Makefile, another called CMakeLists.txt, and a few more.

Using Make​

Simply run the following two commands:

make
sudo make install

The second command is optional if you don't want to install RGBDS system-wide.

The following variables can be defined to control installation, like so: make Q=, make install PREFIX=~/.local

  • PREFIX: Location where RGBDS will be installed. Defaults to /usr/local.
  • bindir: Location where the binaries will be installed. Defaults to ${PREFIX}/bin.
  • mandir: Location where the manpages will be installed. Defaults to ${PREFIX}/share/man.
  • DESTDIR: This is prepended to all paths during the installation. It is mainly used for packaging.
  • Q: Whether to quiet the build or not. To make the build more verbose, clear this variable. Defaults to @.
  • STRIP: Whether to strip the installed binaries of debug symbols or not. Defaults to -s.
  • BINMODE: Permissions of the installed binaries. Defaults to 755.
  • MANMODE: Permissions of the installed man pages. Defaults to 644.

Using CMake​

CMake minimum version

Building RGBDS with CMake requires CMake 3.9 or later.

  1. Run CMake on the project:

    cmake -S . -B build -DCMAKE_BUILD_TYPE=Release

  2. Build RGBDS:

    cmake --build build

  3. You can install RGBDS. You are not required to, you can do whatever with the four binaries in build/src at this point.

    sudo cmake --install build