benaclejames / benaclejames/VRCFaceTracking

[Feature Request] Add eye and face calibration option to UI

Open
#144 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
C#
Stars
907
Forks
135
Avg merge
11h 28m
Merged PRs (30d)
7

Description

I am currently developing the VRCFT v5 Pimax Module, and as part of the module's usage users need to calibrate their eye tracking. This was historically done by either entering a character on a keyboard, or toggling a parameter on their avatar `CalibrateEyeTracking` and `CalibrateFaceTracking`.

# Proposition
This is a draft, feedback is welcome.

## UI Integration

I believe the calibration button(s) should go here, to the left of "Toggle Tracking"

![image](https://user-images.githubusercontent.com/51272212/236880929-2f375ac7-fe6d-4bd8-aa4f-2d5e76792bfa.png)

## Module Integration

For module developers to opt into calibration, they can define a function that can be called when said button(s) are pressed. This is similar to how to `Update` function already works. This (should) need(s) a place in OSCMain, ExtTrackingModule, and the respective module loaders.

`OSCMain`

![image](https://user-images.githubusercontent.com/51272212/236882459-04cb40b0-8a77-46ff-9178-69d11e800bf4.png)

## Remark - OSC Integration

So this system is compatible with VRChat, I propose the `"/avatar/parameters/CalibrateEyeTracking"` and `"/avatar/parameters/CalibrateFaceTracking"` be added to `OSCMain`'s switch function, next to the `/avatar/change` block.

![image](https://user-images.githubusercontent.com/51272212/236882107-dd5a5468-c836-4a5a-b036-f8914cf9a14f.png)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.