创建适用于 Windows 的项目游戏发布布局

本教程将指导您完成为 Windows 计算机手动创建 Open 3D Engine （O3DE） 项目游戏发布布局 的过程。项目游戏发布布局是一个目录结构，其中包含 Game Launcher 和在开发人员环境之外运行 Game Launcher 所需的捆绑资产。在构建要发布的项目时，您可以创建一个项目游戏发布布局，称为 发布版本。

注意:

如果您希望从源码使用引擎而不是安装程序，请参考 从 GitHub 设置 O3DE。 此外，您必须使用以项目为中心的配置，这将进一步详细说明 下文。

发布版本需要 捆绑内容，其中包括存储在包 （.pak） 文件中的缓存产品资产。缓存的产品资源位于项目的 Cache\pc 目录中。Game Launcher 加载构成项目的捆绑内容，例如其关卡、对象、环境和游戏逻辑。

此处的说明将指导您完成以下步骤：

1. 设置起始级别。

2. 处理项目的资源。

3. 创建项目游戏发布布局。

4. 捆绑项目的资源。

5. 从项目游戏发布布局运行项目的 Game Launcher。

6. 分发您的构建。

先决条件

以下说明假定您已：

• 在您的计算机上将 O3DE 设置为 源引擎 或 预构建/安装的 SDK 引擎。如需帮助，请参阅 为 Windows 构建.

• 已创建至少包含一个级别的 O3DE 项目。要构建要发布的项目，您可能需要解决项目中的所有错误。

• 为以下任一项生成了 Visual Studio 项目：

  • 您的项目 – 如果您使用的是源引擎，则必须为您的项目生成一个 Visual Studio 项目。有关帮助，请参阅 创建 Visual Studio 项目。

  • 您的引擎 – 如果您使用的是预构建的 SDK 引擎，则必须为您的引擎生成一个 Visual Studio 项目。如需帮助，请参阅 构建 INSTALL 目标中 引擎和项目分发 主题下的第一步.

• 将项目注册到引擎。

教程细节

本教程在示例中使用以下目录。

• 项目名称和目录: C:\MyProject
• 第三方软件包目录: C:\o3de-packages
• 源码版引擎: C:\o3de
• 预构建的 SDK 引擎: C:\o3de-install

设置起始关卡

注意:

如果您在项目的代码库中设置了起始关卡，则此步骤是可选的。开发中更常见的做法是通过关卡管理器或类似系统在项目代码库中设置起始关卡。

先决条件：您必须在项目中至少创建一个关卡。请查看 创建关卡 教程以开始使用。

在创建项目游戏发布布局之前，您的项目必须指定起始关卡，以通知 Game Launcher 应首先加载哪个关卡。您可以在项目的设置注册表(.setreg)中或通过关卡管理器或团队开发的类似系统在项目的代码库中指定起始关卡。

在此示例中，通过在C:\MyProject\Registry目录中创建一个 autoexec.game.setreg 文件，在设置注册表中设置项目的起始关卡。然后，添加以下行。

{
    "O3DE": {
        "Autoexec": {
            "ConsoleCommands": {
                "LoadLevel": "mainmenu"
            }
        }
    }
}

此配置通过将Loadlevel设置为关卡名称来指定起始关卡。在此示例中，关卡资源名为mainmenu。您无需指定关卡资源的文件扩展名，例如 main.prefab 或 main.spawnable。您可以在 C:\MyProject\Levels 目录中找到项目的关卡。

流程资产

使用 Asset Processor 或 Asset Processor Batch 程序将源资源处理为产品资源，Game Launcher 在运行时使用该资源。Asset Processor 提供图形用户界面 （GUI），而 Asset Processor Batch 提供命令行界面 （CLI）。

处理资产的方法

要处理项目的资源，请执行以下操作之一：

• 运行 Asset Processor. 如果您已经构建了 Asset Processor 并且更喜欢使用 GUI，请执行此操作。

  1. 根据您的引擎类型从 build 目录运行 AssetProcessor.exe 。

     • <project>/build/windows/bin/profile – 对于源代码版引擎。
     • <engine>/build/windows/bin/profile – 对于预构建码版引擎。
     
     
     

  2. 等待所有作业完成。您可以在 Asset Status 窗格中查看每个资产的状态，并在 Event Log Details 窗格中查看每个资产的详细信息。

• 运行 Asset Processor Batch. 如果您已经构建了 Asset Processor 并且更喜欢使用 CLI，请执行此操作。

  1. 根据您的引擎类型从 build 目录运行 AssetProcessorBatch.exe 。

     • <project>/build/windows/bin/profile – 对于源代码版引擎。
     • <engine>/build/windows/bin/profile – 对于预构建码版引擎。
     
     
     

  2. 等待所有作业完成。 您可以在 <project>\user\log 目录的AP_Batch.log文件中查看输出。

• 运行你的项目的 Asset Processor 工具。 如果您尚未构建 Asset Processor 和 Asset Processor Batch，请执行此操作。

  1. 使用 CMake 调用 Visual Studio 编译 Asset Processor 工具及其依赖。指定 MyProject.Assets 目标。

     cmake --build build\windows --target MyProject.Assets --config profile -- -m
     

     首先，此命令构建 Asset Processor 工具。然后，它运行 Asset Processor Batch 并处理资产。除非您在项目中进行更改，否则您不需要重新运行 Asset Processor 或 Asset Processor Batch。

  2. 等待所有作业完成。 您可以在 <project>\user\log 目录的AP_Batch.log文件中查看输出。

