Interhaptics Unreal SDK

Getting Started

The Interhaptics SDK is a powerful tool for developers who want to add haptic feedback to their applications. This guide provides step-by-step instructions on how to integrate the Interhaptics SDK into your Unreal Engine project (versions between 4.26 – 5.3) by providing a basic integration example.

Prerequisites

To proceed with the integration process, you need to have a basic understanding of Unreal Engine and have it installed on your computer (at least version 4.26). Additionally, you should have the Interhaptics SDK downloaded or cloned from the official repository.
Interhaptics SDK for Unreal is compatibile with major audio middleware for games (WWise, FMod).

Step 1: Add the Interhaptics SDK files

Create a Plugins folder: Navigate to your project folder and create a “Plugins” folder at the root level (YourProject/Plugins). Go inside the Plugins folder and clone the Interhaptics SDK repository, or alternatively download the package from https://github.com/Interhaptics/UnrealEngine_CoreSDK/archive/refs/heads/master.zip and extract it in the Plugins folder.

Step 2: Build the Interhaptics modules

Open your Unreal Engine project, and the engine will prompt you to rebuild the Interhaptics modules included in the plugin. Rebuilding might take more than a few minutes with no prompt or timer showing that, so allow the time for the project to restart before re-opening it.

Step 3: Enable the Interhaptics plugin

Open the Plugins section, and make sure the Interhaptics plugin is enabled under Project > Other.

Step 4: Add the Haptic Manager class

In the Content Browser, go to Settings and select “Show Plugins content.” Then, navigate to Interhaptics C++ class > Interhaptics > Public, and get the Haptic Manager. Drag the Haptic Manager into your viewport.

Step 5: Add a Haptic Source Blueprint

Create a new Blueprint with the Haptic Source type, and use the following features:

General: Assign a Haptic Effect to the object to be played. The Interhaptics Unreal SDK contains already a library of haptic effects which can be found in the package.
Blueprint event graph: Set Targets: allows you to set the targets of the source between Left, Right, Both, or None.
Blueprint event graph: Play: starts all haptic events related to the haptic source.
Blueprint event graph: Stop: stops all haptic events related to the haptic source.

After setting up the Haptic Source Blueprint (compile, test and save), drag it into the viewport and press Play. You can see a basic example of haptic blueprint in the images below.

Step 6: Add New Haptic Effects

To add new haptic effects (.haps files) created with Haptic Composer, you can simply drag and drop the .haps files from your folder to your Unreal project Content Browser.
If you want to add a modified haps file that has been already imported, re-import it under a different name or delete the .uasset file associated with it.

Razer Sensa™ HD Haptics Setup

Enhance your Unity projects with high-definition haptic feedback using the Razer Sensa HD Haptics, supported by Interhaptics Unreal Core SDK version 1.2.0 and above.

Requirements

SDK Support: Verify that your project is using Interhaptics Unreal Core SDK version 1.3.0 or above to have automatically enabled Razer Sensa HD Haptics support. The Interhaptics Core SDK can be installed via the GitHub link as described in the Getting Started with the Unreal SDK chapter.

Compatible Devices

Razer Sensa HD Haptics is compatible with a variety of Razer Sensa HD Haptics devices

Razer Freyja
Razer Kraken v4 Pro
(for selected developers) Razer Sensa HD Haptics devkit.

Driver Requirements

For developers which received the devkit, please follow the setup detailed on the Razer Sensa Devkit Github repo. Skip the install of Razer Synapse 4.

Make sure you have the latest version of the Razer Synapse 4 and Chroma apps for necessary drivers.

Guide

Refer to the standard documentation in the Interhaptics Unity SDK for guidance on adding haptic effects and preparing your project for Nintendo platforms. (Code documentation / No-Code documentation)

XInput SDK

This guide provides step-by-step instructions for setting up custom haptic effects for an GameInput/XInput controller using the Interhaptics Unreal SDK.

To get started, simply repeat the first four steps outlined in the Getting Started chapter. Then, follow these instructions for a no-frills, no-code implementation:

Step 1: Add the Haptic Source blueprint

Create a new Blueprint of the HapticSource type (HapticEffectShoot in this example) and add it to the Viewport. Assign a haptic effect from the library or create your own using Haptic Composer.

Step 2: Modify the Level Blueprint

Open the Level Blueprint and drag the HapticEffectShoot Actor from the Viewport to the Event Graph. Add a Gamepad Event to the HapticEffectShoot Blueprint. In this example, we use the Gamepad Face Button Top (Y button) as the input for the event.

In the Pressed state, stop all present Haptic Sources from playing (a good practice for clear haptic effects). Set the Target on “Both hands” to play on both sides of the controller and execute Play.

In the Released state, you may stop the Haptic Source if desired (optional).

You can view the resulting blueprint in the image below.

If you prefer to use Enhanced Input, you can replace the Gamepad Event with an Enhanced Input action. The example below shows the same haptic effect implementation on the Jump action with the A(XBox controller) button binding.

