Description

ACTUALLY WORKING ON IT!

Welcome to VEngine, a graphics engine developed with Vulkan. This project aims to provide a robust foundation for game and application developers, focusing on the performance and flexibility offered by Vulkan.

Prerequisites

• CMake 3.27
• C++20
• Vulkan
• GLM
• assimp (unused ATM)

Usage

Build

$> ./build.sh build
[...]

This script also handle several other commands: clean, format and doc.

Run

$> ./vengine
[...]

Documentation

The documentation is generated using Doxygen. You can vizualize it on GitHub Pages.

Commit Norms

Commit Type	Description
build	Changes that affect the build system or external dependencies (npm, make, etc.)
ci	Changes related to integration files and scripts or configuration (Travis, Ansible, BrowserStack, etc.)
feat	Addition of a new feature
fix	Bug fix
perf	Performance improvements
refactor	Modification that neither adds a new feature nor improves performance
style	Change that does not affect functionality or semantics (indentation, formatting, adding space, renaming a variable, etc.)
docs	Writing or updating documentation
test	Addition or modification of tests

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

Thanks to Brendan Galea.