验证资产是否已成功处理

通过检查资产的状态来验证 Asset Processor 是否已成功处理您的资产。Asset Processor 可以在有或没有警告或错误的情况下处理您的资产，或者它们可能无法处理。警告和错误表明您的资产可能需要您注意，但它们不会妨碍创建项目游戏发布布局的能力。另一方面，解决因故障而未处理的任何资产至关重要。

有关故障故障排除的帮助，请参阅 O3DE 中的打包故障排除。

创建项目游戏发布布局

现在您已经准备好了项目，您可以创建项目游戏发布布局。您可以通过不同的方式执行此操作，具体取决于您设置引擎的方式以及是要创建非整体式还是整体式发布版本。

在设置 O3DE 时，您将引擎构建为 源引擎 或 预构建的 SDK 引擎。您可以使用任一 build 类型来创建项目游戏发布布局。有关构建类型的更多信息，请参阅 构建引擎。

此外，您可以创建非整体或整体的项目游戏发布布局。非整体式构建使用 Gem 作为动态链接的库 （.dll），而整体式构建使用 Gem 作为静态链接的库 （.lib）。在整体构建中将 Gem 用作.lib 文件可以去除未使用的代码段并删除其中的冗余符号。因此，整体式构建的磁盘总空间小于非整体式构建的磁盘总空间。

注意:

整体式构建的最终输出可能包含一些.dll文件。当第三方库仅提供.dll文件时，可能会发生这种情况。

在此步骤中，您将使用 CMake 构建非整体式或整体式项目以进行发布。这将处理多项任务：

1. 创建一个包含项目游戏发布布局的 安装目录。默认情况下，安装目录位于项目的目录中（例如，C:\MyProject\install）。或者，您可以通过在 <project>\build\<build>目录的CMakeCache.txt文件中设置CMAKE_INSTALL_PREFIX来将安装目录设置为其他位置（例如，C:\MyProject\build\windows\CMakeCache.txt）。

2. 通过将<project>\Cache\pc目录中的所有产品资源打包到engine.pak文件中来捆绑你的游戏内容。

3. 在项目游戏发布布局中构建 Game Launcher 和其他支持文件。

• Source engine
• Pre-built SDK engine

cd C:\MyProject
cmake --build build\windows --target install --config release

cd C:\o3de-install
scripts\o3de.bat register --project-path C:\o3de-projects\MyProject

捆绑内容

Asset Bundler 和 Asset Bundler Batch 程序是允许您创建和优化捆绑内容的工具。在之前创建项目游戏发布布局时，将所有资产捆绑到一个engine.pak文件中，该文件包含所有项目和引擎的产品资产。引擎中可能有许多未使用的资产，并且你的项目也可能包含未使用的资产，因此engine.pak文件可能比运行游戏所需的要大得多。要优化捆绑内容，请使用 Asset Bundler 并配置所需的资源捆绑方式。

按照 捆绑项目游戏发布布局的资源 中的说明进行操作。创建两个捆绑包。强烈建议您在捆绑包文件名中添加初始版本号，例如，game_v1.pak用于游戏资产，engine_v1.pak用于引擎资产。如果您添加或更新项目的资源，或者升级引擎，将来可能必须创建 内容补丁包。向 Asset Bundle 添加版本号可简化过程。然后，将捆绑包添加到您的项目游戏版本布局中。

你应该注意到，你的两个捆绑资源加起来都小于你之前创建项目游戏发布布局时自动创建的默认engine.pak。

许可证文件生成

可以在项目开发过程中生成许可证归属文件（通常称为 NOTICES 文件），以正确归属导入的任何代码或可下载包。要扫描项目和包目录以查找许可证，您可以运行位于引擎的 scripts\license_scanner子目录中的脚本。此脚本将查找PackageInfo.json 文件，以便创建带有 SPDX 标签的所有软件包许可证的摘要文件，以便于参考。

有关详细信息，请参阅 引擎和项目分发 中的说明。通常，您会将生成的文件复制到游戏发布布局的根目录，以正确归因您的依赖项。

运行 Game Launcher

现在，您可以运行项目的 Game Launcher 了。

从项目游戏版本布局中运行GameLauncher.exe，该布局位于<install>\bin\Windows\release\<build>目录中。例如，路径可以是：

• C:\MyProject\install\bin\Windows\release\Monolithic – 适用于整体式项目。

• C:\MyProject\install\bin\Windows\release\Default – 对于非整体式项目。

分发发布版本

要将构建版本分发到其他 Windows 计算机，请执行以下操作：

1. 创建<install>\bin\Windows\release\<build>文件夹的 .zip 文件，内容应如下所示：

    Monolithic
    |   DevTestProject.GameLauncher.exe
    |   PhysXDevice64.dll
    |   PhysXGpu_64.dll
    |   
    \---Cache
        \---pc
        engine_v1.pak
   

2. 使用您喜欢的方法（例如文件存储服务）分发.zip文件。

现在，其他人可以下载并解压缩.zip文件，并在他们的 Windows 计算机上运行 Game Launcher。

注意:

要在其他 Windows 计算机上运行游戏启动器，它们必须安装 Microsoft Visual C++ （MSVC） Redistributable 。