diff --git a/Handbook/src/advanced-topics/openxr/README.md b/Handbook/src/advanced-topics/openxr/README.md index 4fb279ac..5c6a2f36 100644 --- a/Handbook/src/advanced-topics/openxr/README.md +++ b/Handbook/src/advanced-topics/openxr/README.md @@ -1,6 +1,6 @@ # OpenXR -The SenseGlove Unreal Engine Plugin has provided OpenXR-compatible hand tracking by implementing `XR_EXT_hand_tracking` since `v2.1.0`. +The SenseGlove Unreal Engine Plugin has provided OpenXR-compatible hand tracking by implementing `XR_EXT_hand_tracking` since [`v2.1.0`](../../appendix/changelog.html#210---2024-08-16). Typically a user does not need to know anything about OpenXR to use the plugin, so this section of the handbook is for advanced users who are looking for a way to directly consume the OpenXR data coming directly from either a SenseGlove device or if enabled in the plugin settings from hand-tracking. diff --git a/Handbook/src/appendix/extra-resources.md b/Handbook/src/appendix/extra-resources.md index 24460db1..3d8ef7eb 100644 --- a/Handbook/src/appendix/extra-resources.md +++ b/Handbook/src/appendix/extra-resources.md @@ -1,13 +1,13 @@ # Extra Resources -There are various resources available for older versions of the SenseGlove Unreal Engine Plugin prior to `v2.1.x` that might still be partially relevant. These include example projects, demo scenes, and tutorials. Plans are underway to provide new example projects, demo scenes, and tutorials for the latest release. In the meantime, the outdated resources can still be beneficial +There are various resources available for older versions of the SenseGlove Unreal Engine Plugin prior to [`v2.1.x`](changelog.html#210---2024-08-16) that might still be partially relevant. These include example projects, demo scenes, and tutorials. Plans are underway to provide new example projects, demo scenes, and tutorials for the latest release. In the meantime, the outdated resources can still be beneficial ## Examples and Demo Projects -- [A basic OpenXR-compatible Blueprint demo demonstrating basic functionality such as grab/release, touch with buzz and force-feedback, etc (compatible with versions v2.1.0+).](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal-SGBasicDemo-OpenXR) -- [A basic Blueprint demo demonstrating basic functionality such as grab/release, touch with buzz and force-feedback, etc (compatible with versions >= v1.4.x and <= v2.0.x).](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal-SGBasicDemo) -- [Example C++ API Project (only compatible with early v1.x.x releases)](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal-SGPlaygroundCpp) -- [Example Blueprint API Project (only compatible with early v1.x.x releases)](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal-SGPlaygroundBP) +- [A basic OpenXR-compatible Blueprint demo demonstrating basic functionality such as grab/release, touch with buzz and force-feedback, etc (compatible with versions `v2.1.0+`).](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal-SGBasicDemo-OpenXR) +- [A basic Blueprint demo demonstrating basic functionality such as grab/release, touch with buzz and force-feedback, etc (compatible with versions >= `v1.4.x` and <= `v2.0.x)`.](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal-SGBasicDemo) +- [Example C++ API Project (only compatible with early `v1.x.x` releases)](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal-SGPlaygroundCpp) +- [Example Blueprint API Project (only compatible with early `v1.x.x` releases)](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal-SGPlaygroundBP) ### Third-Party OpenXR Integration Demos diff --git a/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/README.md b/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/README.md index 59a4b37b..d05f90dd 100644 --- a/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/README.md +++ b/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/README.md @@ -1,11 +1,13 @@ # Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets > [!IMPORTANT] -> Starting from version `v2.1.0`, the SenseGlove Unreal Engine Plugin requires -> the `XR_EXT_hand_tracking` OpenXR extension to function. Without this -> OpenXR extension the plugin won't output any glove data. +> Starting from version +> [`v2.1.0`](../../appendix/changelog.html#210---2024-08-16), +> the SenseGlove Unreal Engine Plugin requires the `XR_EXT_hand_tracking` OpenXR +> extension to function. Without this OpenXR extension the plugin won't output +> any glove data. -Since version `v2.1.0`, the SenseGlove Unreal Engine Plugin requires the `XR_EXT_hand_tracking` OpenXR extension to function. Whether you are streaming your immersive 3D VR application from your PC to your VR headset, or deploying it to your VR headset in standalone mode, enabling `XR_EXT_hand_tracking` support, might require additional plugins or settings depending on the HMD's vendor or model. +Since version [`v2.1.0`](../../appendix/changelog.html#210---2024-08-16), the SenseGlove Unreal Engine Plugin requires the `XR_EXT_hand_tracking` OpenXR extension to function. Whether you are streaming your immersive 3D VR application from your PC to your VR headset, or deploying it to your VR headset in standalone mode, enabling `XR_EXT_hand_tracking` support, might require additional plugins or settings depending on the HMD's vendor or model. ## PCVR Mode 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 71b13b05..0eff855a 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 @@ -1,6 +1,6 @@ # Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets in PCVR Mode -Starting from version `v2.1.0`, the SenseGlove Unreal Engine Plugin requires the `XR_EXT_hand_tracking` OpenXR extension to function. If you are streaming your immersive 3D VR application from your PC to your VR headset, enabling `XR_EXT_hand_tracking` support, requires additional plugins and settings depending on the HMD's vendor or model. +Starting from version [`v2.1.0`](../../../appendix/changelog.html#210---2024-08-16), the SenseGlove Unreal Engine Plugin requires the `XR_EXT_hand_tracking` OpenXR extension to function. If you are streaming your immersive 3D VR application from your PC to your VR headset, enabling `XR_EXT_hand_tracking` support, requires additional plugins and settings depending on the HMD's vendor or model. ## Enabling OpenXR Plugin and Disabling OpenXRHandTracking Plugin 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 e59bb7df..f1627346 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 @@ -1,6 +1,6 @@ # Enabling XR_EXT_hand_tracking OpenXR Extension on VR Headsets in Standalone Mode -Starting from version `v2.1.0`, the SenseGlove Unreal Engine Plugin requires the `XR_EXT_hand_tracking` OpenXR extension to function. If you are deploying your immersive 3D VR application to your VR headset in standalone mode, enabling `XR_EXT_hand_tracking` support, requires additional plugins and settings depending on the HMD's vendor or model. +Starting from version [`v2.1.0`](../../../appendix/changelog.html#210---2024-08-16), the SenseGlove Unreal Engine Plugin requires the `XR_EXT_hand_tracking` OpenXR extension to function. If you are deploying your immersive 3D VR application to your VR headset in standalone mode, enabling `XR_EXT_hand_tracking` support, requires additional plugins and settings depending on the HMD's vendor or model. ## Enabling OpenXR Plugin and Disabling OpenXRHandTracking Plugin diff --git a/Handbook/src/misc/android-standalone-deployment/README.md b/Handbook/src/misc/android-standalone-deployment/README.md index 7a9582f7..01a3c04b 100644 --- a/Handbook/src/misc/android-standalone-deployment/README.md +++ b/Handbook/src/misc/android-standalone-deployment/README.md @@ -17,7 +17,7 @@ Here are a few important notes to consider: > [!CAUTION] -> As of the `v2.1.0` release of the SenseGlove Unreal Engine Plugin, the +> As of the [`v2.1.0`](../../appendix/changelog.html#210---2024-08-16) release of the SenseGlove Unreal Engine Plugin, the > `XR_EXT_hand_tracking` OpenXR extension is required for the plugin to > function. Without this OpenXR extension, the plugin won't output any glove > data. diff --git a/Handbook/src/misc/upgrade-guide/README.md b/Handbook/src/misc/upgrade-guide/README.md index 9a30eeb3..4d836636 100644 --- a/Handbook/src/misc/upgrade-guide/README.md +++ b/Handbook/src/misc/upgrade-guide/README.md @@ -67,7 +67,8 @@ These are the notable changes that might affect your project: > your project to see if any change affects or breaks your current project. > [!NOTE] -> For upgrading older versions of the plugin to `v2.0.0`, +> For upgrading older versions of the plugin to +> [`v2.0.0`](../../appendix/changelog.html#200---2024-03-22), > [a YouTube tutorial](https://youtu.be/VbWfoep-Hsg) is available. >
>