From 35294a9ab56402786a4e4df5c7a1e332db98c12b Mon Sep 17 00:00:00 2001 From: Mamadou Babaei Date: Thu, 8 Aug 2024 13:11:01 +0200 Subject: [PATCH] add the introduction to the senseglove default classes --- Handbook/src/SUMMARY.md | 4 ++-- .../setup-senseglove-default-classes/README.md | 14 ++++++++++++++ .../low-level-api/{blueprints.md => blueprint.md} | 0 .../plugin-settings/initialization/README.md | 2 ++ 4 files changed, 18 insertions(+), 2 deletions(-) rename Handbook/src/low-level-api/{blueprints.md => blueprint.md} (100%) diff --git a/Handbook/src/SUMMARY.md b/Handbook/src/SUMMARY.md index cd863c85..11f405b8 100644 --- a/Handbook/src/SUMMARY.md +++ b/Handbook/src/SUMMARY.md @@ -65,7 +65,7 @@ Welcom to the SenseGlove Unreal Engine Handbook! # 🔌 Low-Level API -- [Low-Level Blueprints API](low-level-api/blueprints.md) +- [Low-Level Blueprint API](low-level-api/blueprint.md) - [Low-Level C++ API](low-level-api/cpp.md) # 📑 Appendix @@ -87,4 +87,4 @@ Welcom to the SenseGlove Unreal Engine Handbook! ----------- -- [â„šī¸](misc/build-information.md) \ No newline at end of file +- [â„šī¸](misc/build-information.md) diff --git a/Handbook/src/getting-started/setup-senseglove-default-classes/README.md b/Handbook/src/getting-started/setup-senseglove-default-classes/README.md index 43b6caa1..0113a058 100644 --- a/Handbook/src/getting-started/setup-senseglove-default-classes/README.md +++ b/Handbook/src/getting-started/setup-senseglove-default-classes/README.md @@ -1 +1,15 @@ # Setting Up the SenseGlove Default Classes + +Setting up the default SenseGlove classes is recommended if you want to take full advantage of the quality-of-life features provided by the SenseGlove Unreal Engine Plugin. These features are designed to streamline the development process within the Unreal Engine environment. For instance, if you need a quick setup with a virtual hand mesh already integrated into a pawn, enabling you to get started with your project in just a few minutes, it is essential to configure the default classes and familiarize yourself with these classes. + +If you wish to extend the functionality of these classes, you can do so by subclassing them. The default SenseGlove classes, which are prefixed with `SG`, include: + +- [SGPawn](sgpawn.md) +- [SGPlayerController](sgplayercontroller.md) +- [SGGameModeBase](ggamemodebase.md) +- [SGGameInstance](sggameinstance.md) +- [SGGameUserSettings](sggameusersettings.md) + +However, if you prefer a different approach or do not require the functionality provided by the default SenseGlove classes, you can opt to utilize individual components like `SGVirtualHandComponent`, `SGWristTrackerComponent`, etc., directly within your own actors. Alternatively, you can develop a completely custom system from scratch, leveraging the low-level SenseGlove [C++](../../low-level-api/cpp.md) or [Blueprint](../../low-level-api/blueprint.md) APIs. + +Additionally, you can [enforce setting the default SenseGlove classes during initialization](../../plugin-configuration/plugin-settings/initialization/) via [the plugin settings](../../plugin-configuration/plugin-settings/), if desired. diff --git a/Handbook/src/low-level-api/blueprints.md b/Handbook/src/low-level-api/blueprint.md similarity index 100% rename from Handbook/src/low-level-api/blueprints.md rename to Handbook/src/low-level-api/blueprint.md diff --git a/Handbook/src/plugin-configuration/plugin-settings/initialization/README.md b/Handbook/src/plugin-configuration/plugin-settings/initialization/README.md index cccc94eb..dfd80b7e 100644 --- a/Handbook/src/plugin-configuration/plugin-settings/initialization/README.md +++ b/Handbook/src/plugin-configuration/plugin-settings/initialization/README.md @@ -20,3 +20,5 @@ By default, this option is disabled. > - `Project Settings > Project > Maps & Modes > Default Modes > Selected GameMode > Player Controller Class` > - `Project Settings > Project > Maps & Modes > Game Instance > Game Instance Class` > - `Project Settings > Engine > General Settings > Default Classes > Advanced > Game User Settings Class` + +For more information visit [the SenseGlove default classes](../../../getting-started/setup-senseglove-default-classes/).