Vive Face Tracker Developer Quick Start

Developers can develop applications for the Face Tracker (also known as Lip Tracker) and the Eye Tracker using the same SDK.

Download the SDK and Runtime

Download the SRanipal SDK and Runtime from: https://hub.vive.com/download

The SDK folder structure supports three APIs: Native C, Unity, and UE4.

SDK Folder Structure

• 01 C\
  • Document\Document_C.lnk (C API reference)
  • SRanipal\
  • SRanipal_Sample\
  • SRanipal_Sample.sln
• 02 Unity\
  • Document\
  • Getting Started with SRanipal in Unity.pdf
  • Document_Unity.lnk (SRanipal API reference)
  • Vive-SRanipal-Unity-Plugin.unitypackage
  • Getting Started with SRanipal in Unity.pdf
  • Document_Unity.lnk (SRanipal API reference)
  • Vive-SRanipal-Unity-Plugin.unitypackage
• 03 Unreal\
  • Document\
  • Getting Started with SRanipal in Unreal.pdf
  • Document_Unreal.lnk (SRanipal Unreal API reference)
  • Vive-SRanipal-Unreal-Plugin.zip

Install and Run the SRanipal Runtime

1. Launch SR_Runtime. The status icon will appear in the notification tray.
2. Status Icon Meanings:
   • Icon 1: SR runtime is launched but HMD does not support face tracking.
   • Icon 2: The face tracking device is in idle mode.
   • Icon 3: Face tracking is active; a program is retrieving data from it.
3. Start SteamVR (if not running already).
4. Put on your HMD.
5. You are now ready to develop face-aware applications.
6. To quit the runtime, right-click the status icon and select "Quit".

Developing with the Unity Plugin

1. Open Unity and create a new 3D project.
2. Select Asset > Import Package > Custom Package.
3. Select the Vive-SRanipal-Unity-Plugin.unitypackage file.
4. In the Importing Package dialog, ensure all package options are selected and click "Import".
5. Accept any API upgrades if prompted.

Opening a Sample Scene

1. In the Unity Project window, navigate to Asset > ViveSR > Scenes and find the Sample.unity scene file.
2. Click "Play".
3. For detailed information about this sample, refer to: $(SRANIPAL)\02_Unity\Plugin\Getting Started with SRanipal in Unity.docx
4. For API details, refer to: $(SRANIPAL)\02_Unity\Document_Unity.lnk

Developer Forum

Visit the developer forum for support: https://forum.vive.com/forum/78-vive-eye-tracking-sdk/