Compiling RPG++

Getting dependencies

To build RPG++, you will need the following tools and packages:

  • For all platforms:

    • xmake (follow the instructions on the website to install XMake on your system)

    • git

  • Specifically for Linux (instructions to install packages are listed below):

    • Packages: gcc, g++, make, ninja, libx11-dev, libxrandr-dev, libxinerama-dev, libxcursor-dev, libxi-dev, libgl1-mesa-dev, and mesa-common-dev

    • Debian:

      sudo apt install build-essential ninja-build libx11-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libgl1-mesa-dev mesa-common-dev

    • Fedora:

      sudo dnf install gcc gcc-c++ make ninja-build libX11-devel libXrandr-devel libXinerama-devel libXcursor-devel libXi-devel mesa-libGL-devel

    • Arch Linux:

      sudo pacman -S base-devel ninja libx11 libxrandr libxinerama libxcursor libxi mesa

  • Specifically for Windows:

    • Visual Studio 2019 or later with Desktop development with C++ (community edition will suffice)

  • Specifically for MacOS:

    • Xcode

Building

  1. Clone the project using git with

git clone https://github.com/rpgppengine/rpgpp.git

  1. Build all targets by running the following commands (follow the instructions to install packages if there is one)

xmake build --all

Warning

If build fails.

You can try the following:

xmake clean --all # remove build artifacts
xmake require --clean # remove installed package cache for project
xmake require --force # force install of package

Running

You can run the RPG++ Editor with:

xmake run editor