SRanipal Unreal SDK  1.3.2.0
SRanipal Unreal SDK document
Getting Started with SRanipal SDK in Unity

Prerequisites

The SRanipal SDK for Unreal can be implemented only when the SRanipal runtime has been setup. Use the following guideline to setup the SRanipal SDK — SRanipal_version\SRanipal_SDK_Guide.pdf.

Create a new project and add the SDK

  1. Open Unreal Engine and create a new C++ project.
  2. Unzip the plugins at SRanipal_version\03_Unreal\Vive-SRanipal-Unreal-Plugin.zip
  3. Copy the folder Plugins inside the folder you unzip above into your project.
  4. Restart the editor and enable SRanipal in Settings > Plugins.

Play the sample level

  1. In the Unreal content browser, you can find the sample level in: SRanipal Content/Level/LipSample.
  2. Ensure that all Requirements mentioned in SRanipal_SDK_Guide.pdfare met and then click VR_Preview.

Package the sample app

  1. In Edit > Project Settings choose Maps & Modes
  2. Change the Game Default Map to LipSample.
MapSetting.png
  1. In Edit > Project Settings choose Description (Or you can search vr).
  2. Enable Start in VR.
VrStart.png
  1. Select File > Package Project > Windows > Windows (64-bit).

Enable SRanipal functionality in your Unreal project.

Enable the SRanipal Framework

  1. You can find the actor: SRanipal_Lip_Framework under: SRanipal C++ Classes/SRanipal/Public
  2. Put the framework actor in your level.
  3. Toggle Enable Lip in the actor’s Details Panel to enable the lip-tracking feature of the SRanipal SDK.
  4. Explore the Lip features.
EnableLip.png

Lip relative features

Control Avatar’ lip

To reflect the player’s lip movement on an avatar, refer to the actor SRanipal_AvatarLipSample in SRanipal C++ Classes/SRanipal/Public

LipSample.png