A Vulkan Render Engine
Watch my game engine dev videos on my YouTube channel
Features:
- A Vulkan renderer with support for 2D and 3D scenes
- Support for 3D file formats Obj Wavefront (tinyobj), glTF (fastgltf), and FBX (ufbx and asset importer)
- Physically-based rendering (PBR), materials based on Blender's roughness-metallic workflow, normal mapping
- Point lights, directional lights with cascaded shadows, and deferred shading, instancing of models on the GPU
- Post-processing (Bloom), skeletal animations
- Scene management with scene descriptions, multi-threaded background loading, and scene saving based on simdjson
- Hotplug gamepad support based on SDL2 and a controller database
- Cross-platform support for Linux, macOS, Windows
- Particle system
- Water shader with reflection and refraction cameras based on the tutorial from ThinMatrix
- Mesh loading for height maps, including a color map and grass rendering
- Mesh loading for grass placement
- Collision mesh loading
- Event system for mouse, keyboard, controller, window, and game events
- Settings manager and a message logger
- Entity component system based on EnTT
- Physics simulator based on Jolt
- Physics simulator based on Box2D
- In-game GUI with two themes and debug GUI based on ImGUI and ImGuizmo
- Sprite sheets, a sprite sheet generator, and sprite sheet animations
- Thread Profiling with Tracy
- Profiling JSON output file for chrome://tracing
- Resource system for images and shaders to be compiled into the app
- Sound support and desktop volume settings (Linux only)
- Render-API abstraction and engine/application separation
- multi-threaded shader compilation with shaderc
- thread pool
Usage:
- Press "f" to toggle fullscreen and "m" to toggle the debug imgui window.
- Use the left and right sticks on the controller to move some objects around and scale them.
- Use the AWSD keys to move the camera. Q and E are for up and down
- Use the arrow keys to look around.
- Use the mouse wheel to zoom.
- The A button plays a test sound.
- Press ESC or the guide button on the controller to exit.
- Press "g" to fire the volcano and "r" to reset the scene.
- Use a gamepad to drive the vehicles and walk with the character animations
To blacklist a GPU, enter its name or a substring in engine.cfg.
Contributions: Please use https://en.wikipedia.org/wiki/Indentation_style#Allman_style and four spaces to indent.
Run:
git clone --recurse-submodules https://github.com/beaumanvienna/vulkan
Open a terminal
(Info: ppa:beauman/marley provides premake5)
sudo add-apt-repository ppa:beauman/marley
sudo add-apt-repository universe
sudo apt-get update
sudo apt install premake5 git build-essential xorg-dev libxrandr-dev libvulkan-dev libpulse-dev
sudo apt install libibus-1.0-dev libglib2.0-dev libsamplerate0-dev libasound2-dev libudev-dev
Get the Vulkan SDK from here:
https://vulkan.lunarg.com/doc/view/latest/linux/getting_started_ubuntu.html
Install the source code:
git clone --recurse-submodules https://github.com/beaumanvienna/vulkan
cd vulkan
Create project files for gcc:
premake5 gmake2
Define the number of CPU cores to be used for compiling
e.g. "-j4"
To use all available CPU cores, say:
export MAKEFLAGS=-j$(nproc)
You may want to add the export MAKEFLAGS=-j$(nproc) command to ~/.bashrc to always use multiple CPU cores for compiling a makefile.
Compile and run debug target:
make verbose=1 && ./bin/Debug/lucre
Compile and run release target:
make config=release verbose=1 && ./bin/Release/lucre
Download and install MacOS Vulkan sdk
Download and install Homebrew
Open a terminal
To install Xcode, type git
Install dependencies (note that premake5 is installed as premake, but called in the terminal as premake5):
brew install premake glib gtk+ sfml sdl2 sdl2_mixer libvorbis libogg glfw
Install the source code:
git clone --recurse-submodules https://github.com/beaumanvienna/vulkan
cd vulkan
Create project files for clang:
premake5 gmake2
Define the number of CPU cores to be used for compiling
e.g. "-j8" to use eight CPU cores
To use all available CPU cores, say:
export MAKEFLAGS=-j$(sysctl -n hw.ncpu)
To find out, how many cores your Mac has, say:
sysctl -n hw.ncpu
You may want to add the export MAKEFLAGS=-j8 command to ~/.zshrc to always use multiple CPU cores for compiling a makefile.
Compile and run debug target:
make verbose=1 && ./bin/Debug/lucre
Compile and run release target:
make config=release verbose=1 && ./bin/Release/lucre
Dependencies: gitbash, premake5, Visual Studio
Download the Vulkan SDK from lunarg.com, install it, then copy "C:\VulkanSDK\1.3.204.1" (path and version may differ) to vendor/VulkanSDK. The version number is omitted in the path.
Open gitbash
Install the source code:
git clone --recurse-submodules https://github.com/beaumanvienna/vulkan
cd vulkan
If you have Visual Studio 2022:
premake5.exe vs2022
If you have Visual Studio 2022, use instead:
premake5.exe vs2022
Open the solution for Vulkan, switch to Release, and hit F5
To clean all temporary files (including the spv-files, engine.cfg, imgui.ini, and the scene files in the top directory), use:
premake5 clean
To pull in the latest changes for the repository, use:
git pull && git submodule update --init --recursive