VXR 项目安装与使用教程

1. 项目的目录结构及介绍

VXR 项目的目录结构如下：

vxr/
├── assets/
├── deps/
├── examples/
├── include/
├── project/
├── src/
├── tools/
├── LICENSE
└── README.md

目录介绍

• assets/: 存放项目所需的资源文件，如纹理、模型等。
• deps/: 存放项目的第三方依赖库。
• examples/: 包含一些示例项目，展示引擎的功能。
• include/: 存放项目的头文件。
• project/: 包含项目生成解决方案的配置文件。
• src/: 存放项目的源代码。
• tools/: 包含项目生成解决方案的工具。
• LICENSE: 项目的许可证文件。
• README.md: 项目的介绍文件。

2. 项目的启动文件介绍

VXR 项目的启动文件通常位于 src/ 目录下。具体启动文件可能因项目配置而异，但通常会有一个主入口文件，例如 main.cpp。

示例启动文件

// src/main.cpp
#include <vxr/engine.h>

int main() {
    // 初始化引擎
    vxr::Engine engine;
    engine.init();

    // 运行主循环
    engine.run();

    // 关闭引擎
    engine.shutdown();

    return 0;
}

3. 项目的配置文件介绍

VXR 项目的配置文件通常位于 project/ 目录下，使用 genie.lua 脚本来生成项目解决方案。

配置文件示例

-- project/genie.lua

-- 定义项目
makeProject("VXR-Engine")

-- 添加依赖
addDependency("glm")
addDependency("imgui")
addDependency("tinyobjloader")

-- 生成解决方案
solution "VXR-Engine"
    configurations { "Debug", "Release" }
    platforms { "x64" }

    project "VXR-Engine"
        kind "ConsoleApp"
        language "C++"
        targetdir "bin/%{cfg.buildcfg}"

        files { "src/**.cpp", "include/**.h" }

        includedirs { "include", "deps/glm", "deps/imgui" }

        links { "glfw", "glew" }

        filter "configurations:Debug"
            defines { "DEBUG" }
            symbols "On"

        filter "configurations:Release"
            defines { "NDEBUG" }
            optimize "On"

配置文件说明

• makeProject("VXR-Engine"): 定义项目名称。
• addDependency(): 添加项目所需的第三方依赖。
• solution "VXR-Engine": 定义解决方案。
• project "VXR-Engine": 定义项目。
• kind "ConsoleApp": 指定项目类型为控制台应用程序。
• language "C++": 指定项目语言为 C++。
• targetdir "bin/%{cfg.buildcfg}": 指定生成目标目录。
• files { "src/.cpp", "include/.h" }: 指定项目源文件和头文件。
• includedirs { "include", "deps/glm", "deps/imgui" }: 指定包含目录。
• links { "glfw", "glew" }: 指定链接库。
• filter "configurations:Debug": 定义调试配置。
• filter "configurations:Release": 定义发布配置。

通过以上配置文件，可以生成适用于不同平台的项目解决方案，并进行编译和运行。