在 Windows 上创建项目

使用本教程中的说明为 Windows 主机平台创建 O3DE 项目。您可以在与 O3DE 根目录相同的目录中或在此目录之外创建项目目录。本文档将后者称为 “外部项目”。

先决条件

以下说明假定您已：

满足 O3DE 系统要求中列出的所有硬件和软件要求。
在您的计算机上设置 O3DE。有关帮助，请参阅设置 Open 3D 引擎。
在 O3DE 清单中注册 O3DE 引擎。如果您从 GitHub 设置 O3DE，则必须手动注册引擎。如需帮助，请参阅注册引擎。

创建一个新的 O3DE 项目

要基于标准模板启动项目，请完成以下步骤。

打开命令行窗口，然后通过执行以下操作之一切换到 O3DE 引擎目录：
- 如果你将引擎设置为源引擎，请使用 engine 源目录。例：
```
cd C:\o3de
```
- 如果您安装了 O3DE 或使用INSTALL目标将引擎构建为 SDK 引擎，请使用已安装的引擎目录。例：
```
cd C:\o3de-install
```
要创建一个新项目，请使用scripts子目录中的o3de脚本和create-project命令。使用--project-path参数提供要创建新项目的目录的绝对或相对路径。路径的最后一个组件将成为项目名称，除非你用--project-name参数覆盖它。该脚本将使用 standard 模板（默认项目模板）创建一个新项目。例：
```
scripts\o3de.bat create-project --project-path %USERPROFILE%\O3DE\Projects\MyProject
```
在创建项目时，此命令还会进行两个重要的注册：
- 它通过使用引擎的注册名称在项目的 project.json 清单中注册引擎，将您的项目与引擎相关联。您可以在项目的根目录中找到此清单。名为 o3de 的引擎的注册类似于以下示例：
```
"engine": "o3de",
```
  注意:
  如果你更改了引擎的注册名称，或者希望在项目中使用不同的引擎，则需要更新此清单条目。
- 它在 O3DE 清单中注册项目，将其添加到已知项目列表中，并让 Project Manager 知道您的项目。O3DE 清单位于<USER_DIRECTORY>/.o3de/o3de_manifest.json中。位于C:\Users\MyUsername\O3DE\Projects\MyProject中的项目注册类似于以下示例：
```
"projects": [
    "C:/Users/MyUsername/O3DE/Projects/MyProject"
],
```
  注意:
  如果移动项目，则需要更新此清单条目。

创建 Visual Studio 项目

使用 CMake 为您的 O3DE 项目创建 Visual Studio 项目。

在新项目目录中创建 Visual Studio 项目。提供生成目录、项目源目录、Visual Studio 生成器和任何其他项目选项。路径可以是绝对路径，也可以是相对路径。例：
```
cd %USERPROFILE%\O3DE\Projects\MyProject
cmake -B build/windows -S . -G "Visual Studio 16"
```
注意:
使用Visual Studio 16作为 Visual Studio 2019 的生成器，使用Visual Studio 17作为 Visual Studio 2022 的生成器。有关每个受支持平台的常用生成器的完整列表，请参阅用户指南中的配置项目。
注意:
CMake 使用 O3DE 清单中定义的可下载包目录default_third_party_folder。您可以通过包含 -DLY_3RDPARTY_PATH 参数来指定要使用的其他目录。例如，如果您在 C:\o3de-packages中创建了包目录，请包含参数 -DLY_3RDPARTY_PATH=C:\o3de-packages。
指定 packages 目录的路径时，不要使用尾部斜杠。
注意:
CMake unity builds 默认处于开启状态。这是一项 CMake 功能，可以通过将源文件合并为单个编译单元来大大缩短构建时间。如果遇到构建错误，禁用 Unity 构建可能有助于调试问题。要禁用 Unity 构建，请运行前面的带有 -DLY_UNITY_BUILD=OFF 参数的 cmake 命令来重新生成项目文件。

构建 O3DE 项目

使用 CMake 在 O3DE 项目的 build 目录中构建 Visual Studio 项目。

使用您在项目的build/windows目录中创建的解决方案构建项目启动器。以下示例显示了 profile 生成配置。
```
cmake --build build/windows --target MyProject.GameLauncher Editor --config profile -- -m
```
重要:
在为预构建的 SDK 引擎构建项目时，即使您没有构建 O3DE 编辑器，我们仍然强烈建议将Editor作为构建目标。虽然 GameLauncher 不依赖于 Editor 目标，但某些 Gem 依赖于 Editor。如果您关闭 Editor 目标，则这些 Gem 不会包含在构建中。
在为源引擎构建项目时，您还需要构建 Asset Processor 和 Project Manager，因为它们是 O3DE Editor 的依赖项。
-m是推荐的构建工具优化。它告诉 Microsoft 编译器（MSVC）在编译期间使用多个线程以加快构建时间。
构建完成后，您可以在项目目录的build/windows/bin/profile下找到项目二进制文件。要验证项目是否已准备就绪，请通过执行以下操作之一来运行 O3DE Editor：
- 如果您将引擎设置为源引擎，请从项目构建目录运行 Editor。
```
build\windows\bin\profile\Editor.exe
```
  注意:
  如果您的项目构建目录在项目路径之外，则必须在启动 O3DE Editor 时包含项目路径（使用 --project-path 参数）。
- 如果您安装了 O3DE 或使用INSTALL目标将引擎构建为 SDK 引擎，请从已安装引擎的构建目录运行 Editor。（如果您未提供项目路径，则 Project Manager 将启动。项目路径可以是绝对路径，也可以是相对于 engine 目录的路径。
```
C:\o3de-install\bin\Windows\profile\Default\Editor.exe --project-path %USERPROFILE%\O3DE\Projects\MyProject
```
  重要:
  如果您使用 INSTALL 目标从源代码构建引擎，请确保从已安装引擎的构建目录（而不是引擎的构建目录）启动 Editor 和其他工具。Windows 安装目录通常以 /bin/Windows/profile/Default结尾。

您还可以从同一目录运行 Project Manager (o3de.exe) 来编辑项目的设置、在项目中添加或删除 Gem、重新构建项目以及启动 Editor。

警告:
当您启动 Editor 时，同一目录中的 Asset Processor 也将启动。要从其他目录启动 Editor，您必须关闭正在运行的所有 Asset Processor 任务。

有关项目配置和构建的更多信息，请参阅用户指南的项目配置和构建部分。