https://github.com/revelationtodo/revelation.plugin.vulkanrenderer
A Vulkan renderer for 3D objects.
https://github.com/revelationtodo/revelation.plugin.vulkanrenderer
revelation-plugin turorial vulkan vulkan-api vulkan-tutorial
Last synced: about 1 month ago
JSON representation
A Vulkan renderer for 3D objects.
- Host: GitHub
- URL: https://github.com/revelationtodo/revelation.plugin.vulkanrenderer
- Owner: revelationtodo
- License: gpl-3.0
- Created: 2026-01-22T03:15:19.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-02-09T09:50:21.000Z (about 1 month ago)
- Last Synced: 2026-02-09T14:49:20.446Z (about 1 month ago)
- Topics: revelation-plugin, turorial, vulkan, vulkan-api, vulkan-tutorial
- Language: C++
- Homepage:
- Size: 1.36 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vulkan Renderer
A lightweight Vulkan-based renderer plugin for displaying 3D models inside **Revelation TODO**.
---
## Overview
**Vulkan Renderer** is a plugin designed for the Revelation ecosystem, providing real-time rendering of 3D models using the Vulkan API.
It supports drag-and-drop model loading and integrates seamlessly with the Revelation plugin system.
---
## Usage
1. Download and install the Vulkan SDK from the official website: [Vulkan](https://vulkan.lunarg.com/)
2. Download **Revelation TODO** from the [revelation releases](https://github.com/revelationtodo/Revelation/releases) page.
3. Download the **Vulkan Renderer** plugin from this [repository’s releases](https://github.com/revelationtodo/Revelation.Plugin.VulkanRenderer/releases) page.
4. Extract the downloaded `.7z` file into the Revelation installation directory.
5. Launch `Revelation.exe` and open the **Vulkan Renderer** plugin page.
6. Drag any [supported](https://the-asset-importer-lib-documentation.readthedocs.io/en/latest/about/introduction.html) 3D model file into the renderer window.
7. The model will be loaded and rendered once the import process is complete.
---
## Vulkan Renderer
一个基于 **Vulkan** 的轻量级 3D 模型渲染插件，用于在 **Revelation TODO** 中实时显示 3D 模型。
---
## 使用说明
1. 从 [Vulkan](https://vulkan.lunarg.com/) 页面下载 **Vulkan SDK**。
2. 从 [Revelation 发布页面](https://github.com/revelationtodo/Revelation/releases)下载 **Revelation TODO** 主程序。
3. 从本仓库的[发布页面](https://github.com/revelationtodo/Revelation.Plugin.VulkanRenderer/releases)下载 **Vulkan Renderer** 插件。
4. 将下载的 `.7z` 中的所有文件夹及文件解压到 Revelation 的安装目录中。
5. 启动 `Revelation.exe`，并切换到 **Vulkan Renderer** 插件页面。
6. 将任意[支持格式](https://the-asset-importer-lib-documentation.readthedocs.io/en/latest/about/introduction.html)的 3D 模型文件拖拽到渲染窗口中。
7. 模型加载完成后，将自动显示并渲染在窗口中。
---
## Build Instructions
### Prerequisites
1. **Install Vulkan SDK**
Download and install the Vulkan SDK from the official website:
https://vulkan.lunarg.com/
Ensure the following components are available:
- Vulkan SDK
- `volk`
- `glm`
- Vulkan Memory Allocator (`vma`)
Make sure the environment variable `VULKAN_SDK` is properly set.
---
### Build Steps
1. **Clone the Revelation repository**
```bash
git clone --recursive https://github.com/revelationtodo/Revelation.git
```
2. **Add the Vulkan Renderer plugin**
Navigate to the SourceCode directory inside the Revelation project, then clone this repository:
```bash
cd Revelation/SourceCode
git clone https://github.com/revelationtodo/Revelation.Plugin.VulkanRenderer.git VulkanRenderer
```
3. **Merge vcpkg dependencies**
Some dependencies defined in:
```bash
VulkanRenderer/vcpkg.json
```
may not yet exist in the main project configuration.
Please manually copy any **missing dependency entries** into:
```bash
Revelation/SourceCode/vcpkg.json
```
5. **Build Revelation**
Follow the build instructions provided in the main Revelation repository:
https://github.com/revelationtodo/Revelation
6. **Build and Run**
After completing the engine setup:
- Build the project
- Launch Revelation.exe
- Switch to the renderer page
- Verify that the Vulkan Renderer plugin is correctly loaded