Skip to content

Commit d4073e4

Browse files
authored
Update README.md
1 parent 1377bd1 commit d4073e4

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
1-
# Neos-Eye-Face-API
1+
# NeosVarjoEyeTracking
22

33
A [NeosModLoader](https://github.com/zkxs/NeosModLoader) mod for [Neos VR](https://neos.com/)
4-
Enables developers to add implement their own eye and face tracking solutions for NeosVR.
4+
Integrates the Varjo Areo's Eye tracking into NeosVR
55

66
Related issue on the Neos Github:
7-
https://github.com/Neos-Metaverse/NeosPublic/issues/1140
7+
https://github.com/Neos-Metaverse/NeosPublic/issues/3226
88

99
## Usage
10-
0. Install [NeosModLoader](https://github.com/zkxs/NeosModLoader).
11-
1. Clone this Repository
12-
2. Update EyeTracker.cs and MouthTracker.cs's parameters with values of your own.
13-
3. Build and place your DLL under "nml_mods". This folder should be at `C:\Program Files (x86)\Steam\steamapps\common\NeosVR\nml_mods` for a default install. You can create it if it's missing, or if you launch the game once with NeosModLoader.
14-
5. Start the game!
10+
1. Install [NeosModLoader](https://github.com/zkxs/NeosModLoader).
11+
2. Download the latest release, and extract the zip file's contents to your mods folder. This folder should be at `C:\Program Files (x86)\Steam\steamapps\common\NeosVR\nml_mods` for a default install. You can create it if it's missing, or if you launch the game once with NeosModLoader.
12+
3. Copy the file called "VarjoLib.dll" from your mods folder and paste it into your Neos base directory. This is one folder above your mods, it should be at `C:\Program Files (x86)\Steam\steamapps\common\NeosVR` for a default install. Additonally, if you are using the Steam build, you can right-click "Neos -> Manage -> Browse Local Files" to get your install directory.
13+
4. Start the game!
1514

16-
If you want to verify that the mod is working you can check your Neos logs, or create an EmptyObject with an AvatarRawEyeData/AvatarRawMouthData Component (Found under Users -> Common Avatar System -> Face -> AvatarRawEyeData/AvatarRawMouthData).
15+
If you want to verify that the mod is working you can check your Neos logs, equip an eye-tracking ready avatar, or create an EmptyObject with an AvatarRawEyeData Component (Found under Users -> Common Avatar System -> Face -> AvatarRawEyeData).
1716

1817
Thanks to those who helped me test this!

0 commit comments

Comments
 (0)