VRCFaceTracking Documentation

repository·master·Indexed 21 days ago

https://github.com/benaclejames/vrcfacetracking

A bridge between specialized tracking hardware and VRChat's OSC server that enables advanced eye and lip tracking for avatars. Includes guides on avatar parameter configuration, hardware support via external modules, and project deployment options for MSIX and unpackaged applications.

Tokens
595
Snippets
0
Records
8
Agent score
25%

What's inside VRCFaceTracking

  1. Set up Lip and Face Parameters

    master
    VRCFaceTracking supports a wide variety of parameters for lip and face tracking. This includes individual parameters for specific expressions and Combined Lip Parameters, which are used to group mutually exclusive face shapes to simplify tracking logic. Refer to the Parameter List for the full enumeration of available parameters.
  2. Set up Eye Tracking Parameters

    master

    If you are not using VRChat's built-in eye tracking, you can implement custom eye tracking by adding specific parameters to your avatar's base parameters.

    Important Requirements:

    • Parameters are case-sensitive.
    • They must be copied EXACTLY as specified in the documentation.
    • You do not need to use all parameters; only use those required for your specific setup.

    For detailed instructions on implementing eye tracking, consult the Eye Tracking Setup Guide.

  3. Configure Avatar Setup for VRCFaceTracking

    master
    To use VRCFaceTracking, your avatar must either use the correct parameter names or be accompanied by an avatar configuration file with the correct mappings. The system controls eyes and lips via blend states. While the system provides specific parameter names, the actual blend shapes those parameters control are defined by your avatar setup in Unity.