From 6a3434c983ca81c142631814d3e3c59e3c650f24 Mon Sep 17 00:00:00 2001 From: Mamadou Babaei Date: Wed, 12 Feb 2025 16:04:25 +0100 Subject: [PATCH] remove metaxr compatibility from the documentation along with its assets and replace it with a caution incompatibility note --- .../meta-xr-plugin-default-settings-001.png | 3 -- .../meta-xr-plugin-default-settings-002.png | 3 -- ...hand-tracking-support-controllers-hand.png | 3 -- ...-settings-xr-api-editor-restart-prompt.png | 3 -- .../pcvr-mode/README.md | 29 +++---------------- .../standalone-mode/README.md | 27 ++--------------- 6 files changed, 7 insertions(+), 61 deletions(-) delete mode 100644 Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/meta-xr-plugin-default-settings-001.png delete mode 100644 Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/meta-xr-plugin-default-settings-002.png delete mode 100644 Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/meta-xr-plugin-settings-hand-tracking-support-controllers-hand.png delete mode 100644 Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/meta-xr-plugin-settings-xr-api-editor-restart-prompt.png diff --git a/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/meta-xr-plugin-default-settings-001.png b/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/meta-xr-plugin-default-settings-001.png deleted file mode 100644 index 774e585c..00000000 --- a/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/meta-xr-plugin-default-settings-001.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:e1a6e782e8ddb5b1e5654738801dd67dc118b4adf11bef65278100d5e0ac69b3 -size 209276 diff --git a/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/meta-xr-plugin-default-settings-002.png b/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/meta-xr-plugin-default-settings-002.png deleted file mode 100644 index 6121765a..00000000 --- a/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/meta-xr-plugin-default-settings-002.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:db866e3b99a830ce2b3535fdc9a592a28fc7840cf9897ea5935cb967be5e6c9a -size 200340 diff --git a/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/meta-xr-plugin-settings-hand-tracking-support-controllers-hand.png b/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/meta-xr-plugin-settings-hand-tracking-support-controllers-hand.png deleted file mode 100644 index 7621e9e7..00000000 --- a/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/meta-xr-plugin-settings-hand-tracking-support-controllers-hand.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:a53d4d01854bf8f2fb4ed2818f152a4c9d9589272274f214413211ca7cdac1ca -size 199076 diff --git a/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/meta-xr-plugin-settings-xr-api-editor-restart-prompt.png b/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/meta-xr-plugin-settings-xr-api-editor-restart-prompt.png deleted file mode 100644 index 40f91279..00000000 --- a/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/meta-xr-plugin-settings-xr-api-editor-restart-prompt.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:9111c5e7d7e53a0f29ffe90b61aca32334b9f81f1b9f5d6c975ca0d829197465 -size 218393 diff --git a/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/pcvr-mode/README.md b/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/pcvr-mode/README.md index c3ca5c07..b47db678 100644 --- a/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/pcvr-mode/README.md +++ b/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/pcvr-mode/README.md @@ -38,30 +38,9 @@ For Meta Quest headsets, enable the `Developer runtime features` under the `Sett ### Meta XR Plugin > [!CAUTION] -> By default, enabling the `Meta XR` plugin breaks and disrupts the -> SenseGlove Unreal Engine Plugin implementation of `XR_EXT_hand_tracking`. -> Thus, rendering both glove and hand-tracking data broken. However, it's -> possible to fix this issue with proper `Meta XR` plugin configuration. - -By default, the `Meta XR` plugin settings located in `Edit > Project Settings > Plugins > Meta XR` look something like these: - -![Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets in PCVR Mode - Default Meta XR Plugin Settings](../meta-xr-plugin-default-settings-001.png "Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets in PCVR Mode - Default Meta XR Plugin Settings") - -![Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets in PCVR Mode - Default Meta XR Plugin Settings](../meta-xr-plugin-default-settings-002.png "Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets in PCVR Mode - Default Meta XR Plugin Settings") - -The following settings control the hand-tracking behavior when the `Meta XR` plugin is enabled: - -- **XR API**: This selects the XR API that the engine will use. If set to `Oculus OVRPlugin + OpenXR backend (current recommended)`, which is the default, will break the SenseGlove Unreal Engine Plugin's glove and hand-tracking data. In order to make the Meta XR and SenseGlove Unreal Engine plugins compatible you should choose `Epic Native OpenXR with Oculus vendor extensions` here. This disables Legacy Oculus in favor of the native OpenXR implementation, with Oculus vendor extensions. This will be where Epic focuses XR development going forward. Changing the `XR API` settings requires an editor restart to take effect. - -![Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets in PCVR Mode - Meta XR Plugin Settings - Epic Native OpenXR with Oculus vendor extensions Editor Restart Prompt](../meta-xr-plugin-settings-xr-api-editor-restart-prompt.png "Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets in PCVR Mode - Meta XR Plugin Settings - Epic Native OpenXR with Oculus vendor extensions Editor Restart Prompt") - -- **Hand Tracking Support**: Determines whether controllers and/or hands can be used within the current appication. Possible values are `ControllersOnly`, `ControllersAndHands`, and `HandsOnly`. We recommend to set this to `ControllersAndHands` to be able to use both controllers (as a wrist-tracker device) and hand-tracking. See also [`bFallbackToHandTrackingIfNoGloveDetected`](../../../plugin-configuration/plugin-settings/tracking/#bfallbacktohandtrackingifnoglovedetected). - -![Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets in PCVR Mode - Meta XR Plugin Settings - Hand Tracking Support: Controllers and Hands](../meta-xr-plugin-settings-hand-tracking-support-controllers-hand.png "Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets in PCVR Mode - Meta XR Plugin Settings - Hand Tracking Support: Controllers and Hands") - -- **HandTrackingFrequency**: Determines the hand-tracking frequency, whether `LOW` or `HIGH`. Please note that a higher tracking frequency will reserve some performance headroom from the application's budget. - -- **HandTrackingVersion**: Determines the version of hand tracking algorithm. `Default`, `V1`, and `V2` are valid options. If unsure, leave it as `Default` and the SenseGlove glove and hand-tracking should work as expected. +> Please note that enabling the `Meta XR` plugin alongside the SenseGlove plugin +> will result in crashes or unexpected behavior. `Meta XR` plugin compatibility +> is being worked on and might be supported in the future. ## HTC VIVE @@ -95,4 +74,4 @@ After enabling the [OpenXRViveTracker plugin](#openxrvivetracker-plugin) and [en ## SenseGlove Wrist Tracking Settings -Once you have set up everything, it's time to adjust the [SenseGlove Wrist Tracking Settings](../../setup-wrist-tracking-hardware/) inside the project-wide plugin's settings. For detailed information, please visit [the Wrist Tracking Hardware and HMD auto-detection configuration section](../../../plugin-configuration/plugin-settings/tracking/wrist-tracking/) as well. \ No newline at end of file +Once you have set up everything, it's time to adjust the [SenseGlove Wrist Tracking Settings](../../setup-wrist-tracking-hardware/) inside the project-wide plugin's settings. For detailed information, please visit [the Wrist Tracking Hardware and HMD auto-detection configuration section](../../../plugin-configuration/plugin-settings/tracking/wrist-tracking/) as well. diff --git a/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/standalone-mode/README.md b/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/standalone-mode/README.md index 88345eac..883147be 100644 --- a/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/standalone-mode/README.md +++ b/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/standalone-mode/README.md @@ -26,30 +26,9 @@ To set up `XR_EXT_hand_tracking` support on Meta Quest HMDs in Standalone mode, ### Meta XR Plugin > [!CAUTION] -> By default, enabling the `Meta XR` plugin breaks and disrupts the -> SenseGlove Unreal Engine Plugin implementation of `XR_EXT_hand_tracking`. -> Thus, rendering both glove and hand-tracking data broken. However, it's -> possible to fix this issue with proper `Meta XR` plugin configuration. - -By default, the `Meta XR` plugin settings located in `Edit > Project Settings > Plugins > Meta XR` look something like these: - -![Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets in Standalone Mode - Default Meta XR Plugin Settings](../meta-xr-plugin-default-settings-001.png "Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets in Standalone Mode - Default Meta XR Plugin Settings") - -![Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets in Standalone Mode - Default Meta XR Plugin Settings](../meta-xr-plugin-default-settings-002.png "Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets in Standalone Mode - Default Meta XR Plugin Settings") - -The following settings control the hand-tracking behavior when the `Meta XR` plugin is enabled: - -- **XR API**: This selects the XR API that the engine will use. If set to `Oculus OVRPlugin + OpenXR backend (current recommended)`, which is the default, will break the SenseGlove Unreal Engine Plugin's glove and hand-tracking data. In order to make the Meta XR and SenseGlove Unreal Engine plugins compatible you should choose `Epic Native OpenXR with Oculus vendor extensions` here. This disables Legacy Oculus in favor of the native OpenXR implementation, with Oculus vendor extensions. This will be where Epic focuses XR development going forward. Changing the `XR API` settings requires an editor restart to take effect. - -![Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets in Standalone Mode - Meta XR Plugin Settings - Epic Native OpenXR with Oculus vendor extensions Editor Restart Prompt](../meta-xr-plugin-settings-xr-api-editor-restart-prompt.png "Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets in Standalone Mode - Meta XR Plugin Settings - Epic Native OpenXR with Oculus vendor extensions Editor Restart Prompt") - -- **Hand Tracking Support**: Determines whether controllers and/or hands can be used within the current appication. Possible values are `ControllersOnly`, `ControllersAndHands`, and `HandsOnly`. We recommend to set this to `ControllersAndHands` to be able to use both controllers (as a wrist-tracker device) and hand-tracking. See also [`bFallbackToHandTrackingIfNoGloveDetected`](../../../plugin-configuration/plugin-settings/tracking/#bfallbacktohandtrackingifnoglovedetected). - -![Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets in Standalone Mode - Meta XR Plugin Settings - Hand Tracking Support: Controllers and Hands](../meta-xr-plugin-settings-hand-tracking-support-controllers-hand.png "Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets in Standalone Mode - Meta XR Plugin Settings - Hand Tracking Support: Controllers and Hands") - -- **HandTrackingFrequency**: Determines the hand-tracking frequency, whether `LOW` or `HIGH`. Please note that a higher tracking frequency will reserve some performance headroom from the application's budget. - -- **HandTrackingVersion**: Determines the version of hand tracking algorithm. `Default`, `V1`, and `V2` are valid options. If unsure, leave it as `Default` and the SenseGlove glove and hand-tracking should work as expected. +> Please note that enabling the `Meta XR` plugin alongside the SenseGlove plugin +> will result in crashes or unexpected behavior. `Meta XR` plugin compatibility +> is being worked on and might be supported in the future. ## HTC VIVE