Kagu Engine

3D Game Engine made with Vulkan

Table of Contents

• Clone the repository
• Update the repository
• Project dependencies
• Building the engine
• License

Clone the repository

• Clone the repository and all its submodules with :

git clone --recursive https://github.com/dark-dylan-dev/KaguEngine
cd KaguEngine

The --recursive flag ensures that the submodules are cloned.

Update the repository

• Inside the KaguEngine/ directory, run :

git checkout master
git pull
git submodule update --init --recursive

The last command updates the submodules.

Project dependencies

• Vulkan SDK
• CMake

Linux dependencies

# APT
sudo apt-get update
sudo apt-get install -y libxkbcommon-dev libxinerama-dev libxcursor-dev libxi-dev libgl1-mesa-dev

# Pacman
sudo pacman -Syu
sudo pacman -S --noconfirm libxkbcommon xorg-xinerama xorg-xcursor libxi mesa

# DNF
sudo dnf makecache
sudo dnf install -y libxkbcommon-devel libXinerama-devel libXcursor-devel libXi-devel mesa-libGL-devel

Building the engine

• Inside the KaguEngine/ directory, run :

cmake -B build      # optional: add -DCMAKE_BUILD_TYPE=<BuildType>
cmake --build build # optional: add --config <BuildType>

Available build configurations : Debug, Release, RelWithDebInfo, MinSizeRel

Having a generator issue ?

You might get an error message while generating Unsupported generator: ...

It's because the import std; feature is not yet supported by this toolchain, consider using Ninja.

Do so by adding the -G Ninja flag to the first command.

License

Kagu Engine is licensed under the MIT License.