SRanipal C SDK  1.3.2.0
SRanipal C SDK document
Getting Started with SRanipal C SDK

About the Vive SRAnipal SDK

The Vive SRanipal SDK is developed to help software developers create a lip-aware application with actual facial expressions on make-believe 3D avatars. anipal stands for animation pal.

struct.png

System requirements

To use Vive SRanipal SDK plugin, the following minimum software and hardware requirements should be met:

Limitations

SDK Folder Structure

How to Use SR_Runtime

Installation

To enable lip tracking capability, you must download SR_Runtime installer from this link: https://dl.vive.com/SRSDK/runtime/VIVE_SRanipalInstaller.msi. Follow the installer’s instruction to install SR_Runtime.

SR_Runtime Usage

  1. Ensure that Vive HMD is connected to your PC.
  2. Launch SR_Runtime and wait until the SRanipal status icon appears in the notification tray — see the image below.
    systray.png
    • The status icon reflects the status of your tracking devices:
      IconStatusLip.png
  3. Start SteamVR (If not running already)
  4. Put on your HMD.
  5. Done! You are ready to develop or use lip-aware applications
  6. If you want to quit SR_Runtime.exe, right-click on the status icon and click Quit to stop SR_Runtime.

Build C Sample Code

  1. Open the sample code in C \01_C\SRanipal\SRanipal_Sample.sln with Visual Studio 2015 above.
  2. Refer to \01_\C\Documnet_C.html for detail API usage.

Builde 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
  4. In the Importing Package dialog, ensure that all package options are selected and click on Import.
  5. Accept any API upgrades if prompted.

Opening a sample scene

  1. In the Unity Project window, find the scene file Sample.unity in Asset > ViveSR > Scenes.
    OpenSample.png
  2. Ensure that all Requirements are met and then click Play.
  3. For details about this sample, refer to \02_Unity Started with SRanipal in Unity.docx.
  4. For details about this API, refer to \02_Unity\Document_Unity.lnk.

Known Issues