Skip to content

Commit 9fa2d9e

Browse files
regzo2regzo2
authored
Merge pull request #74 from VRCFaceTracking/hardware-reorg
Hardware Pages Re-organization
2 parents 8f7cd55 + 9f90d88 commit 9fa2d9e

File tree

127 files changed

+2876
-2208
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

127 files changed

+2876
-2208
lines changed

‎docs/hardware/_category_.json‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
{
2-
"label": "Hardware Guides",
3-
"position": 4,
4-
"link": {
5-
"type": "generated-index",
6-
"description": "Documentation for compatible hardware and our findings"
7-
}
8-
}
1+
{
2+
"label": "Hardware Guides",
3+
"position": 4,
4+
"link": {
5+
"type": "generated-index",
6+
"slug": "hardware/",
7+
"description": "Documentation for compatible hardware"
8+
}
9+
}

‎docs/hardware/addons/_category_.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "VR Headset Add-ons",
3+
"position": 2,
4+
"link": {
5+
"type": "doc",
6+
"id": "addons"
7+
}
8+
}

‎docs/hardware/addons/addons.mdx‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
import ImageCardList from '@site/src/components/ImageCardList'
2+
3+
# VR Headset Add-ons
4+
5+
Devices that attach VR headsets and add eye and/or face tracking.
6+
Devices in this section are either headset agnostic or can be adapted to work with other headsets.
7+
8+
<ImageCardList />

‎docs/hardware/addons/babble/_category_.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"label": "Project Babble",
3+
"link": {
4+
"type": "doc",
5+
"id": "babble"
6+
}
7+
}

docs/hardware/Project Babble/babble-setup.mdx renamed to docs/hardware/addons/babble/babble.mdx

