https://github.com/benaclejames/VRCFaceTracking

OSC App to allow VRChat avatars to interact with eye and facial tracking hardware
https://github.com/benaclejames/VRCFaceTracking

eyetracking facetracking vrcft vrchat

Last synced: about 2 months ago
JSON representation

OSC App to allow VRChat avatars to interact with eye and facial tracking hardware

• Host: GitHub
• URL: https://github.com/benaclejames/VRCFaceTracking
• Owner: benaclejames
• License: apache-2.0
• Created: 2020-10-12T00:35:32.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-17T23:29:23.000Z (2 months ago)
• Last Synced: 2024-07-18T02:31:30.822Z (2 months ago)
• Topics: eyetracking, facetracking, vrcft, vrchat
• Language: C#
• Homepage: https://docs.vrcft.io
• Size: 143 MB
• Stars: 572
• Watchers: 21
• Forks: 92
• Open Issues: 44
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-vrchat - VRCFaceTracking - allow AV3 Avatars to interact with Vive SRanipal Eye and Lip Tracking SDK (Tutorials / OSC)

README

        
# 👀 VRCFaceTracking

Provides eye tracking and lip tracking in VRChat by providing a bridge between your tracking hardware and VRChat's OSC server.

## [Get started here!](https://docs.vrcft.io/docs/intro/getting-started)

[![Discord](https://discord.com/api/guilds/849300336128032789/widget.png)](https://discord.gg/Fh4FNehzKn)

## 🎥 Demo

[![](https://i.imgur.com/iQkw12C.jpg)](https://youtu.be/ZTVnh8aaf9U)

## 🛠 Avatar Setup

For this app to work, you'll need to be using an avatar with the correct parameters or an avatar config file with the correct mappings. The system is designed to control your avatar's eyes and lips via simple blend states but what the parameters control is completely up to you.

### [List of Parameters](https://docs.vrcft.io/docs/tutorial-avatars/tutorial-avatars-extras/parameters/)

## 👀 [Eye Parameters](https://docs.vrcft.io/docs/tutorial-avatars/tutorial-avatars-extras/parameters/#eye-tracking-parameters)

### [Eye Tracking Setup Guide](https://github.com/benaclejames/VRCFaceTracking/wiki/Eye-Tracking-Setup)

It's not required to use all of these parameters. In fact, you don't need to use any of them if you intend on using VRChat's built-in eye tracking system. Similar to the setup of parameters with Unity Animation Controllers, these are all case-sensitive and must be copied **EXACTLY** as shown into your Avatar's base parameters. A typical setup might look something like this:


![](https://i.imgur.com/kfJD1Bl.png)

We strongly encourage you to [consult the docs](https://docs.vrcft.io) for a setup guide and more info as to what each parameter does

## :lips: [Lip and Face Parameters](https://docs.vrcft.io/docs/tutorial-avatars/tutorial-avatars-extras/parameters/#expression-tracking-parameters)

There are a large number of parameters you can use for lip and face tracking. 

### [Combined Lip Parameters](https://docs.vrcft.io/docs/tutorial-avatars/tutorial-avatars-extras/parameters/#addtional-simplified-tracking-parameters) - Combined parameters to group mutually exclusive face shapes.

## ⛓ External Modules

Use the module registry to download addons and add support for your hardware!