Files
Plugin/Handbook/src/overview/README.md
T

88 lines
5.1 KiB
Markdown
Raw Normal View History

# Overview
2024-08-08 07:28:44 +02:00
To help you navigate the SenseGlove Unreal Engine Handbook, we have organized the content into several key sections. This structured layout aims to simplify your journey through the SenseGlove Unreal Engine Plugin, providing clear and detailed guidance at every step.
2024-08-08 07:28:44 +02:00
## 🚀 Getting Started
2024-08-08 07:28:44 +02:00
This section covers the basics of the SenseGlove Unreal Engine Plugin:
- [Installation](../getting-started/installation/)
- [Through the Epic Games Launcher](../getting-started/installation/epic-games-launcher.md)
- [Through Microsoft Azure DevOps Repositories](../getting-started/installation/microsoft-azure-devops-repositories.md)
- [Enabling and Verifying the Plugin Version](../getting-started/plugin-verify-version-enable/)
- [SenseCom](../getting-started/sensecom/)
- [SenseCom on GNU/Linux](../getting-started/sensecom/gnu-linux/)
- [Connect to Nova gloves using Blueman Bluetooth Manager](../getting-started/sensecom/gnu-linux/blueman-bluetooth-manager.md)
- [Connect to Nova gloves using Command-line](../getting-started/sensecom/gnu-linux/command-line.md)
- [SenseCom on Microsoft Windows](../getting-started/sensecom/microsoft-windows.md)
- [Enabling XR_EXT_hand_tracking on VR Headsets](../getting-started/enabling-xr-ext-hand-tracking-vr-headsets/)
- [Setup SenseGlove Default Classes](../getting-started/setup-senseglove-default-classes/)
- [SGPawn](../getting-started/setup-senseglove-default-classes/sgpawn.md)
- [SGPlayerController](../getting-started/setup-senseglove-default-classes/sgplayercontroller.md)
- [SGGameModeBase](../getting-started/setup-senseglove-default-classes/sggamemodebase.md)
- [SGGameInstance](../getting-started/setup-senseglove-default-classes/sggameinstance.md)
- [SGGameUserSettings](../getting-started/setup-senseglove-default-classes/sggameusersettings.md)
2024-08-09 10:33:21 +02:00
- [Setup the Virtual Hand Meshes](../getting-started/setup-virtual-hand-meshes/)
- [Setup the Wrist Tracking Hardware](../getting-started/setup-wrist-tracking-hardware/)
- [Setup the Grab/Release System](../getting-started/setup-grab-release-system/)
- [Setup the Touch System](../getting-started/setup-touch-system/)
2024-08-08 07:28:44 +02:00
## ⚙️ Plugin Configuration
This section provides detailed information on configuring the plugin:
- [Plugin Settings](../plugin-configuration/plugin-settings/)
- [Initialization](../plugin-configuration/plugin-settings/initialization/)
- [Game User Settings](../plugin-configuration/plugin-settings/game-user-settings/)
- [Hardware-benchmarking](../plugin-configuration/plugin-settings/game-user-settings/hardware-benchmarking.md)
- [Tracking](../plugin-configuration/plugin-settings/tracking/)
- [Glove-tracking](../plugin-configuration/plugin-settings/tracking/glove-tracking.md)
- [Hand-tracking](../plugin-configuration/plugin-settings/tracking/hand-tracking.md)
- [HMD-tracking](../plugin-configuration/plugin-settings/tracking/hmd-tracking.md)
- [Wrist-tracking](../plugin-configuration/plugin-settings/tracking/wrist-tracking/)
- [Debugging](../plugin-configuration/plugin-settings/tracking/wrist-tracking/debugging.md)
- [Virtual Hand](../plugin-configuration/plugin-settings/virtual-hand/)
- [Animation](../plugin-configuration/plugin-settings/virtual-hand/animation.md)
- [Debugging](../plugin-configuration/plugin-settings/virtual-hand/debugging.md)
- [Grab](../plugin-configuration/plugin-settings/virtual-hand/grab.md)
- [Haptics](../plugin-configuration/plugin-settings/virtual-hand/haptics.md)
- [Mesh](../plugin-configuration/plugin-settings/virtual-hand/mesh.md)
- [Touch](../plugin-configuration/plugin-settings/virtual-hand/touch.md)
- [Overriding Settings](../plugin-configuration/overriding-settings/)
2024-08-08 07:28:44 +02:00
## 💡 Miscellaneous
Toipcs that do not fall under any specific category:
- [SenseGlove Console Commands](../misc/console-commands/)
- [Deploying to Android (Standalone)](../misc/android-standalone-deployment/)
- [Upgrade Guide]()
- [Optimizing for More FPS](../misc/optimize-more-fps/)
2024-08-08 07:28:44 +02:00
## 🛠️ Advanced Topics
For users familiar with the basics, this section explores advanced features of the plugin:
- [Safe Glove Access in Blueprint](../advanced-topics/safe-glove-access-blueprint/)
- [OpenXR](../advanced-topics/openxr/)
- [Consuming FXRMotionControllerData](../advanced-topics/openxr/consuming-fxrmotioncontrollerdata/)
- [Blueprints](../advanced-topics/openxr/consuming-fxrmotioncontrollerdata/blueprint.md)
- [C++](../advanced-topics/openxr/consuming-fxrmotioncontrollerdata/cpp.md)
2024-08-08 07:28:44 +02:00
## 🔌 Low-Level API
This section delves into the SenseGlove low-level API:
- [Low-Level Blueprints API](../low-level-api/blueprints.md)
- [Low-Level C++ API](../low-level-api/cpp.md)
2024-08-08 07:28:44 +02:00
## 📑 Appendix
The appendix contains various extra useful information:
- [Platform Support Matrix](../appendix/platform-support-matrix.md)
- [Planned Features Completion Status](../appendix/planned-features-completion-status.md)
- [Changelog](../appendix/changelog.md)
- [Directory Structure](../appendix/directory-structure.md)
- [Extra Resources](../appendix/extra-resources.md)