Upload files to "docs/audit-a"
Add audit a
This commit is contained in:
113
docs/audit-a/audit-request.md
Normal file
113
docs/audit-a/audit-request.md
Normal file
@@ -0,0 +1,113 @@
|
|||||||
|
# Audit Request: Cross-Reference Master Document vs Existing Blueprint Spec Files
|
||||||
|
|
||||||
|
## Goal
|
||||||
|
Systematically map every system defined in `UE5_Modular_Game_Framework.md` (3703 lines, ~131 systems across 13 sections) against the 83 existing blueprint spec files in `docs/blueprints/` to identify:
|
||||||
|
1. Which systems have corresponding blueprint spec files (Present)
|
||||||
|
2. Which systems are missing (Missing)
|
||||||
|
3. Which existing files have no clear corresponding master-document system (Orphaned / Renamed)
|
||||||
|
|
||||||
|
## Input Files
|
||||||
|
|
||||||
|
### Master Document
|
||||||
|
- `UE5_Modular_Game_Framework.md` (in workspace root)
|
||||||
|
|
||||||
|
### Existing Files (83 total)
|
||||||
|
Located under `docs/blueprints/` with the following structure:
|
||||||
|
```
|
||||||
|
docs/blueprints/
|
||||||
|
TEMPLATE.md
|
||||||
|
01-core/ (files 01-07)
|
||||||
|
02-player/ (files 08-15)
|
||||||
|
03-interaction/ (files 16-21)
|
||||||
|
04-inventory/ (files 22-27)
|
||||||
|
05-saveload/ (files 28-31)
|
||||||
|
06-ui/ (files 32-37)
|
||||||
|
07-narrative/ (files 38-48)
|
||||||
|
08-weapons/ (files 49-54)
|
||||||
|
09-ai/ (files 55-61)
|
||||||
|
10-adaptive/ (files 62-70)
|
||||||
|
11-polish/ (files 71-83)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Master Document Section Structure
|
||||||
|
|
||||||
|
| Section | Title | Table Count | Lines |
|
||||||
|
|---------|-------|-------------|-------|
|
||||||
|
| 1 | Core Framework Systems | 8 | 154-537 |
|
||||||
|
| 2 | Player State & Embodiment | 9 | 540-939 |
|
||||||
|
| 3 | Interaction & World Manipulation | 11 | 941-1305 |
|
||||||
|
| 4 | Inventory, Items & Collectibles | 12 | 1307-1643 |
|
||||||
|
| 5 | Weapon, Equipment & Damage | 10 | 1645-1892 |
|
||||||
|
| 6 | UI, Menus & Diegetic Presentation | 13 | 1894-2143 |
|
||||||
|
| 7 | Narrative, Dialogue, Objective & Choice | 11 | 2146-2467 |
|
||||||
|
| 8 | Save, Load, Persistence & Death Loop | 11 | 2469-2691 |
|
||||||
|
| 9 | Adaptive Environment, Atmosphere & Scare | 9 | 2693-2935 |
|
||||||
|
| 10 | AI, Perception & Encounters | 9 | 2937-3109 |
|
||||||
|
| 11 | Achievements, Progression & Meta | 10 | 3112-3286 |
|
||||||
|
| 12 | Settings, Accessibility & Platform | 9 | 3288-3389 |
|
||||||
|
| 13 | Editor / Data / Content Authoring | 9 | 3391-3498 |
|
||||||
|
|
||||||
|
## Existing Files Reference (83 files)
|
||||||
|
|
||||||
|
### 01-core/ (7 files)
|
||||||
|
01_GI_GameTagRegistry.md, 02_FL_GameUtilities.md, 03_I_InterfaceLibrary.md, 04_GI_GameFramework.md, 05_GM_CoreGameMode.md, 06_GS_CoreGameState.md, 07_DA_ItemData.md
|
||||||
|
|
||||||
|
### 02-player/ (8 files)
|
||||||
|
08_BPC_HealthSystem.md, 09_BPC_StaminaSystem.md, 10_BPC_StressSystem.md, 11_BPC_MovementStateSystem.md, 12_BPC_HidingSystem.md, 13_BPC_EmbodimentSystem.md, 14_BPC_CameraStateLayer.md, 15_BPC_PlayerMetricsTracker.md
|
||||||
|
|
||||||
|
### 03-interaction/ (6 files)
|
||||||
|
16_BPC_InteractionDetector.md, 17_BPC_PickupComponent.md, 18_I_HidingSpot.md, 19_BPC_LeverPuzzleComponent.md, 20_BPC_InteractableDoorComponent.md, 21_BPC_DiegeticDisplay.md
|
||||||
|
|
||||||
|
### 04-inventory/ (6 files)
|
||||||
|
22_BPC_InventoryComponent.md, 23_BPC_InventoryWeightSystem.md, 24_BPC_InventoryQuickSlot.md, 25_BPC_EquipmentSystem.md, 26_BPC_ContainerInventory.md, 27_BP_ItemPickup.md
|
||||||
|
|
||||||
|
### 05-saveload/ (4 files)
|
||||||
|
28_SS_SaveManager.md, 29_I_Persistable.md, 30_BPC_CheckpointSystem.md, 31_BPC_DeathHandlingSystem.md
|
||||||
|
|
||||||
|
### 06-ui/ (6 files)
|
||||||
|
32_SS_UIManager.md, 33_WBP_HUD.md, 34_WBP_InventoryUI.md, 35_WBP_InteractionUI.md, 36_WBP_MenuWidgets.md, 37_WBP_AccessibilityUI.md
|
||||||
|
|
||||||
|
### 07-narrative/ (11 files)
|
||||||
|
38_BPC_NarrativeStateSystem.md, 39_BPC_ObjectiveSystem.md, 40_BPC_DialoguePlaybackSystem.md, 41_BPC_DialogueChoiceSystem.md, 42_BPC_BranchingConsequenceSystem.md, 43_BPC_TrialScenarioSystem.md, 44_BPC_CutsceneBridge.md, 45_BPC_EndingAccumulatorSystem.md, 46_BPC_LoreUnlockSystem.md, 47_BPC_NarrativeTriggerVolume.md, 48_DA_NarrativeDataAssets.md
|
||||||
|
|
||||||
|
### 08-weapons/ (6 files)
|
||||||
|
49_BP_WeaponBase.md, 50_BP_RangedWeapon.md, 51_BP_MeleeWeapon.md, 52_BPC_AmmoComponent.md, 53_BPC_DamageHandlerComponent.md, 54_BPC_CombatFeedbackComponent.md
|
||||||
|
|
||||||
|
### 09-ai/ (7 files)
|
||||||
|
55_BPC_AIControllerBase.md, 56_BPC_PerceptionComponent.md, 57_BPC_BehaviorTreeManager.md, 58_BP_EnemyBase.md, 59_BP_PatrolPath.md, 60_BPC_AlertSystem.md, 61_BPC_AIStateMachine.md
|
||||||
|
|
||||||
|
### 10-adaptive/ (9 files)
|
||||||
|
62_BPC_DifficultyManager.md, 63_BPC_FearSystem.md, 64_BPC_AtmosphereController.md, 65_BPC_LightingManager.md, 66_BPC_AudioManager.md, 67_BPC_VFXManager.md, 68_BP_DynamicEvent.md, 69_BPC_PerformanceScaler.md, 70_BPC_ProceduralEncounter.md
|
||||||
|
|
||||||
|
### 11-polish/ (13 files)
|
||||||
|
71_SS_SettingsManager.md, 72_BPC_AccessibilitySettings.md, 73_BPC_TutorialSystem.md, 74_BPC_AchievementManager.md, 75_BPC_StatsTracker.md, 76_BPC_LoadingScreen.md, 77_WBP_CreditsScreen.md, 78_WBP_SplashScreen.md, 79_BPC_FPSCounter.md, 80_BPC_DevCheatManager.md, 81_WBP_DebugMenu.md, 82_BPC_AnalyticsTracker.md, 83_BPC_ErrorHandler.md
|
||||||
|
|
||||||
|
## Methodology
|
||||||
|
|
||||||
|
Read each section of the master document and extract:
|
||||||
|
- Every named system (by its prefix + name, e.g., `BPC_HealthSystem`, `BP_DoorActor`, `SS_SaveSystem`, `WBP_HUDController`)
|
||||||
|
- Cross-reference against the 83 existing files by matching:
|
||||||
|
- Exact name match (e.g., `BPC_HealthSystem` → `08_BPC_HealthSystem.md`)
|
||||||
|
- Semantic match (e.g., `SS_SaveSystem` in master doc → `28_SS_SaveManager.md` on disk)
|
||||||
|
- Bundled match (e.g., `WBP_MainMenu`, `WBP_PauseMenu`, `WBP_SettingsMenu` in master doc → `36_WBP_MenuWidgets.md` on disk)
|
||||||
|
|
||||||
|
## Output Format
|
||||||
|
|
||||||
|
Produce a Markdown table for each section of the master document with columns:
|
||||||
|
| Master Doc System | Corresponding File | Status | Notes |
|
||||||
|
|---|---|---|---|
|
||||||
|
| `BPC_HealthSystem` | `08_BPC_HealthSystem.md` | ExactMatch | Same name |
|
||||||
|
| `SS_SaveSystem` | `28_SS_SaveManager.md` | RenamedMatch | Master calls it SaveSystem, file calls it SaveManager |
|
||||||
|
| `BPC_InteractionExecutor` | (none) | Missing | No corresponding file |
|
||||||
|
|
||||||
|
Also flag files that exist on disk but have no obvious match in the master document (orphaned).
|
||||||
|
|
||||||
|
## Final Summary
|
||||||
|
At the end, provide:
|
||||||
|
1. Count of ExactMatch systems
|
||||||
|
2. Count of RenamedMatch systems
|
||||||
|
3. Count of Missing systems
|
||||||
|
4. Count of Orphaned files
|
||||||
|
5. Total systems in master doc
|
||||||
|
6. Total files on disk
|
||||||
|
7. List of all missing system names organized by their source section
|
||||||
Reference in New Issue
Block a user