# neospark314/godot_oculus_quest_toolkit architecture

> Architecture diagram of the GitHub repository neospark314/godot_oculus_quest_toolkit, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/neospark314/godot_oculus_quest_toolkit
- Repository: https://github.com/neospark314/godot_oculus_quest_toolkit

## Overview

##### Main Components

a. Core VR Components:
- ARVROrigin (Central VR setup)
- ARVRCamera (Stereo rendering)
- Controllers (Left/Right)
- Hand Tracking System

b. Feature Modules:
- Locomotion Systems
- Interaction Systems
- UI Systems
- Physics Integration
- Mixed Reality Capture

**┌─ Application Layer ─────────────────────┐**
- Demo Games / Demo Scenes                │
- ┘
**┌─ Feature Layer ──────────────────────────┐**
- UI2D System  │ Locomotion │ Interactions │
- VR Settings  │ Climbing   │ Grab System  │
- ┘
**┌─ Core VR Layer ──────────────────────────┐**
- ARVROrigin │ ARVRCamera │ Controllers   │
- Hand Tracking│ Tracking  │ Input System  │
- ┘
**┌─ Platform Layer ─────────────────────────┐**
- Oculus SDK │ OpenXR │ WebXR │ DesktopVR │
- ┘

##### Component Relationships

- Data flow between components
- Inheritance relationships
- Dependencies
- Event propagation

**Controller Input → Input System → Feature Modules**
- → Hand Tracking → Gesture Detection

**ARVRCamera → Stereo Rendering → Mixed Reality Capture**

**Controllers → Grab System → Physics Objects**
- → UI Interaction → UI2D System

##### Implementation Details

Notes for:
- File locations (OQ_Toolkit structure)
- Core script references
- Platform-specific implementations
- Configuration requirements

##### Additional Elements

- Version compatibility (Godot 3.4.5)
- External dependencies
- Platform support matrix
- Feature availability per platform

- Modular architecture
- Platform independence where possible
- Clear separation of core VR functionality from features
- Extensibility points for custom implementations

Remember to highlight the toolkit's primary features:
- Controller handling
- UI systems
- Locomotion
- Physics interactions
- Hand tracking
- Mixed reality capture

This will create a clear visualization of how the toolkit integrates with Godot's engine while providing VR functionality across multiple platforms.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Platform Layer
    subgraph PlatformLayer["Platform Layer"]
        OculusSDK["Oculus SDK"]:::platform
        OpenXR["OpenXR"]:::platform
        WebXR["WebXR"]:::platform
        DesktopVR["Desktop VR"]:::platform
        PlatformIntegration["Platform Integration"]:::platform
    end

    %% Core VR Layer
    subgraph CoreVRLayer["Core VR Layer"]
        ARVROrigin["ARVROrigin"]:::core
        ARVRCamera["ARVRCamera"]:::core
        Controllers["Controllers System"]:::core
        HandTracking["Hand Tracking"]:::core
        InputSystem["Input System"]:::core
        TrackingSystem["Tracking System"]:::core
    end

    %% Feature Layer
    subgraph FeatureLayer["Feature Layer"]
        UI2DSystem["UI2D System"]:::feature
        LocomotionSystems["Locomotion Systems"]:::feature
        ClimbingSystem["Climbing System"]:::feature
        GrabSystem["Grab System"]:::feature
        PhysicsIntegration["Physics Integration"]:::feature
        VRSettings["VR Settings"]:::feature
    end

    %% Application Layer
    subgraph ApplicationLayer["Application Layer"]
        DemoScenes["Demo Scenes"]:::app
        MixedRealityCapture["Mixed Reality Capture"]:::app
    end

    %% Relationships
    PlatformIntegration --> ARVROrigin
    ARVROrigin --> ARVRCamera
    ARVROrigin --> Controllers
    ARVROrigin --> HandTracking
    Controllers --> InputSystem
    HandTracking --> InputSystem
    
    InputSystem --> UI2DSystem
    InputSystem --> LocomotionSystems
    InputSystem --> GrabSystem
    
    GrabSystem --> PhysicsIntegration
    ClimbingSystem --> PhysicsIntegration
    
    ARVRCamera --> MixedRealityCapture
    VRSettings --> ARVROrigin

    %% Click Events
    click ARVROrigin "https://github.com/NeoSpark314/godot_oculus_quest_toolkit/blob/master/OQ_Toolkit/OQ_ARVROrigin/scripts/OQ_ARVROrigin.gd"
    click ARVRCamera "https://github.com/NeoSpark314/godot_oculus_quest_toolkit/blob/master/OQ_Toolkit/OQ_ARVRCamera/scripts/OQ_ARVRCamera.gd"
    click Controllers "https://github.com/NeoSpark314/godot_oculus_quest_toolkit/blob/master/OQ_Toolkit/OQ_ARVRController/scripts/OQ_ARVRController.gd"
    click HandTracking "https://github.com/NeoSpark314/godot_oculus_quest_toolkit/blob/master/OQ_Toolkit/OQ_ARVRController/Feature_HandModel_Left.tscn"
    click UI2DSystem "https://github.com/NeoSpark314/godot_oculus_quest_toolkit/tree/master/OQ_Toolkit/OQ_UI2D/"
    click LocomotionSystems "https://github.com/NeoSpark314/godot_oculus_quest_toolkit/blob/master/OQ_Toolkit/OQ_ARVROrigin/Locomotion_Stick.tscn"
    click ClimbingSystem "https://github.com/NeoSpark314/godot_oculus_quest_toolkit/blob/master/OQ_Toolkit/OQ_ARVROrigin/Feature_Climbing.tscn"
    click GrabSystem "https://github.com/NeoSpark314/godot_oculus_quest_toolkit/blob/master/OQ_Toolkit/OQ_ARVRController/Feature_RigidBodyGrab.tscn"
    click MixedRealityCapture "https://github.com/NeoSpark314/godot_oculus_quest_toolkit/blob/master/OQ_Toolkit/OQ_ARVROrigin/Feature_MixedRealityCapture.tscn"
    click PlatformIntegration "https://github.com/NeoSpark314/godot_oculus_quest_toolkit/tree/master/addons/godot_ovrmobile/"
    click PhysicsIntegration "https://github.com/NeoSpark314/godot_oculus_quest_toolkit/blob/master/OQ_Toolkit/OQ_Classes/OQClass_GrabbableRigidBody.gd"
    click VRSettings "https://github.com/NeoSpark314/godot_oculus_quest_toolkit/blob/master/OQ_Toolkit/OQ_UI2D/OQ_UI2DVRSettings.tscn"

    %% Styles
    classDef platform fill:#FFE873,stroke:#333,stroke-width:2px
    classDef core fill:#7CB9E8,stroke:#333,stroke-width:2px
    classDef feature fill:#90EE90,stroke:#333,stroke-width:2px
    classDef app fill:#DDA0DD,stroke:#333,stroke-width:2px
```
