Skip to content

Commit 6fb60bf

Browse files
authored
fixed broken links @site link from page reorg; added some images for vive devices; minor touchup of some vive pages (#75)
1 parent 9fa2d9e commit 6fb60bf

File tree

8 files changed

+40
-21
lines changed

8 files changed

+40
-21
lines changed

docs/hardware/addons/pimax/droolon-pi-1.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# Droolon Pi 1
22

3+
The [Droolon Pi 1](https://pimax-test.myshopify.com/products/eye-tracking-module) is an eye-tracking add-on accessory for older Pimax headsets.
4+
This accessory is compatible with the Artisan/5K Plus/5K XR/5K Super/8K/8K Plus/8KX headsets.
5+
36
:::danger
47
**DISCONTINUED PRODUCT**
58
:::
69

7-
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.
8-
910
<div style={{
1011
width: '50%',
1112
height: 'auto',

docs/hardware/addons/vive/face-tracker.mdx

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,25 @@
11
# Vive Facial Tracker
22

3+
The Vive Facial Tracker provides lower face tracking for [Vive Pro](../../vr/vive/vpe.mdx) and other VR headsets.
4+
It connects to the computer via a short, built-in USB-C cable.
5+
Face tracking data is accessed through [Vive's SRanipal interface](../..//vr/vive/sranipal.mdx).
6+
37
:::danger
48
**DISCONTINUED PRODUCT**
59

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

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

1424
## Why is this setup required?
1525

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

2535
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.
26-
Follow the [SRanipal Setup](@site/docs/hardware/vr/vive/sranipal.mdx#set-up) instructions to get this necessary software installed and ready.
36+
Follow the [SRanipal Setup](../..//vr/vive/sranipal.mdx#set-up) instructions to get this necessary software installed and ready.
2737

2838
## Hardware Setup
2939

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

4656
:::info
47-
A shoddy USB connection for the Facial Tracker can lead to it getting stuck trying to update its firmware, never initializing.
48-
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).
57+
A poor USB connection for the Facial Tracker can lead to it getting stuck trying to update its firmware, never initializing.
58+
If possible, the plug the facial tracker **directly into a USB-C port on your computer** to allow it to "update".
59+
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.
4960
:::
5061

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

7586
#### Valve Index
7687

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

93104
:::info
94-
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.
105+
The Index frunk area can get quite warm, and the USB adapters can get **very hot**, making the headset heat worse.
106+
If possible, try to keep the front of the headset actively cooled with a fan, and/or add a heatsink to the USB adapter.
95107
:::
96108

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

103115
Using the headset as a VirtualHere USB server is a possible solution that allows for a fully wireless setup.
104116
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
105-
This proceed *may* work for other similar headsets (Pico 3, Pico 4, etc.) but have not been tested.
117+
This proceed *may* work for other similar headsets (Pico 3, Pico 4, etc.).
106118

107119
## Module
108120

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

111123
[SRanipalTrackingModule source repository](https://github.com/VRCFaceTracking/SRanipalTrackingModule)

docs/hardware/vr/pico/pico4pe.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Streaming Assistant is only available for Headsets using firmaware older than 5.
2525

2626
## Module
2727

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

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

29.6 KB
Loading

docs/hardware/vr/vive/img/vpe.png

203 KB
Loading
940 KB
Loading

docs/hardware/vr/vive/vpe.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Eye tracking data is accessed through [Vive's SRanipal interface](./sranipal.mdx
1616

1717
## Module
1818

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

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

docs/hardware/vr/vive/wireless.mdx

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,15 @@
33
Vive Wireless with a Vive Pro Eye and Vive Facial Tracker works (with some quirks).
44
Don’t believe that popup from SRanipal saying otherwise, but be prepared for a *potentially* frustrating experience.
55

6-
:::info
7-
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.
8-
:::
6+
<div style={{
7+
width: '50%',
8+
height: 'auto',
9+
margin: 'auto',
10+
display: 'block'
11+
}}>
12+
<img src={require("./img/wireless.png").default} alt="Vive Wireless Adapter on a Vive Pro headset" />
13+
</div>
14+
915

1016
## Pros and Cons
1117

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

3036
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.
31-
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):
37+
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):
3238
https://www.amazon.com/dp/B09NDQGSPR
3339
Previous users have noticed that to use the hub the Vive headset's onboard audio would have to be disabled.
3440
**Note that this is not guaranteed to work reliably or at all for you!**
3541

3642
### ⚡ Higher Power Draw
3743

38-
The [Vive Facial Tracker](@site/docs/hardware/addons/vive/face-tracker.mdx) is a bit of a power hog when in use.
44+
The [Vive Facial Tracker](../../addons/vive/face-tracker.mdx) is a bit of a power hog when in use.
3945
When used over wireless, the original stock 18W QC3.0 battery may not be able to support it reliably.
4046
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).
4147

4248
### 🌡 Higher Temps
4349

4450
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.
4551
Excess heat is one of the primary reasons for wireless cutouts.
46-
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.
52+
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.
4753
Keeping the computer-side PCIe card and antenna (“wireless linkbox”) cool too will help improve wireless performance.
4854

4955
### 🏿 CPU Intensive
5056

5157
Running SRanipal and Vive Wireless (and VR + VRChat) together is not for weak CPUs.
52-
[SRanipal](@site/docs/hardware/vr/vive/sranipal.mdx) does use a reasonable amount of CPU when active.
58+
[SRanipal](../../vr/vive/sranipal.mdx) does use a reasonable amount of CPU when active.
5359
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).
5460
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.
5561
If you were already struggling performance-wise in VRChat without wireless, or without face tracking, you should avoid this combo.

0 commit comments

Comments
 (0)