Android 对 Open 3D Engine （O3DE） 的支持

适用于 Android 的 Open 3D Engine （O3DE） 项目依靠 Gradle 构建系统来构建启动和运行 O3DE 项目的最终 APK。O3DE 提供 Android 项目生成脚本，该脚本生成构建 Android 版 O3DE 项目所需的 Gradle 构建脚本。Gradle 构建脚本使用 CMake 编译原生 C++ 代码，使用 Java 编译和构建 Android 应用程序，并将构建和打包最终的 APK 和项目资产。

必备软件和软件包

Android SDK

Android SDK 包含为 O3DE 项目构建 Android 应用程序所需的 Android 库、程序包、NDK 和其他工具。

您可以使用 Android Studio 设置和配置 Android SDK， Android Studio 是 Gradle 常用的 IDE，用于开发和构建 Android 应用程序。首次启动 Android Studio 时，请按照步骤下载并安装至少一个 SDK 平台。您还可以从 Android Studio 中设置和配置其他 SDK。设置 Android Studio 后，您可以通过选择 Tools > SDK Manager 或选择工具栏中的 SDK Manager 图标来找到 Android SDK 主页。您可以在 Android SDK Location 下找到该位置。

或者，您可以下载 Android SDK 仅限命令行工具 包，而无需安装 Android Studio。命令行工具包的安装位置将决定 Android SDK Home 的位置。请参阅 SDK Manager 说明 了解安装套件的位置。

确定 Android SDK 位置后，需要在 Android 配置设置中进行设置 ‘sdk.root’

注意:

为了使生成脚本自动下载所需的包，您必须接受代表这些包的许可协议。这可以通过 Android Studio 或通过带有--licenses参数的sdkmanager命令行工具来完成。

Java Development Kit (JDK)

Android SDK 命令行工具需要 Java 开发工具包 （JDK） 来编译项目的 Android Java 源代码，并创建用于对 APK 进行签名的 Java 密钥存储 （JKS） 文件。Android 所需的 JDK 版本取决于 Android SDK 要求 。JDK 安装位置必须在 JAVA_HOME 环境变量中设置，或者 JDK 可执行文件的位置必须在 PATH 环境中。

注意:

Java 开发工具包 的版本必须与 SDK 管理器 兼容。但是，如果您希望指定旧版本的 Android Gradle 插件，则用于运行 Gradle 构建的 JDK 版本可能会有所不同，并且可能需要设置JAVA_HOME环境以匹配旧版本的 SDK，以便成功构建 APK。

Gradle 和 Android Gradle 插件

Gradle 是旨在构建和创建 Android 应用程序的构建系统。 Android Gradle Plugin 向 Gradle 构建系统添加了支持 Android 构建的功能。当前的 Android 项目生成脚本 支持 Android Gradle 插件 版本 8.1 或更高版本，而这反过来又需要 Gradle 版本 8.1 或更高版本。必须通过以下三种方式中的至少一种方式设置 Gradle 安装的位置，以便用户能够发现它：

注意:

支持旧版本（4.2.0 或更高版本）的 Android Gradle 插件，但不建议这样做。

1. Android 配置设置gradle.home
2. 在 GRADLE_HOME 环境变量中设置。
3. gradle 可执行脚本的位置位于 PATH 环境中。

CMake

CMake (version 3.22.0 or newer) 是 O3DE 用于所有本机 C++ 构建的项目生成器，无论平台如何。与 Gradle 的可发现性要求一样，CMake 安装的位置必须至少通过以下三种方式之一进行设置：

1. Android 配置设置 cmake.home
2. 在 CMAKE_HOME 环境变量中设置。
3. cmake 可执行脚本的位置位于 PATH 环境中。

Ninja 构建系统

CMake 使用 Ninja 构建系统为 O3DE 项目构建底层原生 C++ 代码。必须在 PATH 环境中设置 Ninja。

配置环境

Android 项目生成脚本需要使用用户指定的设置和必备软件的位置进行配置，以便生成 O3DE Android Gradle 脚本。Android 设置使用 O3DE 命令行 中的android-configure命令进行管理。

以下是可配置的 android 设置列表。

APK 签名

所有 APK 都必须经过 数字签名 才能安装到 Android 设备上。这是通过在 Android Project Gradle 脚本中提供签名配置来完成的。此签名配置适用于调试开发环境，在设计上不安全。您可以通过 Android Studio 生成签名配置密钥存储、签名密钥和证书。您还可以使用 JDK keytool 命令从命令行创建密钥存储。

（有关 APK 签名以及如何创建密钥库、密钥和证书的更多详细信息，请参见 此处 . )

在创建 Android 项目 Gradle 脚本期间，如果设置了任何 signconfig.* 值，则生成过程将尝试使用以下值嵌入签名配置信息：

• Key Store File

  包含签名密钥和证书的密钥存储文件。 ( --signconfig-store-file/signconfig.store.file)

• Signing Key Alias

  密钥存储文件中签名密钥的别名。( --signconfig-key-alias/signconfig.key.alias)

• Key Store Password

  密钥存储文件的密码。(signconfig.store.password)

• Signing Key Password

  执行签名操作所需的签名密钥的密码。(signconfig.key.password)

注意:

您不能通过android-configure 或 android-generate命令传入这两个密码中的任何一个。当您运行android-generate但缺少任何签名密码时，该命令将显示标准密码集并确认输入以嵌入生成的项目。如果您想设置将用于签名配置的密码而不提示输入密码，则需要使用参数--set-password SETTING调用 android-configure，其中 SETTING是 signconfig.store.password 或 signconfig.key.password。这将显示相同的标准密码集和确认提示，但会将其存储在 android 设置中，以便将来调用android-generate。

Android 资产

在生成 O3DE Android 项目之前，必须处理 Android 的资产。您可以通过在项目中使用 O3DE 编辑器 和 Asset Processor（或 Asset Processor Batch）来执行此操作。

特别是对于 Android，您必须配置注册表设置值，以便 Asset Processor 可以处理 Android 平台资产。为此，请更新<engine-root>\Registry\AssetProcessorPlatformConfig.setreg文件。

在文件的 Amazon/AssetProcessor/Platforms 中，设置 "android" 标签为 "enabled"。例如：

"Amazon": {
    "AssetProcessor": {
        ...
        "Platforms": {
            //"pc": "enabled",
            "android": "enabled"
            //"ios": "enabled",
            //"mac": "enabled",
            //"server": "enabled"
         }
    ...
}

启动 Asset Processor Batch 时，您必须传入--platforms=android 参数。请参阅 在 Windows 上生成 Android 项目 中的步骤 3。

处理完 Android 的资产后，您可以继续生成 Android 项目。

旧版 Android 项目生成脚本

原始的 android 生成脚本仍然可以在 <engine-root>/cmake/Tools/Platform/Android/generate_android_project.py中找到，但仅支持 Android Gradle Plugn 版本 4.x。

generate_android_project.py 脚本包含以下参数：

Android 部署脚本

在 <engine-root>/cmake/Tools/Platform/Android/deploy_android.py中找到用于部署 Android 项目的脚本。

deploy_android.py 脚本 包含以下参数：

其他主题

• 在 Windows 上生成 Android 项目