Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/hardware/addons/pimax/droolon-pi-1.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# Droolon Pi 1

The [Droolon Pi 1](https://pimax-test.myshopify.com/products/eye-tracking-module) is an eye-tracking add-on accessory for older Pimax headsets.
This accessory is compatible with the Artisan/5K Plus/5K XR/5K Super/8K/8K Plus/8KX headsets.

:::danger
**DISCONTINUED PRODUCT**
:::

Pimax offers an eye-tracking add-on accessory, the [Droolon Pi 1](https://pimax-test.myshopify.com/products/eye-tracking-module). This accessory is compatible with the Artisan/5K Plus/5K XR/5K Super/8K/8K Plus/8KX headsets.

<div style={{
width: '50%',
height: 'auto',
Expand Down
32 changes: 22 additions & 10 deletions docs/hardware/addons/vive/face-tracker.mdx
Original file line number Diff line number Diff line change
@@ -1,15 +1,25 @@
# Vive Facial Tracker

The Vive Facial Tracker provides lower face tracking for [Vive Pro](../../vr/vive/vpe.mdx) and other VR headsets.
It connects to the computer via a short, built-in USB-C cable.
Face tracking data is accessed through [Vive's SRanipal interface](../..//vr/vive/sranipal.mdx).

:::danger
**DISCONTINUED PRODUCT**

The Vive Facial Tracker has officially been discontinued by Vive.
While it can still be used with VRCFT, expect no support for this product from Vive themselves.
:::

The Vive Facial Tracker provides lower face tracking for [Vive Pro](@site/docs/hardware/vr/vive/vpe.mdx) and other VR headsets.
It connects to the computer via a short, built-in USB-C cable.
Face tracking data is accessed through [Vive's SRanipal interface](@site/docs/hardware/vr/vive/sranipal.mdx).
<div style={{
width: '35%',
height: 'auto',
margin: 'auto',
display: 'block'
}}>
<img src={require("./img/face-tracker.png").default} alt="Vive Face Tracker" />
</div>


## Why is this setup required?

Expand All @@ -23,7 +33,7 @@ Install SRanipal first *before* plugging in the Vive Facial Tracker to make your
:::

Regardless of what headset, the Vive Facial Tracker requires the computer that it connects to to have SRanipal runtime installed to be able to be used.
Follow the [SRanipal Setup](@site/docs/hardware/vr/vive/sranipal.mdx#set-up) instructions to get this necessary software installed and ready.
Follow the [SRanipal Setup](../..//vr/vive/sranipal.mdx#set-up) instructions to get this necessary software installed and ready.

## Hardware Setup

Expand All @@ -44,8 +54,9 @@ When it finishes, there should be a little pop-up notification (possibly hidden
you should be able to see a "HTC Multimedia Camera" device instead in Device Manager.

:::info
A shoddy USB connection for the Facial Tracker can lead to it getting stuck trying to update its firmware, never initializing.
If possible, the plug the facial tracker **directly into a USB-C port on your computer** to allow it to update (if it needs to).
A poor USB connection for the Facial Tracker can lead to it getting stuck trying to update its firmware, never initializing.
If possible, the plug the facial tracker **directly into a USB-C port on your computer** to allow it to "update".
The face tracker does not actually need a firmware update, however, disabling firmware auto update in the SRanipal config does not address the fundamental issue of a poor connection and also adds more problems.
:::

### Vive Pro Series
Expand All @@ -70,7 +81,7 @@ Follow the [official Vive Facial Tracker installation instructions](https://www.
The position of the Vive Facial Tracker relative to your lower face is *very important*.
More often than not bad tracking is the result of a bad position/angle of the facial tracker.
Getting a good 3D printed mount is essential for avoiding tracking issues on non-Vive Pro headsets.
Ask around in the #3d-printing channel in the [VRCFT Discord](https://discord.gg/vrcft) if you need help.
Look and ask around in the [VRCFT Discord](https://discord.gg/vrcft) if you need suggestions.

#### Valve Index

Expand All @@ -91,7 +102,8 @@ This is the **#1 reason** for VRCFaceTracking problems with Index users.
- ['Road to Alcoholism' Index Front Plate Vive Facial Tracker Mount (VRCFT Discord)](https://discord.com/channels/849300336128032789/915075185328152606/987813371992748072)

:::info
The Index frunk area can get quite warm, and the USB adapters can get **very hot**, making the headset heat worse. If possible, try to keep the front of the headset actively cooled, and/or add a heatsink to the USB adapter.
The Index frunk area can get quite warm, and the USB adapters can get **very hot**, making the headset heat worse.
If possible, try to keep the front of the headset actively cooled with a fan, and/or add a heatsink to the USB adapter.
:::

#### Other Wired VR Headsets
Expand All @@ -102,10 +114,10 @@ Get a quality **USB 3.0 or better USB** extension. Since USB-C female extensions

Using the headset as a VirtualHere USB server is a possible solution that allows for a fully wireless setup.
VRCFT member `Blackspots#0001` has a nice [reddit post detailing the process](https://www.reddit.com/r/Quest2/comments/xlvbc8/getting_the_vive_face_tracker_to_work_with_the/) for the Quest 2
This proceed *may* work for other similar headsets (Pico 3, Pico 4, etc.) but have not been tested.
This proceed *may* work for other similar headsets (Pico 3, Pico 4, etc.).

## Module

Install the **"SRanipalTrackingModule"** from the [VRCFaceTracking Module Registry](@site/docs/vrcft-software/vrcft.mdx#module-registry).
Install the **"SRanipalTrackingModule"** from the [VRCFaceTracking Module Registry](../../..//vrcft-software/vrcft.mdx#module-registry).

[SRanipalTrackingModule source repository](https://github.com/VRCFaceTracking/SRanipalTrackingModule)
2 changes: 1 addition & 1 deletion docs/hardware/vr/pico/pico4pe.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Streaming Assistant is only available for Headsets using firmaware older than 5.

## Module

Install the **"Pico4SAFTExtTrackingModule"** from the [VRCFaceTracking Module Registry](@site/docs/vrcft-software/vrcft.mdx#module-registry).
Install the **"Pico4SAFTExtTrackingModule"** from the [VRCFaceTracking Module Registry](../../../vrcft-software/vrcft.mdx#module-registry).

[Pico4SAFTExtTrackingModule source repository](https://github.com/regzo2/PicoStreamingAssistantFTUDP/tree/vrcfacetracking-module)

Expand Down
Binary file added docs/hardware/vr/vive/img/sranipal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/hardware/vr/vive/img/vpe.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/hardware/vr/vive/img/wireless.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/hardware/vr/vive/vpe.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Eye tracking data is accessed through [Vive's SRanipal interface](./sranipal.mdx

## Module

Install the **"SRanipalTrackingModule"** from the VRCFaceTracking Module Registry](@site/docs/vrcft-software/vrcft-software/vrcft.mdx#module-registry).
Install the **"SRanipalTrackingModule"** from the [VRCFaceTracking Module Registry](../../../vrcft-software/vrcft.mdx#module-registry).

Interested in the source code? Check out the [SRanipalTrackingModule source repository](https://github.com/VRCFaceTracking/SRanipalTrackingModule)

Expand Down
20 changes: 13 additions & 7 deletions docs/hardware/vr/vive/wireless.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,15 @@
Vive Wireless with a Vive Pro Eye and Vive Facial Tracker works (with some quirks).
Don’t believe that popup from SRanipal saying otherwise, but be prepared for a *potentially* frustrating experience.

:::info
Currently, there is a known issue with using the Vive Wireless Adapter on the Windows 11 22H2 Update version that can cause the SteamVR compositor to randomly crash when using wireless.
:::
<div style={{
width: '50%',
height: 'auto',
margin: 'auto',
display: 'block'
}}>
<img src={require("./img/wireless.png").default} alt="Vive Wireless Adapter on a Vive Pro headset" />
</div>


## Pros and Cons

Expand All @@ -28,28 +34,28 @@ So while it does work, there are some things to keep in mind or that you need to
### 🔌 Tricky USB Hubs

In a traditional wired setup, a (quality) USB-C hub could be used to expand the connectivity of the single USB-C 3.0 peripheral port.
While before, the VRCFT community believed it impossible, it turns out that at least one certain hub can be used with wireless and the [Vive Facial Tracker](@site/docs/hardware/addons/vive/face-tracker.mdx):
While before, the VRCFT community believed it impossible, it turns out that at least one certain hub can be used with wireless and the [Vive Facial Tracker](../../addons/vive/face-tracker.mdx):
https://www.amazon.com/dp/B09NDQGSPR
Previous users have noticed that to use the hub the Vive headset's onboard audio would have to be disabled.
**Note that this is not guaranteed to work reliably or at all for you!**

### ⚡ Higher Power Draw

The [Vive Facial Tracker](@site/docs/hardware/addons/vive/face-tracker.mdx) is a bit of a power hog when in use.
The [Vive Facial Tracker](../../addons/vive/face-tracker.mdx) is a bit of a power hog when in use.
When used over wireless, the original stock 18W QC3.0 battery may not be able to support it reliably.
Users have reported more stable experience with upgraded USB power cable (more robust USB-A to A or USB-A to C with an adapter) and higher power output battery, such as the 21W version that now comes stock with the Vive Wireless kits (for Cosmos / Vive Pro 2).

### 🌡 Higher Temps

The Vive Wireless Adapter is already well known for being a head toaster, but with the increased power draw and bandwidth usage when using the Vive Facial Tracker, it is more important than ever to keep the headset wireless module cool.
Excess heat is one of the primary reasons for wireless cutouts.
Adding a small fan over the center grill is a necessity if you plan on running the [Facial Tracker](@site/docs/hardware/addons/vive/face-tracker.mdx) over wireless.
Adding a small fan over the center grill is a necessity if you plan on running the [Facial Tracker](../../addons/vive/face-tracker.mdx) over wireless.
Keeping the computer-side PCIe card and antenna (“wireless linkbox”) cool too will help improve wireless performance.

### 🏿 CPU Intensive

Running SRanipal and Vive Wireless (and VR + VRChat) together is not for weak CPUs.
[SRanipal](@site/docs/hardware/vr/vive/sranipal.mdx) does use a reasonable amount of CPU when active.
[SRanipal](../../vr/vive/sranipal.mdx) does use a reasonable amount of CPU when active.
Since the encoding for the wireless connection is done by the CPU, any hiccup can result in a wireless freeze / disconnect or simply just wireless USB freeze / disconnect (aka eye/face tracking stops working).
Weaker or older CPUs (i.e. 8th gen Intel i7, R5-level CPUs 2 generations or older) may have a notably degraded VR and VRChat experience.
If you were already struggling performance-wise in VRChat without wireless, or without face tracking, you should avoid this combo.