rush.vk

Table of Contents

• Build
  • Building for Unix
  • Building for MacOS
  • Building for Windows
• Credits and Attributions
  • Libraries
  • People and Groups

Building

Note Remember to git clone --recursive https://github.com/sjcobb2022/rush.vk.git

Unix Build Instructions

• Install the dependencies: cmake, vulkan, glfw

• For example

  sudo apt install vulkan-tools
  sudo apt install libvulkan-dev
  sudo apt install vulkan-validationlayers-dev spirv-tools
  sudo apt install cmake
  

• To Build

  • Shell

    cmake -S . -B ./build
    cmake --build .
    

MacOS Build Instructions

Install Dependencies

• Note that installing xcode is not necessary here since the Apple framework libraries are automatically included.

• Download and install MacOS Vulkan sdk

• Install cmake brew install cmake or [Download](https://cmake.org/download/)

• To Build

  • cmake

    cmake -S . -B ./build
    cmake --build .
    

Windows build instructions

• Download and install the Vulkan SDK
• Download and install CMake
  • Make sure to select "Add cmake to the system Path for all users"
• If Vulkan is not in the default location, add .env.cmake and point cmake in the right direction to find the vulkan lib\

Building for Visual Studio 2019

• In windows powershell

  cd rush.vk
  cmake -S . -B .\build\
  cmake --build .\buidld\
  

Credits

Mainly thanks to BlurryPiano (Brendan Galea) for making a really incredible and educational pathway into vulkan dev, making a major part of this codebase, and being a really nice guy.

Libraries

Thanks to the authors of these libraries :

• Dear ImGui
• EnTT
• GLFW
• GLM
• KTX
• spdlog
• TinyGltf
• TinyObjLoader
• Vulkan Memory Allocator

People and Groups

Thanks to LunarG

Thanks to Sascha Willems

Thanks to ThinMatrix

Attributions / Licenses

• Vulkan and the Vulkan logo are trademarks of the Khronos Group Inc.