add the introduction to the senseglove default classes

2024-08-16 18:01:49 +02:00
parent 52386cf471
commit 35294a9ab5
4 changed files with 18 additions and 2 deletions
@@ -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)
+- [ℹ️](misc/build-information.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.
@@ -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/).