reorganize the handbook structure and add new sections

This commit is contained in:
Mamadou Babaei
2024-08-16 16:43:24 +02:00
parent e82aed2625
commit f852ede634
14 changed files with 88 additions and 27 deletions
+5 -1
View File
@@ -1,3 +1,7 @@
# Introduction
![SenseGlove](assets/senseglove.png "SenseGlove")
Welcome to the documentation for the SenseGlove Unreal Engine Plugin (a.k.a. The SenseGlove Unreal Handbook)!
This handbook is an ongoing effort an a work in progress to document the SenseGlove Unreal Engine Plugin. Feel free to visit this handbook on a regular basis.
> __🚨 Feel free to checkout [the SenseGlove Unreal Engine Plugin landing page on the UE Marketplace as well](https://www.unrealengine.com/marketplace/en-US/product/the-senseglove-unreal-engine-plugin).__
+58 -8
View File
@@ -1,20 +1,63 @@
Welcom to the SenseGlove Unreal Engine Handbook!
# 📄 Welcome
# 👋 Welcome
- [Introduction](README.md)
# 📝 Overview
# 📖 Overview
- [Platform Support Matrix](overview/platform-support-matrix.md)
- [Planned Features Completion Status](overview/planned-features-completion-status.md)
- [Changelog](overview/changelog.md)
- [Directory Structure](overview/directory-structure.md)
- [Overview](overview/README.md)
# 🚀 Getting Started
- [Installation](getting-started/installation.md)
- [Plugin Version](getting-started/plugin-version.md)
- [Install through the Epic Launcher]()
- [Install through Microsoft Azure DevOps]()
- [Checking the Plugin Version](getting-started/checking-plugin-version.md)
- [SenseCom]()
- [SenseCom on GNU/Linux]
- [Connect to Nova gloves using Blueman Bluetooth Manager]()
- [Connect to Nova gloves using Command-line]()
- [SenseCom on Microsoft Windows]
- [Setup the SGPawn]()
- [Setup a Virutal Hand Model]()
- [Setup the Grab System]()
- [Setup the Touch System]()
# ⚙️ The Settings System
- [Plugin Settings]()
- [Initialization]()
- [Game User Settings]()
- [Hardware Benchamrk]()
- [Tracking]()
- [Glove Tracking]()
- [Hand Tracking]()
- [HMD Tracking]()
- [Wrist Tracking]()
- [Debugging]()
- [Virtual Hand]()
- [Animation]()
- [Debugging]()
- [Grab]()
- [Haptics]()
- [Mesh]()
- [Touch]()
- [Overriding Settings]()
# 🛠️ Advanced Topics
- [OpenXR](advanced-topics/openxr/README.md)
- [Consuming FXRMotionControllerData](advanced-topics/openxr/consuming-fxrmotioncontrollerdata/README.md)
- [Blueprints](advanced-topics/openxr/consuming-fxrmotioncontrollerdata/blueprints.md)
- [C++](advanced-topics/openxr/consuming-fxrmotioncontrollerdata/cpp.md)
# 🔌 Low-Level API
- [Blueprints Low-Level API](low-level-api/blueprints.md)
- [C++ Low-Level API](low-level-api/cpp.md)
- [Work with a Glove instance in a safe manner in Blueprints]()
# 📜 License
@@ -24,6 +67,13 @@ Welcom to the SenseGlove Unreal Engine Handbook!
- [Boost C++ Libraries](license/boost-cpp-libraries.md)
- [Serial Communication Library License](license/serial-communication-library.md)
# 📑 Appendix
- [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)
-----------
- [Build Information](misc/build-information.md)
- [](misc/build-information.md)
View File
+7
View File
@@ -0,0 +1,7 @@
# Overview
In order to make it easy to follow the content of this handbook the documentation has been divded into various sections:
- The __📑 Appendix__ section contains various useful information such as [the Platform Support Matrix](appendix/platform-support-matrix.md), [the Planned Features Completion Status](appendix/planned-features-completion-status.md), [the Changelog](appendix/changelog.md), and [the Plugin's Directory Structure](appendix/directory-structure.md).