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.
System requirements
To use Vive SRanipal SDK plugin, the following minimum software and hardware requirements should be met:
- Software requirements
- Windows 8.1 or later (64-bit)
- Unity 5.5.3 or later
- SteamVR (October 14 release or later)
- SR_Runtime 0.8.0.0 or later
- Hardware requirements
- Vive HMD with Lip capability
Limitations
- Support Windows 64-bit only
SDK Folder Structure
- SRanipal_
version
\
- SRanipal_SDK_Guide.pdf
- 00_Runtime\
- 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
- 03_Unreal\
- Document\
- Getting Started with SRanipal in Unreal.pdf
- Document_Unreal.lnk (SRanipal Unreal API reference)
- Vive-SRanipal-Unreal-Plugin.zip
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
- Ensure that Vive HMD is connected to your PC.
- Launch SR_Runtime and wait until the SRanipal status icon appears in the notification tray — see the image below.
- The status icon reflects the status of your tracking devices:
- Start SteamVR (If not running already)
- Put on your HMD.
- Done! You are ready to develop or use lip-aware applications
- 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
- Open the sample code in C
\01_C\SRanipal\SRanipal_Sample.sln
with Visual Studio 2015 above.
- Refer to
\01_\C\Documnet_C.html
for detail API usage.
Builde the Unity Plugin
- Open unity and create a new 3D project.
- Select Asset > Import Package > Custom Package.
- Select the Vive-SRanipal-Unity-Plugin.unitypackage
- In the Importing Package dialog, ensure that all package options are selected and click on Import.
- Accept any API upgrades if prompted.
Opening a sample scene
- In the Unity Project window, find the scene file Sample.unity in Asset > ViveSR > Scenes.
- Ensure that all Requirements are met and then click Play.
- For details about this sample, refer to \02_Unity Started with SRanipal in Unity.docx.
- For details about this API, refer to \02_Unity\Document_Unity.lnk.
Known Issues
- If your HMD requires a firmware update, the below window will pop up. During the process, all lip-relative applications are disabled.
- After the firmware update, the below notification will show up. Reboot the SR_Runtime.exe to use lip-relative functions.