diff --git a/FAQ.md b/FAQ.md index 0dc4d07..557d2c0 100644 --- a/FAQ.md +++ b/FAQ.md @@ -22,7 +22,7 @@ The goal of the OpenXR Toolkit is to bring innovative features to the community ## Q: What headset does the OpenXR Toolkit work with? -It works with any VR headset thanks to OpenXR. See [index#supported-headsets](supported headsets). +It works with any VR headset thanks to OpenXR. See [supported headsets](index#supported-headsets). ## Q: What GPUs does the OpenXR Toolkit work with? @@ -30,7 +30,7 @@ Any GPU that is compatible DirectX 11. Yes, even the NVIDIA Image Scaling (NIS) will work on non-NVIDIA cards, and AMD's FSR will work on non-AMD cards. -Foveated rendering requires additional support, see See [index#supported-graphics-cards](supported graphics cards). +Foveated rendering requires additional support, see See [supported graphics cards](index#supported-graphics-cards). ## Q: Does the OpenXR Toolkit work with OpenGL or Vulkan. @@ -38,7 +38,7 @@ No. ## Q: Will the OpenXR Toolkit work with other games like the ones from Steam? -This software only works with OpenXR applications, not OpenVR not OVR applications. See [index#supported-applications](supported applications). +This software only works with OpenXR applications, not OpenVR not OVR applications. See [supported applications](index#supported-applications)). ## Q: Do I need to uninstall the OpenXR Toolkit if a game is not compatible? diff --git a/et.md b/et.md index 63c0eb1..0da22a5 100644 --- a/et.md +++ b/et.md @@ -25,16 +25,15 @@ The use of Eye Tracking (ET) in conjunction with [Foveated Rendering](fr) (FR) c **In addition to the requirements for your graphics card and headset, it must be possible for OpenXR Toolkit to distinguish when the application is rendering the left and right views. This is not possible for all applications, and therefore eye tracking might not be offered for all applications.** When not available, Fixed Foveated Rendering will still be offered as a fallback. -Below is a table of games tested with eye-tracked foveated rendering: +Below is a (non-exhaustive) table of games tested with eye-tracked foveated rendering: | Game | Note | | --- | --- | -| Assetto Corsa Competizione | Requires [OpenComposite](opencomposite) | -| Contractors | Requires to add `-hmd=openxr` to the command-line | +| Assetto Corsa Competizione | Requires OpenComposite | +| Contractors | Must start the game in OpenXR mode (`-hmd=openxr` parameter) | | Fallout 4 VR | Requires OpenComposite | -| Ghosts of Tabor | | | Hubris | | -| iRacing | Requires OpenXR mode | +| iRacing | Must start the game in OpenXR mode | | Microsoft Flight Simulator 2020 | | | Pavlov VR (Beta) | | | Praydog's UE4VR Injector | Mod is not yet released | @@ -42,79 +41,127 @@ Below is a table of games tested with eye-tracked foveated rendering: Most Unreal Engine games using OpenXR directly (not OpenVR) should work, since Unreal Engine uses a rendering technique that allows left and right eye to be identified at rendering time. -### Considerations for Varjo +For Digital Combat Simulator, check out [Quad-Views-Foveated](https://github.com/mbucchia/Quad-Views-Foveated/wiki) as an alternative to OpenXR Toolkit. -**Varjo supports eye tracking for PC applications when using Varjo as the OpenXR runtime. If you are using SteamVR as the OpenXR runtime, this runtime cannot support eye tracking for PC applications.** +### Considerations for Quest Pro -You must toggle the _Allow eye tracking_ option from the _System_ tab of the Varjo Base software: +#### Using Oculus OpenXR with Oculus Link
Click for details... - Allow ET
- This option must be enabled for OpenXR Toolkit to access the eye tracking data for its own implementation of Foveated Rendering. +

- Select Oculus as your OpenXR runtime.
+
+

-
+

- YOU MUST CREATE A DEVELOPER ACCOUNT.

-### Considerations for HP G2 Omnicept +

- Open the Oculus application on your PC, then under 'Settings' -> 'Beta' make sure both 'Developer Runtime Features' and 'Eye tracking over Oculus Link' are toggled on.
+

