How to build

Windows

Visual Studio 2017

1.) Open up the cloned REGoth folder in Visual Studio 2017, which will then load and cache its cmake configuration. The output log should notify you of any errors or missing dependencies during the cmake process.

2.) To allow for proper launching and debugging of the REGoth.exe process, choose the CMake -> Debug And Launch Settings -> src\target\REGoth.exe menu item. This will open up a launch.vs.json file for you to configure your Gothic path and command line arguments in.

Example for Gothic and Gothic II start elements:

{
  "version": "0.2.1",
  "defaults": {},
  "configurations": [
    {
      "type": "default",
      "project": "CMakeLists.txt",
      "projectTarget": "src\\target\\REGoth.exe",
      "name": "Gothic",
      "currentDir": "C:\\Steam\\steamapps\\common\\Gothic\\system",
      "args": [
        "-g ..",
        "-w world.zen"
      ]
    },
    {
      "type": "default",
      "project": "CMakeLists.txt",
      "projectTarget": "src\\target\\REGoth.exe",
      "name": "Gothic II",
      "currentDir": "C:\\Steam\\steamapps\\common\\Gothic II\\system",
      "args": [
        "-g ..",
        "-w newworld.zen"
      ]
    }
  ]
}

3.) Choose your build configuration (i.e. x64-Debug) and the start element Gothic or Gothic II at the top.

Android

Required Software

• Android-NDK (r14 or newer): https://developer.android.com/ndk/downloads/index.html
• Java
• Probably more

Building

At the moment of writing, you will need to git checkout android-fixes-2 before building

Go to the REGoth-Android-Subfolder, run the following command to build the APK and install it on the connected device:

ANDROID_NDK_HOME=path/to/android-ndk ./gradlew installArmDebug

Fedora

Required packages

gcc-c++  
cmake  
cmake-data  
libsndfile-devel  
openal-soft-devel  
flac-devel  
libvorbis-devel  
libjpeg-turbo-devel  
freetype-devel  
glew-devel  
libXrandr-devel  
libXinerama-devel  
libxcb-devel  
xcb-util-devel (provide randr extension)  
xcb-util-image-devel  
libXcursor-devel  
systemd-devel (provide udev-devel)
vulkan-devel (now that the project use vulkan)  
alsa-lib-devel (fedora 26 required)

Build command

dnf install allThePackageAbove  
cd path/To/Project  
mkdir build  
cd build  
cmake -DCMAKE_BUILD_TYPE=Release ..  
make -j4  

Debian Stretch / Ubuntu 16.04

Required packages

gcc-c++
cmake
libxinerama-dev
libvulkan-dev
libxcursor-dev
libx11-xcb-dev
libxcb-image0-dev
libxcb-randr0-dev
libudev-dev
libopenal-dev
freeglut3-dev
libjpeg-dev
libfreetype6-dev
libxrandr-dev
libglew-dev
libsndfile1-dev
libasound2-dev 
alsa-utils
alsa-oss

Build command

apt-get install allThePackageAbove  
cd path/To/Project
mkdir build
cd build 
cmake -DCMAKE_BUILD_TYPE=Release ..  
make -j4  

MacOS

Required packages

You need to have Command Line Tools installed. To do that, run xcode-select --install in your terminal.

Build command

Building is the same as in Linux, with no extra steps:

cd path/To/Project
mkdir build
cd build 
cmake -DCMAKE_BUILD_TYPE=Release ..  
make -j4