Skip to content

README.md

Latest commit

 

History

History
41 lines (27 loc) · 1.35 KB

README.md

File metadata and controls

41 lines (27 loc) · 1.35 KB

VKEngine

A simple 3D rendering engine built from the ground up using the Vulkan 1.0 API. It serves as a learning tool and a base for building more complex graphics applications.

Building the Project

Before building the project, be sure you have the following installed on your system:

  • Nix: nix-shell provides an environment with required system dependencies
  • Xmake: Simple cross-platform build system

Clone the repository:

$ git clone https://github.com/raydroplet/vkengine/
$ cd vkengine

Enter the nix shell:

$ nix-shell

Build the project:

$ xmake

Run the Application:

$ xmake run

⌨️ Controls

  • Move Forward/Left/Back/Right: W, A, S, D
  • Move Up/Down: Spacebar, Left Shift
  • Look Up/Down/Left/Right: Up, Down, Left, Right arrow keys

Acknowledgments