Skip to content

Unreal Engine

Hercules Unreal Plugin Installation Guide

You can use the Hercules Unreal Plugin by adding the distributed plugin package directly to your project.


1. Install HerculesPlugin

Download the HerculesPlugin package for Unreal Engine from Hercules Module Downloads.

Extract the distributed HerculesPlugin package.

Copy the extracted HerculesPlugin folder to the Plugins folder in your Unreal project.

If the project does not have a Plugins folder, create one.

Example:

<Unreal project path>/
├─ Content/
├─ Plugins/
│  └─ HerculesPlugin/
│     ├─ HerculesPlugin.uplugin
│     ├─ Source/
│     └─ ...
├─ Source/
└─ <project name>.uproject

2. Add the HerculesPlugin Dependency

Add the HerculesPlugin dependency to the Build.cs file of the Unreal module that will use HerculesPlugin functionality, then restart the Unreal Editor.

The Build.cs file is usually located at the following path in your project.

<Unreal project path>/Source/<module name>/<module name>.Build.cs

Add HerculesPlugin to PublicDependencyModuleNames.

PublicDependencyModuleNames.AddRange(new string[]
{
    // Existing module list,
    "HerculesPlugin"
});

If HerculesPlugin is used only within that module, you can also add it to PrivateDependencyModuleNames, depending on your project configuration.

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

3. Use HerculesPlugin

Modules with the HerculesPlugin dependency can use the headers and APIs provided by the plugin.

Include the required HerculesPlugin headers, then use the API.

#include "HerculesPlugin.h"

4. Remove HerculesPlugin

Remove the following dependency from your project's Build.cs file.

"HerculesPlugin"

Then delete the following folder from your project.

<Unreal project path>/Plugins/HerculesPlugin