Version:

Icon of a magnifying glass.

IN THIS ARTICLE

将 Gem 注册到项目

Open 3D Engine （O3DE） 包含许多 Gem，用于扩展功能并向项目添加资产。有关完整列表，请参阅 Gem 参考。这些 Gem 已注册到引擎中，并可以添加到项目中。

您还可以从 O3DE 以外的源注册 * 外部* Gem，以便它们也可以在您的项目中使用。注册 Gem 使您的项目能够找到该 Gem。Gem 文件夹可以位于计算机上的任何位置。

注册 Gem 后，您可以启用它以在您的项目中使用。有关启用或禁用 Gem 的说明，请参阅 在项目中添加和删除 Gem。

使用项目管理器

启动 Project Manager，它可以在桌面上找到，如果安装了 O3DE，则可以在bin/{platform}/profile/Default/o3de.exe中找到，如果从源代码构建了 O3DE，则可以在引擎构建目录中找到它。

注册本地 Gem

Tip:
如果要注册的 Gem 是存储库的一部分，则它可能使用 Remote Content 格式（在根文件夹中查找repo.json文件）。在这种情况下，您可以按照 本文档 以一种简单的方式一次注册多个 Gem。

如果本地文件中尚不存在该 Gem，则必须从源下载它。在 GitHub 等网站上托管内容很常见，因此您可以在下面找到有关如何从 GitHub 下载包含 Gem 的存储库的示例。

Download repository

下载文件夹后将其解压缩。

Caution:
一些存储库使用 git lfs 来存储大文件。在这种情况下，你不应该使用下载按钮，因为文件会被省略，而是执行git clone。[在本文档中](/docs/welcome-guide/setup/setup-from-github可以看到类似的设置。当存储库在根目录包含 .gitattributes文件时，它会使用 git lfs。

现在，您已经在本地拥有 Gem 内容，可以使用项目经理来注册它。只需使用 Gems 页面，然后使用正确的汉堡菜单，最后点击 Add Existing Gem。它将打开一个文件对话框，您可以使用该对话框浏览到 gem 文件夹（它应该包含一个gem.json文件）。

Register Gem

如果作成功，您应该会在 Gems （Gems） 选项卡中看到您的 Gem。如果您想在项目中使用您的 Gem，您现在可以继续 阅读本文档。

取消注册本地 Gem

Gems 页面列出了当前注册的所有 Gem。如果您使用左侧的筛选器仅显示 Local Gem，并选择其中一个，那么您应该会在右侧看到一个按钮，用于 Remove Gem。单击此按钮可取消注册 Gem。

Remove Gem

使用命令行界面 （CLI）

注册本地文件夹

要将 Gem 注册到您的项目：

  1. 打开引擎所在文件夹的命令提示符。

  2. 使用以下命令将 Gem 注册到您的项目中。此命令在将 Gem 注册到项目之前验证指定的 Gem 路径是否包含有效的gem.json 配置文件。将 Gem 注册到项目后，Gem 路径将添加到项目的project.json 配置文件的external_subdirectories列表中。

    scripts/o3de register -gp <gem-path> -espp <project-path>

    选项有短记法和长记法，可用于指定 Gem 和项目的路径。

    • -gp, --gem-path: Gem 文件夹的路径（可以是绝对路径或相对路径）。
    • -espp, --external-subdirectory-project-path: 项目文件夹的路径（可以是绝对路径或相对路径）。

取消注册本地文件夹

要从项目中取消注册 Gem，请在用于注册 Gem 的命令中添加--remove选项。这会从项目的 project.json 列表中的external_subdirectories配置文件中删除 Gem 路径。

scripts/o3de register -gp <gem-path> -espp <project-path> --remove