跳转至

Unreal Engine

Hercules Unreal Plugin 安装指南

将分发的插件包直接添加到项目中,即可使用 Hercules Unreal Plugin。


1. 安装 HerculesPlugin

从 Hercules 模块下载下载适用于 Unreal Engine 的 HerculesPlugin 包。

解压分发的 HerculesPlugin 包。

将解压后的 HerculesPlugin 文件夹复制到 Unreal 项目的 Plugins 文件夹中。

如果项目中没有 Plugins 文件夹,请新建一个。

示例:

<Unreal 项目路径>/
├─ Content/
├─ Plugins/
│  └─ HerculesPlugin/
│     ├─ HerculesPlugin.uplugin
│     ├─ Source/
│     └─ ...
├─ Source/
└─ <项目名称>.uproject

2. 添加 HerculesPlugin 依赖项

在将使用 HerculesPlugin 功能的 Unreal 模块的 Build.cs 文件中添加 HerculesPlugin 依赖项,然后重启 Unreal Editor。

通常可在项目的以下位置找到 Build.cs 文件。

<Unreal 项目路径>/Source/<模块名称>/<模块名称>.Build.cs

将 HerculesPlugin 添加到 PublicDependencyModuleNames 中。

PublicDependencyModuleNames.AddRange(new string[]
{
    // 现有的模块列表,
    "HerculesPlugin"
});

如果仅在该模块内部使用 HerculesPlugin,也可以根据项目配置,将其添加到 PrivateDependencyModuleNames 中。

PrivateDependencyModuleNames.AddRange(new string[]
{
    "HerculesPlugin"
});

3. 使用 HerculesPlugin

已添加 HerculesPlugin 依赖项的模块,可以使用插件提供的头文件和 API。

包含所需的 HerculesPlugin 头文件后,即可使用 API。

#include "HerculesPlugin.h"

4. 移除 HerculesPlugin

从项目的 Build.cs 文件中移除以下依赖项。

"HerculesPlugin"

然后,删除项目中的以下文件夹。

<Unreal 项目路径>/Plugins/HerculesPlugin