Skip to content

Latest commit

 

History

History
87 lines (59 loc) · 3.02 KB

README.md

File metadata and controls

87 lines (59 loc) · 3.02 KB
Raw

Pimax Crystal Advanced Eye Tracking Module for VRCFaceTracking

A module for working with Pimax Crystal Eye Tracking in VRCFaceTracking.

Usage

  • Download and install VRCFaceTracking
  • Download the archive with the module from release
  • Run VRCFaceTracking
  • Go to the "Module Registry" tab
  • Click "+ Install Module From .zip"
  • Select the downloaded archive
  • Done!

How to use the "advanced" mode.

Important

You must have a file with a valid license, otherwise the module will not work in "advanced" mode!
Or you can use the workaround: Broken Eye (Pimax Crystal only)

By default, the module is loaded without a license, which allows you to use it to track combined gaze direction and eye opening/closing.

The "Advanced" mode allows you to track the gaze direction for each eye separately, as well as get information about the pupil diameter.

For this, you must have a valid license, in which is indicated

"featureGroup": "professional"

(you can see an example in the file license.example.json)

It needs to be placed in the module folder

C:\Users\<USERNAME>\AppData\Roaming\VRCFaceTracking\CustomLibs\324b3cd5-5e64-4f3f-b056-12340badc0de

# Or paste into the address bar of the explorer to open the folder
%APPDATA%\VRCFaceTracking\CustomLibs\324b3cd5-5e64-4f3f-b056-12340badc0de

under the name license.json

After launching VRCFaceTracking, make sure that the module has loaded your license, it should be in the "Output" tab:

...
[PimaxCrystalAdvanced] Information: Loading license...
[PimaxCrystalAdvanced] Information: Creating device with license.
[PimaxCrystalAdvanced] Information: Connected to platform module with build version "<version>"
[PimaxCrystalAdvanced] Information: Subscribe to advanced data.
...

If instead you see:

[PimaxCrystalAdvanced] Information: No license found in <redacted>

It means the license was not found, check the path and file name.

And if you see:

...
[PimaxCrystalAdvanced] Warning: License validation failed: TOBII_LICENSE_VALIDATION_RESULT_TAMPERED
...

It means you are using an invalid license, check its content.

How to get a license for "advanced" mode.

I don't know

Most likely you can only wait until the manufacturer of the device you are using gets a license from Tobii.

How to use the "advanced" mode without a license.

There is a workaround that will allow you to obtain data on the direction of gaze for each eye separately, the diameter of the pupil, and even receive images from cameras! And all this without a “professional” license!

The software is called Broken Eye and can be downloaded here (currently only works for Pimax Crystal).