Structure

This section will guide you through the directory structure of the engine.

Directories

The engine is divided into the following directories:

• engine: contains the source code of the engine
• utils: contains utility classes like the Logger, those classes are ussed both by the engine and the ECS
• tests: contains the tests for the engine
• examples: contains some examples on features of the engine, to build them follow the instructions in the Building page
• include: contains third party header files
• lib: contains the third party libraries
• game: source code of a demo game
• assets: directory for assets like models, textures, etc.

Files

• clang-format: the formatting configuration file for clang-format
• doxygen.conf: the configuration file for doxygen
• CMakeLists.txt: the main CMake file
• LICENSE: the license file

Namespaces

The engine uses the brenta namespace. There are also some subnamespace:

• brenta::types: contains the types used in the engine
• oak: the logger
• viotecs: the ECS
• valfuzz: the testing framework