Getting Started¶
Welcome to VulkanW3DViewer! This section will help you get up and running quickly.
What You'll Need¶
Before you begin, make sure you have:
- A GPU with Vulkan 1.3+ support
- Vulkan SDK 1.3 or later installed
- CMake 3.20 or later
- A C++20 compiler (Clang recommended)
Quick Links¶
-
Installation
Install the Vulkan SDK and clone the repository
-
Building
Build the project from source
-
Quick Start
Load your first W3D model
Platform Support¶
| Platform | Status | Compiler |
|---|---|---|
| Windows |  Supported |
Clang (via MSYS2 MinGW64) |
| Linux | Supported |
Clang/GCC |
| macOS | Supported |
Clang |
Dependencies¶
All dependencies are included as git submodules - no separate installation required:
| Library | Purpose |
|---|---|
| GLFW | Window creation and input handling |
| Vulkan-Hpp | Modern C++ bindings for Vulkan |
| GLM | OpenGL Mathematics library |
| ImGui | Immediate-mode debug GUI |
| CLI11 | Command-line argument parsing |
| GoogleTest | Testing framework |