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

Refactor GameplayTag documentation and implementation

Browse Source 
- Updated references from GI_GameTagRegistry to DA_GameTagRegistry in architecture overview and implementation patterns documentation.
- Added new Blueprint specification for GI_StarterGameInstance, detailing its purpose, configuration, and integration pattern.
- Introduced DA_GameTagRegistry Blueprint specification, centralizing GameplayTag management and providing functions for tag validation and logging.
- Created documentation for the Starter GameInstance, outlining its role in the project setup and how other systems can integrate with it.
This commit is contained in:
Lefteris Notas
2026-05-20 14:31:52 +03:00
parent 3023ad3555
commit fee12b115f
17 changed files with 927 additions and 423 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/blueprints/INDEX.md
View File

@@ -1,6 +1,6 @@
# Master Blueprint Index — UE5 Modular Game Framework
**Version:** 3.0 | **Generated:** 2026-05-18 | **Total Files:** 135 numbered (129 original + 6 new)
**Version:** 3.1 | **Generated:** 2026-05-20 | **Total Files:** 135 numbered + 1 starter (136 total specs)
This document is the canonical index of every Blueprint specification file in the framework. Each entry links to its full spec document and includes: file name, asset type, parent class, purpose summary, and key dependencies.
@@ -14,6 +14,8 @@ docs/blueprints/
├── TEMPLATE.md ← Spec template v2.0
├── AUDIT_REPORT.md ← Clean slate audit
│
├── 00-project-setup/ ← Project Setup & Starter Assets (1 file)
│ └── GI_StarterGameInstance.md ← Minimal GameInstance; tag validation entry point
├── 01-core/ ← Foundation (7 files + 11 Data Table CSVs)
│ ├── data-tables/ ← Per-category Gameplay Tag Data Tables (NEW — replaces DT_ProjectTags.csv)
│ │ ├── DT_Tags_Player.csv (34 tags)
@@ -51,7 +53,8 @@ docs/blueprints/
| # | File Name | Asset Type | Parent Class | Short Purpose | Category |
|---|-----------|-----------|-------------|---------------|----------|
| 01 | [`01_GI_GameTagRegistry`](01-core/01_GI_GameTagRegistry.md) | `GI_` Game Instance | `GameInstance` | Central gameplay tag registry; maps tags to data/assets | 01-core |
| — | [`GI_StarterGameInstance`](00-project-setup/GI_StarterGameInstance.md) | `GI_` Game Instance | `GameInstance` | Minimal GameInstance; loads DA_GameTagRegistry, validates tags, broadcasts OnFrameworkReady | 00-project-setup |
| 01 | [`01_DA_GameTagRegistry`](01-core/01_DA_GameTagRegistry.md) | `DA_` Data Asset | `PrimaryDataAsset` | Central gameplay tag registry; maps tags to data/assets | 01-core |
| 02 | [`02_FL_GameUtilities`](01-core/02_FL_GameUtilities.md) | `FL_` Function Library | `BlueprintFunctionLibrary` | Shared utility functions (logging, tag queries, math) | 01-core |
| 03 | [`03_I_InterfaceLibrary`](01-core/03_I_InterfaceLibrary.md) | `I_` Interface | `Interface` | All framework interfaces (I_Damageable, I_Interactable, I_Persistable, etc.) | 01-core |
| 04 | [`04_GI_GameFramework`](01-core/04_GI_GameFramework.md) | `GI_` Game Instance | `GameInstance` | Application kernel; owns subsystems, game phases, platform init | 01-core |
@@ -210,7 +213,7 @@ docs/blueprints/
| `BPC_` | Blueprint Component | 80 |
| `BP_` | Blueprint Actor | 11 |
| `WBP_` | Widget Blueprint | 14 |
| `DA_` | Data Asset | 18 |
| `DA_` | Data Asset | 19 |
| `SS_` | GameInstance Subsystem | 7 |
| `GI_` | Game Instance | 2 |
| `GM_` | Game Mode | 1 |
@@ -220,7 +223,7 @@ docs/blueprints/
| `AI_` | AI Controller | 1 |
| `BB_` | Blackboard | 1 |
| `E_` | Enum | 5 |
| **Total** | | **145** |
| **Total** | | **146** |
---
@@ -280,8 +283,9 @@ Below are the most cross-referenced systems — these are the ones the State Man
| `BPC_PerformanceScaler` | 91 | `BPC_PersistentCorpseSystem` | 40 | | |
| `BPC_PersistentWorldStateRecorder` | 41 | `BPC_PhysicsDragSystem` | 22 | | |
| `FL_GameUtilities` | 2 | `GI_GameFramework` | 4 | | |
| `GI_GameTagRegistry` | 1 | `GM_CoreGameMode` | 5 | | |
| `GS_CoreGameState` | 6 | `I_HidingSpot` | 17 | | |
| `GI_StarterGameInstance` | — | `GI_GameTagRegistry` | 1 | `GM_CoreGameMode` | 5 |
| `DA_GameTagRegistry` | 1 | `GM_CoreGameMode` | 5 | | |
| `GS_CoreGameState` | 6 | `HidingSpot` | 17 | | |
| `I_InterfaceLibrary` | 3 | `I_Persistable` | 36 | | |
| `SS_AchievementSystem` | 103 | `SS_EnhancedInputManager` | 128 | | |
| `SS_SaveManager` | 35 | `SS_SettingsSystem` | 105 | | |