PS5 Setup

Requirements:

Sony PlayStation Partner: To access the Interhaptics SDK on Sony’s DevNet, you must be a registered Sony PlayStation Partner. If you are not yet a partner, you must first apply and be accepted into the PlayStation Partner Program before you can access the SDK.
Unreal Engine for PlayStation 5 (add-on through Epic Games) – version 4.26 or higher
Note: On Unreal 4.26, add the GetDllExport function to the FSonyPlatformProcess class. For Unreal 4.27 or later this has been already implemented.

The Interhaptics SDK add-on for PlayStation 5 can be accessed through the Tools and Middleware repository on the SIE DevNet. However, there are certain conditions, mentioned above, that must be met before obtaining access to the Interhaptics SDK for PlayStation 5.

Note: At the moment, adaptive trigger support is not available in Unreal Engine.

Step 1: Request Interhaptics PlayStation 5 SDK

Request the PlayStation 5 add-on for the Interhaptics Unreal Engine and Unity SDK through the PS5 DevNet. This will enable you to add haptic effects and build for PlayStation 5.

Once you are granted access to the GitHub private repositories you can go to Step 2 and beyond.

Step 2: Install Interhaptics Core SDK with the PlayStation 5 Add-on

Download the Interhaptics Core SDK with the PS5 Add-on integration or clone it in the Plugins folder of your project from the provided link. https://github.com/Interhaptics/UnrealEngine_PlayStation5_SDK

(You must be logged in with the same email which has been granted the GitHub access, otherwise this link will give you a 404 error).

You should follow the standard installation process described in the Getting Started with Unreal SDK chapter (from Step 2 onward).

Step 3: Add Haptic Effects and Build for PlayStation 5

To add haptic effects (vibrotactile) to your Unreal Engine project, follow the steps described in this section of the documentation. Being cross-platform, the vibration haptic effects added in the XInput example will be rendered as well on the PlayStation 5 platform.

On top of that, PlayStation 5 can benefit from setting haptic effects to its adaptive triggers. This can be done by using the Stiffness perception when creating the haptic effect in Haptic Composer. The stiffness created is the force profile that will be applied to the adaptive trigger. Below you can see a quick implementation using Blueprints in Unreal Engine.

To add custom haptic effects (from audio files or starting from scratch), you can use the videos from the Haptic Composer section as a guide.

For further assistance or support, please refer to the official Interhaptics online documentation and Discord where we will happily provide the answers needed.

Nintendo Switch Setup

Eligibility and Requirements

Nintendo Developer Registration: To access the Interhaptics SDK add-on for Nintendo platforms, registration as a Nintendo Developer is required. If you’re not already registered, you must apply and get approval to join the Nintendo Developer Program.
Unreal: An Unreal Engine 5.1 version or higher is necessary.

Accessing the Interhaptics SDK for Nintendo

The Interhaptics SDK add-on for Nintendo platforms is available through the Nintendo Developer Portal in the section Middleware -> User Interface. Before you can request access to it, ensure you meet the above requirements.

Installation and Integration Steps

Step 1: Request the Interhaptics SDK for Nintendo

Initiate your request for the Interhaptics SDK add-on via the Nintendo Developer Portal. This add-on enables the integration of haptic effects in Unity projects targeted for Nintendo Switch.

Step 2: Install Interhaptics Core SDK

Incorporate the Interhaptics Core SDK into your Unity project. Follow the instructions in the Getting Started with Ureal SDK section of our documentation.
Opt for the current version of the Interhaptics Unreal SDK (at least version 1.1.0 recommended for compatibility).

Step 3: Add the Nintendo Switch Add-on to the Core SDK

Download or clone the Nintendo Unreal SDK add-on via the provided link (note: login with the email associated with your Nintendo Developer account is required to avoid a 404 error).

https://github.com/Interhaptics/UnrealEngine_SwitchSDK

Clone or download this repository into <InterhapticsPluginFolder>/Source. After importation, the folder structure should look like this:

				
					InterhapticsPluginFolder
	Interhaptics.uplugin
	/Source
		/HapticEffect
		/HapticEffectEditor
		/Interhaptics
		/ProviderGameInput
		/SDKSwitchFolder
			/Private
			/Public
			/HAR-libraries
			/IHSwitchBuild.cs

Add the following settings in the Modules list of Interhaptics.uplugin to enable the support of the switch platform for Interhaptics

				
							{
			"Name": "IHSwitch",
			"Type": "Runtime",
			"LoadingPhase": "Default",
			"WhitelistPlatforms": [ "Switch" ]
		}

Step 4: Implementing Haptic Effects and Building for Nintendo Platforms

Refer to the standard documentation in the Interhaptics Unreal SDK for guidance on adding haptic effects and preparing your project for Nintendo platforms. (Getting Started)
Utilize the tutorial in the Haptic Composer section for detailed assistance on creating haptic effects for your game.

Additional Support

For further help or queries, please consult the official Interhaptics online documentation and join our Discord community for tailored support and answers.