Skip to content

Installation Guide

To get started with Pulse Core, ensure you have installed the plugin into your project.

Engine Requirements

  • Unreal Engine 5.3+
  • Tested primarily on UE 5.4.

Installation Steps

  1. Close your Unreal Engine project.
  2. Place the PulseCore directory into the Plugins/ folder of your project (e.g., MyProject/Plugins/PulseCore).
    • If the Plugins folder does not exist, create it.
  3. Right-click your .uproject file and select Generate Visual Studio project files.
  4. Open the solution and compile, or simply open the project and let the editor build it automatically.
  5. In the Unreal Editor, navigate to Edit > Plugins, search for Pulse Core, and ensure it is enabled.

C++ Project Setup

If you are writing C++ code and wish to utilize the utilities, you must add the relevant Pulse Core modules to your Build.cs file.

Open YourProject.Build.cs and add the required modules:

csharp
PublicDependencyModuleNames.AddRange(new string[] { 
    "Core", 
    "CoreUObject", 
    "Engine", 
    "InputCore",
    // Pulse Core Modules
    "PulseGameCore", 
    "PulseAbility",
    "PulseHUD"
});
  • PulseGameCore: Contains all the general utility libraries (Math, Strings, Vectors, Fast Noise).
  • PulseAbility: Contains the Interaction System and HUD components.
  • PulseHUD: The base module for the event-driven HUD architecture.

Released under the MIT License.