Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 1.3 KB

README.md

File metadata and controls

33 lines (25 loc) · 1.3 KB

VulkanEngine

Build Status Windows Build Status Linux

A graphics engine that uses the Vulkan API. Currently, there is only the project set up with CMake, Github Actions and some basic dependencies. It shows a small sample that implements rendering an obj model with Vulkan in one file.

The plan is to use the engine primarily for voxel rendering.

alt text

Build Guide


Install:

build the project using cmake

Build:

  • Clone the project with all its submodules(--recursive)
    • git clone --recursive https://github.com/stiangglanda/VulkanEngine.git
  • Configure Project with CMake
    • cmake -DCMAKE_BUILD_TYPE=Release -S ../VulkanEngine -B ../VulkanEngine/build
  • Build with CMake
    • cmake --build ../VulkanEngine/build --config Release --target all
  • Run the Client
    • build/Client

Vulkan Engine UML Diagram:

VulkanEngineUML