UnrealEngine/Plugin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

reorganize the handbook structure and add new sections

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
Handbook/src/appendix/directory-structure.md
+139
View File
@@ -0,0 +1,139 @@
# Directory Structure
```
/
│
├── Config
│
├── Documentation (this will be generated by running the <code>make</code> command inside the Handbook directory)
│
├── Handbook (this is the mdBook source code, used to generate the Documentation folder and not distributed to the Unreal Engine Marketplace)
│
├── Resources
│
└── Source (various plug-in modules)
│
├── SenseGlove (the UE-specific high-level API)
│
├── SenseGloveAndroid (the Android-specific module)
│
├── SenseGloveBackend (responsible for initialization and deinitialization of the backend libraries)
│
├── SenseGloveBackendKismet (exposes Blueprints-specific functionality from the SenseGloveBackend module)
│
├── SenseGloveBuildHacks (uses Exceptions and RTTI, internally used for compiler-specific build hacks)
│
├── SenseGloveConnect (exposes part of the SGConnect low-level API to C++)
│
├── SenseGloveConnectImpl (uses Exceptions and RTTI, intended for internal use only)
│
├── SenseGloveConnectKismet (SGConnect functionality exposed to Blueprints)
│
├── SenseGloveCore (exposes part of the SGCoreCpp low-level API to C++)
│
├── SenseGloveCoreImpl (uses Exceptions and RTTI, intended for internal use only)
│
├── SenseGloveCoreKismet (SGCoreCpp functionality exposed to Blueprints)
│
├── SenseGloveDebug (a utility debug module)
│
├── SenseGloveDebugKismet (exposes Blueprints-specific functionality from the SenseGloveDebug module)
│
├── SenseGloveEditor (the Editor module)
│
├── SenseGloveInterop (internally used for interoperability between RTTI disabled/enabled modules)
│
├── SenseGloveKismet (exposes Blueprints-specific functionality from the SenseGlove module)
│
├── SenseGloveLog (the internal log module)
│
├── SenseGloveSettings (the plugin's settings manager)
│
├── SenseGloveSettingsKismet (exposes Blueprints-specific functionality from the SenseGloveSettings module)
│
├── SenseGloveTracking (provides XR_EXT_hand_tracking support, HMD auto-detection, and SenseGlove device tracking)
│
├── SenseGloveTrackingKismet (exposes Blueprints-specific functionality from the SenseGloveTracking module)
│
├── SenseGloveTypes (exposes various enums from the backend libraries and also types from the SenseGlove module)
│
├── SenseGloveUtils (the internal utility module)
│
└── ThirdParty (3rd-party dependencies)
│
├── android (.jar file Java libraries for Android)
│
├── include (header files)
│ │
│ ├── boost
│ │
│ ├── SenseGlove
│ │ │
│ │ ├── Connect (SGConnect headers)
│ │ │
│ │ └── Core (SGCoreCpp headers)
│ │
│ └── serial
│
└── lib (platform-specific pre-built binary dependencies)
│
├── android
│ │
│ └── r25b (Android NDK r25b dependencies for UE 5.1+)
│ │
│ ├── arm64 (64-bit ARM variant of Android)
│ │ │
│ │ ├── debug
│ │ │
│ │ └── release
│ │
│ └── x64 (64-bit x86-64 variant of Android)
│ │
│ ├── debug
│ │
│ └── release
│
├── linux
│ │
│ ├── v21 (UE 5.2 Linux dependencies)
│ │ │
│ │ ├── aarch64 (dependencies targeting AArch64 Linux architecture)
│ │ │ │
│ │ │ ├── debug
│ │ │ │
│ │ │ └── release
│ │ │
│ │ └── x86-64 (dependencies targeting x86-64 Linux architecture)
│ │ │
│ │ ├── debug
│ │ │
│ │ └── release
│ │
│ └── v22 (UE 5.3 and 5.4 Linux dependencies)
│ │
│ ├── aarch64 (dependencies targeting AArch64 Linux architecture)
│ │ │
│ │ ├── debug
│ │ │
│ │ └── release
│ │
│ └── x86-64 (dependencies targeting x86-64 Linux architecture)
│ │
│ ├── debug
│ │
│ └── release
│
└── win64
│
├── msvc142 (Microsoft Visual Studio 2019 dependencies)
│ │
│ ├── debug
│ │
│ └── release
│
└── msvc143 (Microsoft Visual Studio 2022 dependencies)
│
├── debug
│
└── release
```