LittleEngineVk 的安装和配置教程

项目基础介绍

LittleEngineVk 是一个使用 C++20 和 Vulkan 开发的简单 3D 游戏引擎，目前处于开发阶段（WIP）。该项目提供了一个用于渲染和处理游戏场景的基础框架，包括物理渲染、光照效果、模型导入、动画处理等功能。

主要编程语言

• C++
• GLSL（用于着色器编程）

项目使用的关键技术和框架

• Vulkan：用于渲染的底层图形 API。
• C++20：提供了现代的编程特性，如概念、模块等。
• GLFW：用于创建窗口和处理输入。
• glm：一个数学库，用于图形计算。
• Dear ImGui：用于创建和管理用户界面。
• Vulkan Memory Allocator：用于管理 Vulkan 内存。

准备工作

在开始安装和配置 LittleEngineVk 前，请确保您的系统满足以下要求：

1. 操作系统：Windows 10、Linux（X、Wayland，未测试）、Mac OSX（未测试，需要 MoltenVk）。
2. GPU：支持 Vulkan 1.3 及以上版本的 GPU，及其驱动程序和加载器。
3. 编译工具：CMake 3.23+、支持 C++20 的编译器和标准库。
4. 额外工具：glslc（用于编译 GLSL 着色器到 SPIR-V 格式）。

安装步骤

1. 克隆项目仓库 将 LittleEngineVk 项目克隆到本地：

   git clone https://github.com/karnkaul/LittleEngineVk.git
   

2. 创建构建目录 在项目目录外创建一个构建目录，用于存放构建生成的文件：

   mkdir build && cd build
   

3. 配置 CMake 使用 CMake 配置项目，可以选择使用 CMake Presets（如果使用的是 CMake 3.20+ 和 Visual Studio）：

   cmake -S <source_directory> -B <build_directory> -P <preset_name>
   

   如果不使用 Presets，可以使用以下命令：

   cmake -S .. -B .
   

4. 编译项目 编译项目，可以使用以下命令：

   cmake --build .
   

   或者，如果你使用的是 IDE，直接在 IDE 中构建项目。

5. 编译着色器 如果着色器被修改，需要编译它们到 SPIR-V 格式。可以创建一个 CMake 目标来调用 glsl2spirv 工具：

   add_custom_target(compile_shaders ALL CALL glsl2spirv ...)
   

6. 导入模型 如果需要导入 GLTF 模型，可以使用 le-importer 工具来转换模型数据到 LittleEngineVk 的格式。

完成以上步骤后，您应该能够成功编译并运行 LittleEngineVk 项目了。