Quickstart

The following dependencies are required to build Obscura.

Dependencies

Most dependencies are automatically downloaded and built by CMake. This project uses CMake 3.24 or higher. We recommend installing CMake through pip with pip3 install cmake but it can also be installed through your system’s package manager. Besides CMake, you will need a C++20 compiler.

General dependencies

C++20 compiler. The following compilers are tested:
- Clang >= 15
- GCC >= 13
Python >= 3.9
Vulkan >= 1.3.250.0

Build

For building Obscura.

CMake >= 3.24 (recommended: pip3 install cmake)

Docs

For building the documentation of Obscura.

Doxygen >= 1.9.1 (recommended installation through package manager)
Sphinx >= 6.2.1 (recommended: pip3 install sphinx)
Breathe >= 4.35.0 (recommended: pip3 install breathe)
Sphinx RTD Theme >= 1.2.2 (recommended: pip3 install sphinx_rtd_theme)

Install

Note

Coming soon.

Build

By default, CMake will build the Release version of the engine. To build the Debug version, use the --config Debug flag when building. The tests are built by default for the Debug configuration.

Building Obscura

cmake -B build
cmake --build build [--config Debug]

Building tests, examples, and docs

You can also build tests and examples by passing CMake config parameters to the build command.

Building tests and examples

cmake -B build -DOBSCURA_PACKAGE_TESTS=ON -DOBSCURA_BUILD_EXAMPLES=ON -DOBSCURA_BUILD_DOCS=ON
cmake --build build [--config Debug]

The tests can then be run with:

Running tests

cd build
ctest

Of course you can also build the tests/examples/docs individually by simply not passing the respective parameters.