SirEngineThe3rd 开源项目使用说明

SirEngineThe3rd 开源项目使用说明

SirEngineThe3rd A dx12/Vk game engine (kind of). 项目地址: https://gitcode.com/gh_mirrors/si/SirEngineThe3rd

1. 项目目录结构及介绍

SirEngineThe3rd 是一个基于 DirectX 12 和 Vulkan 的游戏引擎的开源项目。以下是项目的目录结构及其简单介绍：

• builtDependencies：存放预编译的依赖库文件。
• cmake：包含 CMake 构建脚本和配置文件。
• data：存放引擎运行所需的数据文件，如纹理、模型等。
• docs：可能包含项目的文档和说明。
• editor：包含引擎的编辑器代码。
• eng：包含引擎的核心代码。
• external：存放外部依赖库的源代码或链接。
• giordi91：可能是贡献者的个人目录。
• license：存放项目许可证文件。
• partners：可能包含合作伙伴或赞助者的信息。
• README.md：项目的说明文件。
• tests：包含对引擎的测试代码。
• tools：包含项目开发中使用的工具。
• vendors：存放第三方库的源代码或链接。
• .gitattributes：定义 Git 仓库的属性。
• .gitignore：定义 Git 忽略的文件。
• .gitmodules：定义 Git 子模块。

2. 项目的启动文件介绍

项目的启动文件主要包括以下几个：

• ciSetup.ps1：一个 PowerShell 脚本，可能用于持续集成环境的设置。
• vk_layer_settings.txt：配置 Vulkan 层的设置文件。

要启动项目，通常需要在项目根目录下创建一个 build 文件夹，并使用 CMake 来生成构建系统，然后编译。例如：

mkdir build && cd build
cmake ..
cmake --build .

对于运行示例场景，可能需要下载预编译的资源文件，并将其放置在正确的位置。

3. 项目的配置文件介绍

项目的配置文件主要包括 CMakeLists.txt 文件，它定义了如何构建项目：

• CMakeLists.txt：这是 CMake 的主配置文件，定义了项目的名称、版本、依赖关系、构建选项等。

在 CMakeLists.txt 文件中，你可以配置编译选项，如是否启用调试模式、是否构建 Vulkan 支持等。以下是一个简化的配置示例：

cmake_minimum_required(VERSION 3.10)
project(SirEngineThe3rd)

set(CMAKE_CXX_STANDARD 14)

# 设置编译类型
set(CMAKE_BUILD_TYPE Debug)

# 查找依赖
find_package(Vulkan REQUIRED)

# 添加子目录
add_subdirectory(eng)
add_subdirectory(editor)
# ... 其他子目录

# 定义项目目标
add_executable(my_engine editor/main.cpp)
target_link_libraries(my_engine eng)

# ... 其他配置

这个文件是定制和配置项目的核心，通过修改它，你可以控制项目的构建过程。

SirEngineThe3rd A dx12/Vk game engine (kind of). 项目地址: https://gitcode.com/gh_mirrors/si/SirEngineThe3rd