Files
Plugin/Handbook/src/appendix/directory-structure.md
T

190 lines
9.6 KiB
Markdown
Raw Normal View History

# 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 [Fab](https://www.fab.com/))
├── 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)
2024-08-18 01:44:56 +02:00
├── SenseGloveBackendKismet (exposes Blueprint-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)
2024-08-18 01:44:56 +02:00
├── SenseGloveConnectKismet (SGConnect functionality exposed to Blueprint)
├── SenseGloveCore (exposes part of the SGCoreCpp low-level API to C++)
├── SenseGloveCoreImpl (uses Exceptions and RTTI, intended for internal use only)
2024-08-18 01:44:56 +02:00
├── SenseGloveCoreKismet (SGCoreCpp functionality exposed to Blueprint)
├── SenseGloveDebug (a utility debug module)
2024-08-18 01:44:56 +02:00
├── SenseGloveDebugKismet (exposes Blueprint-specific functionality from the SenseGloveDebug module)
├── SenseGloveEditor (the Editor module)
├── SenseGloveInterop (internally used for interoperability between RTTI disabled/enabled modules)
2024-08-18 01:44:56 +02:00
├── SenseGloveKismet (exposes Blueprint-specific functionality from the SenseGlove module)
├── SenseGloveLog (the internal log module)
├── SenseGloveSettings (the plugin's settings manager)
2024-08-18 01:44:56 +02:00
├── SenseGloveSettingsKismet (exposes Blueprint-specific functionality from the SenseGloveSettings module)
├── SenseGloveTracking (provides XR_EXT_hand_tracking support, HMD auto-detection, and SenseGlove device tracking)
2024-08-18 01:44:56 +02:00
├── SenseGloveTrackingKismet (exposes Blueprint-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)
│ │
│ ├── debug
│ │
│ └── release
├── include (header files)
│ │
│ ├── boost
│ │
│ ├── SenseGlove
│ │ │
│ │ ├── BLE (SGBLE headers)
│ │ │
│ │ ├── 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
│ │ │
│ │ ├── rustc (GNU/Linux binary dependencies built with Rust)
│ │ │ │
│ │ │ ├── aarch64 (dependencies targeting GNU/Linux AArch64 architecture)
│ │ │ │ │
│ │ │ │ ├── debug
│ │ │ │ │
│ │ │ │ └── release
│ │ │ │
│ │ │ └── x86-64 (dependencies targeting GNU/Linux x86-64 architecture)
│ │ │ │
│ │ │ ├── debug
│ │ │ │
│ │ │ └── release
│ │ │
│ │ ├── v22 (UE 5.3 and 5.4 GNU/Linux dependencies)
│ │ │ │
│ │ │ ├── aarch64 (dependencies targeting GNU/Linux AArch64 architecture)
│ │ │ │ │
│ │ │ │ ├── debug
│ │ │ │ │
│ │ │ │ └── release
│ │ │ │
│ │ │ └── x86-64 (dependencies targeting GNU/Linux x86-64 architecture)
│ │ │ │
│ │ │ ├── debug
│ │ │ │
│ │ │ └── release
│ │ │
│ │ ├── v23 (UE 5.5 GNU/Linux dependencies)
│ │ │ │
│ │ │ ├── aarch64 (dependencies targeting GNU/Linux AArch64 architecture)
│ │ │ │ │
│ │ │ │ ├── debug
│ │ │ │ │
│ │ │ │ └── release
│ │ │ │
│ │ │ └── x86-64 (dependencies targeting GNU/Linux x86-64 architecture)
│ │ │ │
│ │ │ ├── debug
│ │ │ │
│ │ │ └── release
│ │ │
│ │ └── v25 (UE 5.6 GNU/Linux dependencies)
│ │ │
│ │ ├── aarch64 (dependencies targeting GNU/Linux AArch64 architecture)
│ │ │ │
│ │ │ ├── debug
│ │ │ │
│ │ │ └── release
│ │ │
│ │ └── x86-64 (dependencies targeting GNU/Linux x86-64 architecture)
│ │ │
│ │ ├── debug
│ │ │
│ │ └── release
│ │
│ └── win64
│ │
│ ├── msvc142 (Microsoft Visual Studio 2019 dependencies)
│ │ │
│ │ ├── debug
│ │ │
│ │ └── release
│ │
│ ├── msvc143 (Microsoft Visual Studio 2022 dependencies)
│ │ │
│ │ ├── debug
│ │ │
│ │ └── release
│ │
│ └── rustc (Microsoft Windows binary dependencies built with Rust)
│ │
│ ├── debug
│ │
│ └── release
├── SGBleThirdPartyLibs (Third-party module providing SGBLE headers and libraries)
├── SGConnectThirdPartyHeaders (Third-party module providing SGConnect headers)
├── SGConnectThirdPartyLibs (Third-party module providing SGConnect headers and libraries)
├── SGCoreThirdPartyLibs (Third-party module providing SGCore headers and libraries)
└── SGSerialThirdPartyLibs (Third-party module providing github.com/wjwwood/serial headers and libraries)
```