diff --git a/.vscode/spellright.dict b/.vscode/spellright.dict new file mode 100644 index 00000000..7e4adae9 --- /dev/null +++ b/.vscode/spellright.dict @@ -0,0 +1,3 @@ +Pimax +pimax +Tobii diff --git a/docs/hardware/pimax.mdx b/docs/hardware/Pimax/droolon-pi-1.mdx similarity index 93% rename from docs/hardware/pimax.mdx rename to docs/hardware/Pimax/droolon-pi-1.mdx index 822be359..7fbfa71e 100644 --- a/docs/hardware/pimax.mdx +++ b/docs/hardware/Pimax/droolon-pi-1.mdx @@ -1,4 +1,4 @@ -# Pimax +# Droolon Pi 1 ## Summary @@ -10,7 +10,7 @@ Pimax offers an eye-tracking add-on accessory, the [Droolon Pi 1](https://pimax- margin: 'auto', display: 'block' }}> - droolon + droolon ## Set-up @@ -44,7 +44,7 @@ To use your Pimax's eye tracking with VRChat, you will need to use the [VRCFTPim margin: 'auto', display: 'block' }}> - pimax install + pimax install The VRCFTPimaxModule is compatible with the following hardware: diff --git a/docs/hardware/Pimax/pimax-crystal.mdx b/docs/hardware/Pimax/pimax-crystal.mdx new file mode 100644 index 00000000..797143ae --- /dev/null +++ b/docs/hardware/Pimax/pimax-crystal.mdx @@ -0,0 +1,58 @@ +# Pimax Crystal + +:::note +This guide assumes you have [PimaxPlay](https://pimax.com/download-pcvr-crystal/) installed alongside SteamVR. +If you do not have [PimaxPlay](https://pimax.com/download-pcvr-crystal/) +installed, please install it before continuing. +::: + +## Summary + +Unlike other Pimax HMD's, the Pimax Crystal requires a different setup. This guide will show you how to set up your Pimax Crystal for VRCFaceTracking. + +
+ crystal +
+ +### Requirements +- [PimaxPlay](https://pimax.com/download-pcvr-crystal/) +- [EyeTrackVR **Beta**](https://github.com/EyeTrackVR/EyeTrackVR/releases) +- [VRCFT-Tobii-Advanced Module](https://github.com/ghostiam/VRCFT-Tobii-Advanced/releases) +- [BrokenEye](https://github.com/ghostiam/BrokenEye/releases) + +:::warning +You ***MUST*** download the **Beta** version of EyeTrackVR! At the time of writing this, the stable version(s) does not have eye openness. +::: + +## Set-up + +### Installation +Create a folder on your desktop to store all of the files you will be downloading. This will make it easier to find them later. + +#### 1) Install and configure [PimaxPlay](https://pimax.com/download-pcvr-crystal/) +First, open PimaxPlay and go to the settings tab. Ensure that the eye tracking option is enabled in the device settings, and perform an eye-tracking calibration. + +#### 2) Install and configure [EyeTrackVR Beta](https://github.com/EyeTrackVR/EyeTrackVR/releases) +Download the latest beta launcher and install it. Run the application to ensure it is working. If it is, close it and continue to the next step. + +#### 3) Install and configure the [VRCFT-Tobii-Advanced Module](https://github.com/ghostiam/VRCFT-Tobii-Advanced/releases) +Launch VRCFaceTracking, and from the Modules tab, click the "Install from package" button at the top, and select the VRCFT-Tobii-Advanced Module. Upon relaunch of the application, you should see a new module called "Tobii Advanced" being loaded. + +#### 4) Install and configure [BrokenEye](https://github.com/ghostiam/BrokenEye/releases) +Download the latest release and place it in your folder. Run this and follow the [instructions there](https://github.com/ghostiam/BrokenEye/blob/main/README.md). + +#### 5) All together now! +Now that you have all of the required software installed, it's time to put it all together. First, launch PimaxPlay and SteamVR. Once SteamVR is running, launch BrokenEye followed by EyeTrackVR (Beta!). Then, launch VRCFaceTracking. If you see your eye preview in BrokenEye and EyeTrackVR (Beta!), you're finished! + +:::info +Some users have observed EyeTrackVR using a lot of their CPU. On newer Intel CPUs, this can be mitigated by disabling e-Cores in the BIOS. If you are unsure how to do this, please consult your motherboard's manual, or consult the internet. +::: + +## Uninstalling The VRCFT-Tobii-Advanced Module + +To uninstall The VRCFT-Tobii-Advanced Module, go to the Module Registry, select the VRCFT-Tobii-Advanced Module and at the bottom click the uninstall button. \ No newline at end of file diff --git a/docs/hardware/hardware_tables/_hardware_table_addon.mdx b/docs/hardware/hardware_tables/_hardware_table_addon.mdx index c67b7ac1..ae1368d5 100644 --- a/docs/hardware/hardware_tables/_hardware_table_addon.mdx +++ b/docs/hardware/hardware_tables/_hardware_table_addon.mdx @@ -12,6 +12,10 @@ import Link from '@docusaurus/Link'; HTC VIVE Vive Facial Tracker + + Pimax + Droolon Pi 1 + diff --git a/docs/hardware/hardware_tables/_hardware_table_vr.mdx b/docs/hardware/hardware_tables/_hardware_table_vr.mdx index 085f99cf..6b5a8338 100644 --- a/docs/hardware/hardware_tables/_hardware_table_vr.mdx +++ b/docs/hardware/hardware_tables/_hardware_table_vr.mdx @@ -28,6 +28,10 @@ import Link from '@docusaurus/Link'; Pico Pico 4 Pro / Enterprise + + Pimax + Pimax Crystal + {/* HP Reverb G2 Omnicept diff --git a/docs/hardware/img/pimax/crystal.png b/docs/hardware/img/pimax/crystal.png new file mode 100644 index 00000000..841535b1 Binary files /dev/null and b/docs/hardware/img/pimax/crystal.png differ