Awesome

Introduction

Explosion is a cross-platform C++ game engine, based on modern graphics api (aka Vulkan, DirectX 12, Metal), powered by ECS gameplay framework.

Build

We use cmake as build tool, the following table contains supported platform, toolchain and generator:

<table> <tr> <td>Platform</td> <td>Arch</td> <td>Toolchain</td> <td>Generator</td> </tr> <tr> <td rowspan="4">Windows</td> <td rowspan="4">x64</td> <td rowspan="4">Visual Studio</td> <td>Visual Studio 2019</td> </tr> <tr> <td>Visual Studio 2022</td> </tr> <tr> <td>Ninja</td> </tr> <tr> <td>Ninja Multi-Config</td> </tr> <tr> <td rowspan="3">macOS</td> <td rowspan="3">arm64</td> <td rowspan="3">Apple Clang</td> <td>Unix Makefiles</td> </tr> <tr> <td>Ninja</td> </tr> <tr> <td>Ninja Multi-Config</td> </tr> </table>

By cause of cmake, we recommend CLion as Explosion's IDE, which can help you build and manage project simplely, and brings best coding experience to you. When use CLion as IDE, you just need open the project and configure cmake toolchain and generator in settings, press build and everything is down.

If you want to continue with command line mode, the following commands may help:

# for single config generator, such as Ninja, Unix Makefiles
cmake -S . -B <build_dir> -G <generator_name> -DCMAKE_BUILD_TYPE=<build_config>
cmake --build <build_dir>

# for multi config generator, such as Visual Studio, Ninja Multi Config
cmake -S . -B <build_dir> -G <generator_name>
cmake --build <build_dir> --config <build_config>

The parameters' meaning:

<build_dir>: Build directory for saving cmake temporal files and dist binaries. You can transfer a build or any directory you like.
<build_config>: Build config of cmake, such as Debug or Release.
<generator_name>: C++ generator which cmake will use to build project, you can transfer any generator in table list above, such as Visual Studio 2019.

After build the project, you can get all dist binaries in <build_dir>/dist.

macOS Notice

If you have not installed xcode command line tools, you need install it:

xcode-select --install

If xcode app or xcode command line tools installed on you system, you need check xcode path set to command line tools path, continue with this command:

xcode-select -p

if the command print is not /Library/Developer/CommandLineTools, use this command to reset it:

sudo xcode-select -s /Library/Developer/CommandLineTools

Third Party Project Usage

Thanks all those following projects: