This is a RCOS Project.
Feel free to take a look at our Kanban board for task management.
| OS | Versions Supported | Status |
|---|---|---|
| Windows 11 | 23H2 | 🚫 |
| MacOS | Sonoma 14.6.x | ✔️ |
| Linux | ❓ | 🚫 |
TBD
Using any code editor and terminal running shell script (VSCode Compatible):
- Clone this repository
- Install Homebrew if you don't already have it:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
- Install CMake & GLFW with Brew:
brew install cmake glfw vulkan-headers glm
- Install the latest Vulkan SDK (1.3.296.0), recommend putting the folder in the home folder i.e.
~or/Users/[username]and name the folder VulkanSDK. If you installed else where or named differently, you need the modify the folder location in/dev/setup_env.shwithin the cloned repository. SelectSystem Global Installationwhen prompted. - From the repository's root directory, run the following commands:
cd dev
./build_unix.sh
- You may need to give
build_unix.shsome permission:
chmod +x build_unix.sh
👍 You are ready for development!
Helpful Tools: .exe Disassembler
TBD
Make sure to install all of the libraries listed in the Vulken Tutorial
NOTE: Place the glfw3.lib or glfw.lib into the lib folder if you are using windows
NOTE: To compile, update the path in shaders/compile-shaders.<bat/sh> for the glslc.<exe/sh> file \
- For windows: it lives in
C:/VulkanSDK/x.x.x.x/Bin32/glslc.exe - For linux: depends on where you placed it
Install visual studio 2022
Install libraries listed in the tutorial
Click open existing project
Click the run button
Use any text editor that uses .clangd configurations if tou want to have intellisense
Make sure to install all the libraries listed in the vulken tutorial
Have Make install in your computer
Run make then make test
TBA
For linux systems:
VK_INSTANCE_LAYERS='VK_LAYER_MESA_OVERLAY' /path/to/app( Only works with amd gpus? )mangohud /path/to/app\
For windows systems:
- PresentMon (by Intel)
- Ocat