OpenSource-Reimplementation of the zEngine, used by the game "Gothic" and "Gothic II".

We have an active Chatroom on Gitter! If you want to reach us, this is the best way!

https://regoth-project.github.io/REGoth-bs/index.html

The project is built via CMake. You will need at least CMake 3.9.0.

To build the project for Linux, run the following commands from within the directory where you cloned REGoth:

mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo ..
cmake --build . --parallel 8

Note: If the linker complains about missing .so files when you try to run an executable, try running it as LD_LIBRARY_PATH=../lib ./REGothSomething. Also, you might get an error indicating libPhysX3_x64.so not being found. You need to go into REGoth-bs/lib/bsf/Dependencies/PhysX/lib/ and copy all .so-files to the location where libbsf.so was built, usually REGoth/build/lib.

This is the recommended way for developing on Windows. Visual Studio Code works really well with the CMake-files of REGoth. Just make sure to install the official C/C++ and CMake extensions.

To build the project for Windows, you need to be aware of some common pitfalls:

1. Always build x64, as bs:f does not support x86. To do that, make sure to use the correct Visual-Studio-Generator.
2. Similar to make, Visual Studio will not do parallel builds by default.

These are the commands:

md build
cd build
cmake -G"Visual Studio 15 2017 Win64" ..
cmake --build . --config RelWithDebInfo --parallel 8

You will need:

• Doxygen
• Python
• Sphinx (install via pip install sphinx)
• Breathe (install via pip install breathe)
• Sphinx ReadTheDocs-Theme (install via pip install sphinx_rtd_theme)

With a cmake-project generated, run this from within the build-directory:

cmake --build . --target REGoth_docs

This will generate the documentation as HTML into build/docs-source/html. To update Github-pages, copy the contents of that directory into the docs directory at the repository root.