-In order to use the eye tracker on your Omnicept device, you must first install the [HP Omnicept Runtime](https://developers.hp.com/omnicept/downloads/hp-omnicept-runtime). +

- Open the Meta Quest app on your phone, then under 'Headset Settings' -> 'Developer Mode' make sure to 'Developer Mode' is toggled on.
+

-Once installed, please run the HP Omnicept eye calibration application. +

- Ensure that eye tracking is enabled on your Quest Pro, and you have performed calibration. These settings can be found under 'Settings' -> 'Movement tracking'.
+

+ -You must then allow applications to use the eye tracker. You can enable all applications by disabling the _Require user approval for Omnicept clients using sensor data_ option under the _Omnicept Client Approval Settings_ in the HP Omnicept software: +#### Using VirtualDesktopXR (VDXR) with Virtual Desktop
Click for details... +

- YOU MUST USE VIRTUAL DESKTOP 1.29.3 OR HIGHER

+ +

- Select VDXR as your OpenXR runtime.
+

- Allow all
- Toggling Off the Require user approval will allow all applications to use the eye tracker. +

- Ensure that eye tracking is enabled on your Quest Pro, and you have performed calibration. These settings can be found under 'Settings' -> 'Movement tracking'.
+

+

- Open the Virtual Desktop app and navigate to the 'Streaming' settings. Enable 'Forward face/eye tracking to PC'.
+

- -You may otherwise selectively allow applications, one by one. You must first run the application once, enable eye tracking in the OpenXR Toolkit menu, then open the HP Omnicept software and allow the client, under the _Clients_ tab, in the _Incoming subscriptions request_ table: + +#### Using SteamVR OpenXR with Virtual Desktop + +Follow the instructions to install [OpenXR-Eye-Trackers](https://github.com/mbucchia/OpenXR-Eye-Trackers/wiki/Meta-Quest-Pro#with-virtual-desktop). + +### Considerations for Varjo + +#### Using Varjo OpenXR
Click for details... +

- Open the Varjo Base application on your PC then select Varjo as your OpenXR runtime.
+

- Allow client
- You can Accept Incoming subscriptions requests to selecting allow an application, while forbidding others. +

- In the 'System tab', under 'Privacy', toggle 'Allow eye tracking' to on.
+

+

- Ensure that your eye tracker is calibrated. In the 'Headset' tab, under 'Foveated Rendering', make sure to select a method for using calibration..
+

-### Considerations for Quest Pro - -**Oculus Quest Pro only supports eye tracking for PC applications when using Oculus as the OpenXR runtime. If you are using SteamVR as the OpenXR runtime (for example, to use Virtual Desktop), this runtime cannot support eye tracking for PC applications.** +#### Using SteamVR OpenXR -1. IMPORTANT: Create and log in with a [developer account](https://developer.oculus.com/sign-up/). You must be a registered developer for the Oculus runtime to expose the hand tracking features. +Follow the instructions to install [OpenXR-Eye-Trackers](https://github.com/mbucchia/OpenXR-Eye-Trackers/wiki/Varjo-Aero-VR%E2%80%903-XR%E2%80%903). -2. Ensure that your Oculus software is up-to-date (v49 or later). +### Considerations for HP G2 Omnicept -3. Turn on Developer mode on the headset. +#### Using OpenXR for Windows Mixed Reality
Click for details... - Enabling developer mode - Enabling developer mode +

- Select Windows Mixed Reality as your OpenXR runtime.
+
+

+ +

- Install the HP Omnicept Runtime.

+

- From the HP Omnicept Tray, open the 'Settings' page, and under 'General' -> 'Omnicept Client Approval Settings', toggle the 'Require user approval for Omnicept clients using sensor data' to Off.
+

-4. On your PC, open the _Oculus App_, and navigate to _Settings_ and the _Beta_ menu. +#### Using SteamVR OpenXR + +Follow the instructions to install [OpenXR-Eye-Trackers](https://github.com/mbucchia/OpenXR-Eye-Trackers/wiki/HP-Reverb-G2-Omnicept). -5. Enable _Developer Runtime Features_. +### Considerations for Pimax Crystal + +#### Using PimaxXR
Click for details... +

- Open the PimaxXR Control Center application on your PC then select PimaxXR runtime.
+

+ +

- Enable 'Allow use of the eye tracker'.
+

+ +

- Open the Pimax Play application on your PC then navigate to 'Device Settings'. In the 'Device' tab, make sure that 'Eye Tracking' is enabled and use the 'Calibration' button to perform the calibration if needed.
+

+
- Enabling developer mode +#### Using SteamVR OpenXR - +Follow the instructions to install [OpenXR-Eye-Trackers](https://github.com/mbucchia/OpenXR-Eye-Trackers/wiki/Pimax-Crystal). ### Considerations for Pimax+Droolon -In order to use the Droolon eye tracking module on your Pimax device, you must first install the [aSeeVR SDK](https://drive.google.com/file/d/1ELDtOnMa-MkgchmWFf7w5an-iPOFtQL8/view?usp=sharing&_ga=2.110383681.599346747.1650530138-1983392096.1642581798). +#### Using PimaxXR + +
+ Click for details... +

- Open the PimaxXR Control Center application on your PC then select PimaxXR runtime.
+

+ +

- Enable 'Allow use of the eye tracker'.
+

+ +

Download and install the 7invensun runtime, specifically the version modified by GuppyExpress. Follow the instructions to install and calibrate the eye tracker. _PimaxXR_ will automatically detect the Droolon Pi1 module once the 7invensun runtime is running.

+
-Once installed, please run the aSeeVR runtime. In the system tray bar, right-click on the runtime, and make sure to enable _deviced_ -> _Pimax_. +### Considerations for Vive Pro Eye -When using Foveated Rendering in the OpenXR Toolkit, adjust the _Eye projection distance_ from the _Foveated rendering_ menu until you reach comfortable sensitivity. +Coming soon. diff --git a/index.md b/index.md index d65b200..ff67e51 100644 --- a/index.md +++ b/index.md @@ -125,7 +125,7 @@ Certain features, like Foveated Rendering, have additional requirements, per the | Praydog's UEVR injector | Yes | Must use the injector in OpenXR mode | | The 7th Guest VR | Yes | - | | War Thunder | Yes | - | -| X-Plane 12 | No | Must start the game in OpenXR mode (`--open_xr` parameter) | +| X-Plane 12 | No | - | #### OpenComposite diff --git a/site/et-crystal-1.png b/site/et-crystal-1.png new file mode 100644 index 0000000..08acd4c Binary files /dev/null and b/site/et-crystal-1.png differ diff --git a/site/et-oculus-1.png b/site/et-oculus-1.png new file mode 100644 index 0000000..88b468f Binary files /dev/null and b/site/et-oculus-1.png differ diff --git a/site/et-oculus-2.png b/site/et-oculus-2.png new file mode 100644 index 0000000..2c10ced Binary files /dev/null and b/site/et-oculus-2.png differ diff --git a/site/et-oculus-3.png b/site/et-oculus-3.png new file mode 100644 index 0000000..d2c93be Binary files /dev/null and b/site/et-oculus-3.png differ diff --git a/site/et-omnicept-1.png b/site/et-omnicept-1.png new file mode 100644 index 0000000..2db3e23 Binary files /dev/null and b/site/et-omnicept-1.png differ diff --git a/site/et-pimax-1.png b/site/et-pimax-1.png new file mode 100644 index 0000000..476e36c Binary files /dev/null and b/site/et-pimax-1.png differ diff --git a/site/et-varjo-1.png b/site/et-varjo-1.png new file mode 100644 index 0000000..0f9045b Binary files /dev/null and b/site/et-varjo-1.png differ diff --git a/site/et-varjo-2.png b/site/et-varjo-2.png new file mode 100644 index 0000000..fe6608f Binary files /dev/null and b/site/et-varjo-2.png differ diff --git a/site/et-vd-1.png b/site/et-vd-1.png new file mode 100644 index 0000000..d2c93be Binary files /dev/null and b/site/et-vd-1.png differ diff --git a/site/et-vd-2.png b/site/et-vd-2.png new file mode 100644 index 0000000..e08d5f0 Binary files /dev/null and b/site/et-vd-2.png differ diff --git a/site/vdxr-openxr.png b/site/vdxr-openxr.png new file mode 100644 index 0000000..b9ec74e Binary files /dev/null and b/site/vdxr-openxr.png differ