开始构建 EToD Engine (易创物理引擎)
必要的运行环境
我们的在开发引擎项目之初,希望使 EToD Engine (易创物理引擎) 尽可能容易构建, 我们目前仅支持使用 Visual Studio 2022 在 Windows 10 和 Windows 11 上构建, 不再支持 Visual Studio 2019。Visual Studio 2022 的最低支持版本为17.2.0,EToD Engine 可能无法在此之前的版本上编译。如果您有任何困难或遇到奇怪的错误,请立即联系我们。 此外您需要安装以下软件:
以下是您构建 EToD Engine 所必须安装的所有第三方工具和 SDK 的列表:
需要特别注意的是,在安装以上所必需的第三方工具和 SDK 时,请务必确保将除过 .NET Framework 这个 SDK 之外的, 所有第三方工具和 SDK 的安装内容添加到操作系统的 PATH 环境变量中。但是在安装的过程中, 很有可能安装程序会让您选择自动将安装内容添加到 PATH 环境变量中, 因此您需要务必留意该安装选项,并确定启用该安装操作。
构建与运行引擎项目
如果您已完成以上工具与 SDK 的安装程序并且调试完毕,您可以继续执行以下操作:
- 将代码库克隆到本地:
git clone --recursive https://github.com/SlaterVanS/EToD
- 运行
Scripts/Setup.bat
- 运行后将下载引擎所需的部分第三方库,并会检查引擎的文件结构,确保引擎文件与所有设置都正确无误 - 打开
ETOD.sln
并设置项目配置为x64
平台下的Debug
或Release
配置方案, EToD-Editor 为默认的启动项目,若您的启动项目不是 EToD-Editor,则需将启动项目手动设置为 EToD-Editor,启动项目设置完成后您可以按下F5
键,去构建和调试启动项目。 默认情况下,EToD-Editor 项目构建完成后的可运行文件您可以在bin/Debug(Release)-windows-x86_64/EToD-Editor/EToD-Editor.exe
中找到它。 - 打开
ETOD.sln
并设置项目配置为Debug
或Release
,您可以在资源管理器中找到Core
文件夹,其中EToD-ScriptCore
项目为引擎的 C# 脚本模块,若您在该模块中添加或修改 C# 文件后,请务必先构建该EToD-ScriptCore
项目后,再运行EToD-Editor
项目,方可对引擎或应用程序进行构建与调试。
.NET Framework
为了易于开发 EToD Engine 使用 C# 作为脚本语言。因此,我们提供了一个 “ EToD-ScriptCore ” 项目,该项目为 EToD Engine 的 C# API 接口。 因此,这意味着为了构建完整的 EToD Engine 工程项目,您需要安装 .NET Framework SDK 工具。EToD Engine 中使用了.NETFramework 4.7.2 版本, 因此在 EToD Engine 中创建的所有项目也需使用该特定版本。
如果您选择使用 Visual Studio IDE 工具来构建 EToD Engine,则需要在 Microsoft 官方下载指定的 Visual Studio 安装程序, 您可选择 Community 等多个适合自己开发规模的 IDE 版本,下载完成后打开 Visual Studio 安装程序, 并确保已从 “ Workloads ” 选项卡中选择了 “ .NET desktop development ” 工作负载,您可以在下图中找到此示例。
安装 Visual Studio 工作负载完成后,可能需要重新启动计算机。
Vulkan
EToD Engine 在引擎图形渲染方向使用 Vulkan 所提供的图形 API 接口,因此您需要安装特定的 Vulkan SDK 1.3.204.1 版本,并将 VULKAN_SDK
环境变量设置为您的安装路径。如果您没有安装正确的 Vulkan 版本,则可使用 scripts/Setup.bat
脚本将会为您下载并安装正确的 Vulkan 版本。
Vulkan SDK 安装程序现在可以为我们下载和安装着色器调试库,如果您想在 Vitual Studio 的调试配置中构建 EToD Engine,
那么您 必须 安装这些调试库。
为此,您需要检查安装程序 Select Components
过程中的 (Optional) Debuggable Shader API Libraries - 64 bit
选项,确保其已被勾选
,就如下图中所示的那样。
如果 scripts/Setup.bat
脚本执行失败,并且您仍需要安装 Vulkan SDK,您可以
点击此处 手动下载与安装 Vulkan SDK 工具。
拉取最新版本代码
代码托管平台中 main
分支需要始终保证程序代码的稳定性, 因此我们保证该分支中 EToD Engine 不会出现任何构建错误或重大程序故障。
在您拉取最新代码后,请记住需要您 再次 运行
Scripts/Setup.bat
脚本,以确保任何所拉取到的新文件或配置更改都可以应用于本地环境。
下一内容
我们需要了解的是 EToD Engine (易创物理引擎) 的组成和其基本架构的概述。