admin/UE5-Modular-Game-Framework
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add haptics example documentation for Project Void controller feedback

Browse Source 
- Introduced comprehensive guide for setting up controller haptics and force feedback.
- Detailed directory structure for haptic profiles and creation steps for DA_HapticProfile instances.
- Included platform-specific configurations for Xbox and PS5 DualSense adaptive triggers.
- Outlined wiring of BPC_HapticsController to various gameplay systems and events.
- Provided accessibility integration options and testing checklist for haptic functionality.
This commit is contained in:
Lefteris Notas
2026-05-22 17:16:34 +03:00
parent 7c2e8df6b1
commit 14441c000c
16 changed files with 1213 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/developer/INDEX.md
View File

@@ -1,6 +1,6 @@
# Developer Reference — UE5 Modular Game Framework
**Version:** 1.6 | **Generated:** 2026-05-22 | **Files:** 19 (1 index + 2 overview + 1 migration + 1 integration + 1 prototype + 1 starter + 10 category docs + 1 combined + 1 capture) | **C++:** 15 full + 10 stubs = 25 systems
**Version:** 1.7 | **Generated:** 2026-05-22 | **Files:** 20 (1 index + 2 overview + 1 migration + 1 integration + 1 prototype + 1 starter + 10 category docs + 1 combined + 1 capture + 1 haptics) | **C++:** 15 full + 10 stubs = 25 systems
This directory contains developer-facing reference documentation for every system in the framework. Unlike the blueprint spec files (which define *what* to build), these documents explain *how each system works internally* — the data flow, state machines, integration points, and design rationale. Use these when you need to understand a system's behavior to implement, debug, or extend it.
@@ -34,6 +34,10 @@ docs/developer/
├── 10-adaptive-systems.md ← Adaptive environment & atmosphere (systems 89-101, 132-133)
├── 11-16-systems.md ← Meta, Settings, Polish, Data Assets, Input, State (systems 102-135)
└── 17-capture-systems.md ← Planar Capture System — Mirrors, Portals, Monitors, Horror (systems 136-147)
## Haptics Reference
- **18-haptics-system.md** — Haptics Controller — Force feedback, DualSense triggers, heartbeat pulse, platform profiles (system 148)
- **game/haptics-example.md** — Project Void haptics walkthrough — wiring all game systems, platform tuning, testing checklist
```
## Quick Reference — Every System at a Glance
@@ -146,6 +150,7 @@ docs/developer/
| 103 | `SS_AchievementSystem` | Meta | Achievement subsystem |
| 104 | `BPC_AccessibilitySettings` | Settings | Accessibility settings |
| 105 | `SS_SettingsSystem` | Settings | Persistent settings subsystem |
| 148 | `BPC_HapticsController` | Settings | Haptics controller — force feedback, DualSense triggers, heartbeat pulse (NEW) |
| 106 | `BPC_AnalyticsTracker` | Polish | Analytics/telemetry |
| 107 | `BPC_DevCheatManager` | Polish | Developer cheats |
| 108 | `BPC_ErrorHandler` | Polish | Error/crash handling |
@@ -176,6 +181,7 @@ docs/developer/
| 133 | `BP_RoomAudioZone` | Adaptive | Room audio zone trigger |
| 134 | `DA_AudioSettings` | Data Assets | Audio bus/settings config |
| 135 | `DA_RoomAcousticPreset` | Data Assets | Room acoustic profile |
| 148 | `BPC_HapticsController` | Settings | Haptics controller — force feedback, DualSense triggers, heartbeat pulse |
## How to Use These Docs
@@ -201,4 +207,4 @@ docs/developer/
---
*Developer Reference Index v1.4 — Companion to the Blueprint Spec system. Update both together.*
*Developer Reference Index v1.5 — Companion to the Blueprint Spec system. Update both together.*