Lines changed: 66 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,67 @@
1-
---
2-
sidebar_position: 1
3-
sidebar_label: Project Babble
4-
---
5-
6-
# Project Babble
7-
8-
## Summary
9-
10-
[Project Babble](https://github.com/SummerSigh/ProjectBabble) is an open-source software project aiming to bring accessible face-tracking to PCVR headsets.
11-
12-
:::caution
13-
To clarify, Project Babble provides only lower face tracking, not eye tracking. Now that that's said, read on!
14-
:::
15-
16-
## Set-up
17-
18-
Setting up Project Babble is fairly simple. Please read carefully to avoid any issues.
19-
20-
:::note
21-
This guide assumes you have Project Babble installed, be it a release or the source code.
22-
It also assumes you have a compatible camera device. A standard webcam will work, but you can also use a phone, etc.
23-
:::
24-
25-
:::info
26-
Fun fact! you can use Project Babble with the HP Reverb G2 Omnicept lower face camera!
27-
:::
28-
29-
### Installation
30-
31-
Start by mounting your camera underneath your headset. The camera should be facing you, and should be able to see your face clearly. There is no "right" way to do this, feel free to experiment with different placements. Plug your camera into your headset's USB port; If you don't have one you can use a USB extension cable or a wireless camera.
32-
33-
Next, install the [latest release](https://github.com/SummerSigh/ProjectBabble/releases/latest) of Project Babble. You may need to define an exception in your antivirus software for this to run optimally.
34-
35-
Finally, install the VRCFT-Babble module. You can download this from the VRCFaceTracking applications Module Registry Window:
36-
37-
<div style={{
38-
width: '50%',
39-
height: 'auto',
40-
margin: 'auto',
41-
display: 'block'
42-
}}>
43-
<img src={require("../img/babble/babble_install.png").default} alt="babble install" />
44-
</div>
45-
46-
## Using The VRCFT-Babble Module
47-
48-
Open the Project Babble application. The application should automatically update itself to the latest version on launch. You should see a window like this:
49-
50-
<div style={{
51-
width: '50%',
52-
height: 'auto',
53-
margin: 'auto',
54-
display: 'block'
55-
}}>
56-
<img src={require("../img/babble/babble_startup.png").default} alt="babble startup" />
57-
</div>
58-
59-
After clicking start, VRFaceTracking should start to listen to incoming face data. It will relay this information into VRChat.
60-
61-
### Calibrating Face Tracking
62-
63-
Project Babble offers a calibration tool to help you get the best face tracking possible. To use it, click the "Calibrate" button and follow the instructions on screen. You will be asked to crop out a section of the camera feed.
64-
65-
In addition to face tracking calibration, you can also specify Project Babble to use your GPU using DirectML. There are some other settings as well, be sure to experiment with them to find what works best for you.
66-
67-
## Uninstalling The VRCFT-Babble Module
68-
1+
---
2+
sidebar_position: 1
3+
sidebar_label: Project Babble
4+
---
5+
6+
# Project Babble
7+
8+
[Project Babble](https://github.com/SummerSigh/ProjectBabble) is an open-source software project aiming to bring accessible face-tracking to PCVR headsets.
9+
10+
:::caution
11+
To clarify, Project Babble provides only lower face tracking, not eye tracking. Now that that's said, read on!
12+
:::
13+
14+
## Set-up
15+
16+
Setting up Project Babble is fairly simple. Please read carefully to avoid any issues.
17+
18+
:::note
19+
This guide assumes you have Project Babble installed, be it a release or the source code.
20+
It also assumes you have a compatible camera device. A standard webcam will work, but you can also use a phone, etc.
21+
:::
22+
23+
:::info
24+
Fun fact! you can use Project Babble with the HP Reverb G2 Omnicept lower face camera!
25+
:::
26+
27+
### Installation
28+
29+
Start by mounting your camera underneath your headset. The camera should be facing you, and should be able to see your face clearly. There is no "right" way to do this, feel free to experiment with different placements. Plug your camera into your headset's USB port; If you don't have one you can use a USB extension cable or a wireless camera.
30+
31+
Next, install the [latest release](https://github.com/SummerSigh/ProjectBabble/releases/latest) of Project Babble. You may need to define an exception in your antivirus software for this to run optimally.
32+
33+
Finally, install the VRCFT-Babble module. You can download this from the VRCFaceTracking applications Module Registry Window:
34+
35+
<div style={{
36+
width: '50%',
37+
height: 'auto',
38+
margin: 'auto',
39+
display: 'block'
40+
}}>
41+
<img src={require("./img/babble_install.png").default} alt="babble install" />
42+
</div>
43+
44+
## Using The VRCFT-Babble Module
45+
46+
Open the Project Babble application. The application should automatically update itself to the latest version on launch. You should see a window like this:
47+
48+
<div style={{
49+
width: '50%',
50+
height: 'auto',
51+
margin: 'auto',
52+
display: 'block'
53+
}}>
54+
<img src={require("./img/babble_startup.png").default} alt="babble startup" />
55+
</div>
56+
57+
After clicking start, VRFaceTracking should start to listen to incoming face data. It will relay this information into VRChat.
58+
59+
### Calibrating Face Tracking
60+
61+
Project Babble offers a calibration tool to help you get the best face tracking possible. To use it, click the "Calibrate" button and follow the instructions on screen. You will be asked to crop out a section of the camera feed.
62+
63+
In addition to face tracking calibration, you can also specify Project Babble to use your GPU using DirectML. There are some other settings as well, be sure to experiment with them to find what works best for you.
64+
65+
## Uninstalling The VRCFT-Babble Module
66+
6967
To uninstall The VRCFT-Babble, navigate to VRCFaceTracking's Module Registry, select the VRCFT-Babble module, and at the bottom of the page click the uninstall button.

‎docs/hardware/addons/babble/img/babble.png‎

25 KB
Loading

docs/hardware/img/babble/babble_install.png renamed to docs/hardware/addons/babble/img/babble_install.png

File renamed without changes.

docs/hardware/img/babble/babble_startup.png renamed to docs/hardware/addons/babble/img/babble_startup.png

File renamed without changes.

‎docs/hardware/addons/etvr/_category_.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"label": "EyeTrackVR",
3+
"link": {
4+
"type": "doc",
5+
"id": "etvr"
6+
}
7+
}

‎docs/hardware/addons/etvr/etvr.mdx‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# ETVR
2+
3+
Open-source eye trackers for VR
4+
5+
https://docs.eyetrackvr.dev/
6+
7+
:::info
8+
Under Construction
9+
:::

0 commit comments

Comments
 (0)