Skip to content

Commit

Permalink
(feat./tweak) Added Pimax Crystal Page, organized Pimax (#51)
Browse files Browse the repository at this point in the history
* (feat./tweak) Added Pimax Crystal Page, organized Pimax

* add Pimax pages to getting-started hardware tables

---------

Co-authored-by: kusomaigo <[email protected]>
  • Loading branch information
dfgHiatus and kusomaigo authored Jan 20, 2024
1 parent 7b1e4c3 commit fe9be59
Show file tree
Hide file tree
Showing 6 changed files with 72 additions and 3 deletions.
3 changes: 3 additions & 0 deletions .vscode/spellright.dict
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Pimax
pimax
Tobii
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Pimax
# Droolon Pi 1

## Summary

Expand All @@ -10,7 +10,7 @@ Pimax offers an eye-tracking add-on accessory, the [Droolon Pi 1](https://pimax-
margin: 'auto',
display: 'block'
}}>
<img src={require("./img/pimax/droolon.png").default} alt="droolon" />
<img src={require("../img/pimax/droolon.png").default} alt="droolon" />
</div>

## Set-up
Expand Down Expand 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'
}}>
<img src={require("./img/pimax/pimax_install.png").default} alt="pimax install" />
<img src={require("../img/pimax/pimax_install.png").default} alt="pimax install" />
</div>

The VRCFTPimaxModule is compatible with the following hardware:
Expand Down
58 changes: 58 additions & 0 deletions docs/hardware/Pimax/pimax-crystal.mdx
Original file line number Diff line number Diff line change
@@ -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.

<div style={{
width: '50%',
height: 'auto',
margin: 'auto',
display: 'block'
}}>
<img src={require("../img/pimax/crystal.png").default} alt="crystal" />
</div>

### 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.
4 changes: 4 additions & 0 deletions docs/hardware/hardware_tables/_hardware_table_addon.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ import Link from '@docusaurus/Link';
<td>HTC VIVE</td>
<td><Link to="../hardware/VIVE/face-tracker" target="_blank" rel="noopener noreferrer">Vive Facial Tracker</Link></td>
</tr>
<tr>
<td>Pimax</td>
<td><Link to="../hardware/Pimax/droolon-pi-1" target="_blank" rel="noopener noreferrer">Droolon Pi 1</Link></td>
</tr>
</tbody>
</table>

Expand Down
4 changes: 4 additions & 0 deletions docs/hardware/hardware_tables/_hardware_table_vr.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ import Link from '@docusaurus/Link';
<td>Pico</td>
<td><Link to="../hardware/pico4pe" target="_blank" rel="noopener noreferrer">Pico 4 Pro / Enterprise</Link></td>
</tr>
<tr>
<td>Pimax</td>
<td><Link to="../hardware/Pimax/pimax-crystal" target="_blank" rel="noopener noreferrer">Pimax Crystal</Link></td>
</tr>
{/* <tr>
<td>HP</td>
<td>Reverb G2 Omnicept</td>
Expand Down
Binary file added docs/hardware/img/pimax/crystal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fe9be59

Please sign in to comment.