Getting started

Table of Contents

• Introduction
• Dependencies
• Building
• Build Commands

Introduction

Those tutorials will help learning how to use Oxygen Engine to create games or any 3D applications

Readers are assumed to be fairly comfortable with the C++ language and with CMake (or at least C++ compilation in general)

No knowledge of OpenGL or any rendering API are required, but understanding of basic concepts of 3D is recommended

This first tutorial will explain how to build and install Oxygen Engine

In a hurry? See at bottom for a complete list of commands used to install Oxygen Engine and all dependencies in one shot

Dependencies

We will heavily use CMake for building things. This will let you use any toolchain/IDE/compiler you want to build it

Oxygen Engine relies on several libraries to work properly. Although some of them are already embedded in the engine, you will need to also have those installed (ie CMake ready):

• GLFW
  • Provides an API to manage application windows, events and graphic contexts
  • By hiding OS specifics under an cross-platform API, it eases development of multi-platform applications
• glm
  • Provides mathematic utilities such as quaternions, matrices and vectors
• PhysicsFS
  • Provides filesystem abstraction, letting you mount any folder/archives in a virtual filesystem

Some of those might be already available in your OS repositories. However as they are often too old versions, it is recommended building them from source

Don't worry, it is not difficult 😉

In general it boils down to downloading the library (git clone) and running some flavor of cmake --build and cmake --install commands

See each library install instructions for the set of commands to use or see at bottom for a complete list of commands

Building

Once the dependencies are built and installed, now it is time to prepare the Oxygen Engine for compilation

Assuming you already downloaded / cloned the source code, here are the CMake options:

Name	Default	Description
OE_BUILD_TESTS	false	Build unit tests and render tests
OE_BUILD_EXAMPLES	false	Build examples applications
OE_CODE_COVERAGE	false	Enable code coverage metrics from tests
OE_CODE_COVERAGE_RENDER_TESTS	false	Include render tests in coverage metrics
OE_USE_ASAN	false	Compile with address sanitizer to debug and catch some memory errors
OE_BUILD_DOCUMENTATION	false	Build Documentation (ie. what you are currently looking at)
OE_DOCUMENTATION_ONLY	false	Only build documentation and not the engine (mainly used for CI/CD to build and deploy the website without needing dependencies)

Options with DOCUMENTATION requires Doxygen and Graphviz installed

Example for a compilation in Release (no debug symbols) in the specified <build-dir> directory (assuming you already downloaded the code in the OxygenEngine folder)

cmake -S OxygenEngine -B <build-dir>
cmake --build <build-dir> --parallel

Once its built, you need to install it to let your compiler know where the files are stored when including / linking library files

Actual steps heavily depends of your OS/Distribution. For example, in GNU/Linux you need to run sudo cmake --install <build-dir>

So now that you have built the engine, it's time to make your first application

Build Commands

(AKA, please just give me all the commands)

Here are all commands used to build and install the engine (assuming you already downloaded the code in the OxygenEngine folder)

Feel free to modify according to your existing setup (e.g. no need to build/install libraries you already have installed by other means)

# Build and install glm
git clone --depth 1 https://github.com/g-truc/glm && \
    cmake -DCMAKE_BUILD_TYPE=Release -DGLM_TEST_ENABLE= -S glm -B build_glm &&
    cmake --build build_glm --parallel && \
    sudo cmake --install build_glm
 
# Build and install GLFW
git clone --depth 1 https://github.com/glfw/glfw && \
    cmake -DCMAKE_BUILD_TYPE=Release -DGLFW_BUILD_EXAMPLES= -DGLFW_BUILD_TESTS= -S glfw -B build_glfw &&
    cmake --build build_glfw --parallel && \
    sudo cmake --install build_glfw
 
# Build and install PhysicsFS
git clone --depth 1 https://github.com/icculus/physfs && \
    cmake -DCMAKE_BUILD_TYPE=Release -S physfs -B build_physfs &&
    cmake --build build_physfs --parallel && \
    sudo cmake --install build_physfs
 
# Build and install Oxygen Engine
cmake -S OxygenEngine -B build_oe -DCMAKE_BUILD_TYPE=Release && \
    cmake --build build_release --parallel