From 6f63da7d2a07a3336234733c68e5f70207bb0465 Mon Sep 17 00:00:00 2001 From: Mamadou Babaei Date: Tue, 16 Jul 2024 19:19:24 +0200 Subject: [PATCH] reorganize the handbook structure and add new sections --- Handbook/src/README.md | 6 +- Handbook/src/SUMMARY.md | 66 ++++++++++++++++--- Handbook/src/advanced-topics/openxr/README.md | 0 .../README.md | 0 .../blueprints.md | 0 .../consuming-fxrmotioncontrollerdata/cpp.md | 0 .../src/{overview => appendix}/changelog.md | 0 .../directory-structure.md | 0 .../planned-features-completion-status.md | 0 .../platform-support-matrix.md | 0 Handbook/src/low-level-api/blueprints.md | 0 Handbook/src/low-level-api/cpp.md | 0 Handbook/src/overview/README.md | 7 ++ README.md | 36 +++++----- 14 files changed, 88 insertions(+), 27 deletions(-) create mode 100644 Handbook/src/advanced-topics/openxr/README.md create mode 100644 Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/README.md create mode 100644 Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/blueprints.md create mode 100644 Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/cpp.md rename Handbook/src/{overview => appendix}/changelog.md (100%) rename Handbook/src/{overview => appendix}/directory-structure.md (100%) rename Handbook/src/{overview => appendix}/planned-features-completion-status.md (100%) rename Handbook/src/{overview => appendix}/platform-support-matrix.md (100%) create mode 100644 Handbook/src/low-level-api/blueprints.md create mode 100644 Handbook/src/low-level-api/cpp.md create mode 100644 Handbook/src/overview/README.md diff --git a/Handbook/src/README.md b/Handbook/src/README.md index 6ca47306..746be8f1 100644 --- a/Handbook/src/README.md +++ b/Handbook/src/README.md @@ -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).__ diff --git a/Handbook/src/SUMMARY.md b/Handbook/src/SUMMARY.md index 13a7e3be..1afb2244 100644 --- a/Handbook/src/SUMMARY.md +++ b/Handbook/src/SUMMARY.md @@ -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) \ No newline at end of file +- [ℹī¸](misc/build-information.md) diff --git a/Handbook/src/advanced-topics/openxr/README.md b/Handbook/src/advanced-topics/openxr/README.md new file mode 100644 index 00000000..e69de29b diff --git a/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/README.md b/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/README.md new file mode 100644 index 00000000..e69de29b diff --git a/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/blueprints.md b/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/blueprints.md new file mode 100644 index 00000000..e69de29b diff --git a/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/cpp.md b/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/cpp.md new file mode 100644 index 00000000..e69de29b diff --git a/Handbook/src/overview/changelog.md b/Handbook/src/appendix/changelog.md similarity index 100% rename from Handbook/src/overview/changelog.md rename to Handbook/src/appendix/changelog.md diff --git a/Handbook/src/overview/directory-structure.md b/Handbook/src/appendix/directory-structure.md similarity index 100% rename from Handbook/src/overview/directory-structure.md rename to Handbook/src/appendix/directory-structure.md diff --git a/Handbook/src/overview/planned-features-completion-status.md b/Handbook/src/appendix/planned-features-completion-status.md similarity index 100% rename from Handbook/src/overview/planned-features-completion-status.md rename to Handbook/src/appendix/planned-features-completion-status.md diff --git a/Handbook/src/overview/platform-support-matrix.md b/Handbook/src/appendix/platform-support-matrix.md similarity index 100% rename from Handbook/src/overview/platform-support-matrix.md rename to Handbook/src/appendix/platform-support-matrix.md diff --git a/Handbook/src/low-level-api/blueprints.md b/Handbook/src/low-level-api/blueprints.md new file mode 100644 index 00000000..e69de29b diff --git a/Handbook/src/low-level-api/cpp.md b/Handbook/src/low-level-api/cpp.md new file mode 100644 index 00000000..e69de29b diff --git a/Handbook/src/overview/README.md b/Handbook/src/overview/README.md new file mode 100644 index 00000000..884fcff6 --- /dev/null +++ b/Handbook/src/overview/README.md @@ -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). + + diff --git a/README.md b/README.md index c1b6235f..a2f48622 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,24 @@ This repository relies on Git LFS for storing binary blobs (e.g. third-party libraries). Sadly, there is a known issue with Microsoft Azure public LFS repositories that requires credential for LFS checkouts on https (LFS ssh checkouts are not supported at all). Unless, you are part of SenseGlove organization on Microsoft Azure there is no easy way to fully clone this repository using Git. Thus, the best way to download this repository is to use the 'kebab' (three vertical dots) menu next to the clone button, in order to download the whole repository including LFS objects as a unified zip file. +## Platform Support Matrix + +We maintain [a platform support matrix](Handbook/src/appendix/platform-support-matrix.md) which constantly changes as we move forward towards our development goals. + +## Planned Features Completion Status + +We also maintain [a list of planned features and their completion status](Handbook/src/appendix/planned-features-completion-status.md) as a kind of roadmap for this plugin. + +## Changelog + +We maintain [a detailed changelog for this project](Handbook/src/appendix/changelog.md) as well. Please consult the changelog before upgrading to any newer release. + +## Directory Structure + +For the list of modules, directory structure, and how this plugin is organized please visit [the directory structure section](Handbook/src/appendix/directory-structure.md). + +## Getting Started + ## Documentation [The Blueprints documentation is hosted on SenseGlove Docs](https://senseglove.gitlab.io/unreal-blueprint-docs/). @@ -20,24 +38,6 @@ The following modules are intended to be used by the C++ users of this plugin: Please note that modules postfixed with **Impl** are intended for interal use and are discouraged to be used by the users of the API. The modules postfixed with **Kismet** are exposing the functionality of the equivalent modules to Blueprints. For other modules descriptions, please see [the Directory Structure section](#directory-structure). -## Overview - -### Platform Support Matrix - -We maintain [a platform support matrix](Handbook/src/overview/platform-support-matrix.md) which constantly changes as we move forward towards our development goals. - -### Planned Features Completion Status - -We also maintain [a list of planned features and their completion status](Handbook/src/overview/planned-features-completion-status.md) as a kind of roadmap for this plugin. - -### Changelog - -We maintain [a detailed changelog for this project](Handbook/src/overview/changelog.md) as well. Please consult the changelog before upgrading to any newer release. - -### Directory Structure - -For the list of modules, directory structure, and how this plugin is organized please visit [the directory structure section](Handbook/src/overview/directory-structure.md). - ## Licenses ### SenseGlove Unreal Engine Plug-in License