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

feat: Add Project Setup & Migration Guide and update Developer Reference Index

Browse Source
This commit is contained in:
Lefteris Notas
2026-05-19 19:34:02 +03:00
parent 209f24a0f8
commit 1d699e54fa
3 changed files with 397 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/developer/INDEX.md
View File

@@ -1,6 +1,6 @@
# Developer Reference — UE5 Modular Game Framework
**Version:** 1.1 | **Generated:** 2026-05-19 | **Files:** 14 (1 index + 2 overview + 10 category docs + 1 combined) | **Networking:** All docs include multiplayer sections
**Version:** 1.2 | **Generated:** 2026-05-19 | **Files:** 15 (1 index + 2 overview + 1 migration + 10 category docs + 1 combined) | **Networking:** All docs include multiplayer sections
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.
@@ -18,6 +18,7 @@ docs/developer/
├── INDEX.md ← THIS FILE
├── architecture-overview.md ← Framework-wide architecture walkthrough
├── implementation-patterns.md ← Common UE5 Blueprint patterns used
├── project-setup-migration.md ← Project setup & migration guide (NEW — Project Settings, plugins, init sequence)
│
├── 01-core-foundation.md ← Foundation systems (systems 01-07)
├── 02-player-systems.md ← Player state & embodiment (systems 08-15)
@@ -175,10 +176,12 @@ docs/developer/
## How to Use These Docs
1. **New to the framework?** Start with [`architecture-overview.md`](architecture-overview.md) to understand the big picture.
2. **Implementing a system?** Find it in the quick reference above, then read its category document.
3. **Debugging?** Each category doc includes a data flow section showing how data moves between systems.
4. **Need implementation patterns?** See [`implementation-patterns.md`](implementation-patterns.md) for common UE5 Blueprint patterns.
5. **Multiplayer networking?** See [`../architecture/multiplayer-networking.md`](../architecture/multiplayer-networking.md) for the full networking architecture. Every category doc has a Multiplayer Networking section.
2. **Setting up a new project?** Read [`project-setup-migration.md`](project-setup-migration.md) — covers all Project Settings, plugins, Data Tables, Enhanced Input, and initialization sequence.
3. **Implementing a system?** Read the Blueprint Spec in `docs/blueprints/` — every file has a Manual Implementation Guide with node-by-node logic.
4. **Need to understand internals?** Read the corresponding Developer Reference doc in this directory.
5. **Debugging?** Each category doc includes a data flow section showing how data moves between systems.
6. **Need UE5 Blueprint patterns?** See [`implementation-patterns.md`](implementation-patterns.md).
7. **Multiplayer networking?** See [`../architecture/multiplayer-networking.md`](../architecture/multiplayer-networking.md). Every doc has a Multiplayer Networking section.
## Relationship to Spec Files
@@ -187,8 +190,8 @@ docs/developer/
| **Purpose** | Define what to build with node-by-node logic (v2.0) | Explain how it works (understanding) |
| **Audience** | Implementers building Blueprints manually | Anyone needing to understand internals |
| **Content** | Enums, structs, variables, functions, **Manual Implementation Guide** | Data flow, state machines, design rationale |
| **Format** | TEMPLATE.md v2.0 — includes Build Checklist | Per-category reference docs |
| **Format** | TEMPLATE.md v2.0 — includes Build Checklist | Per-category reference docs + project-setup-migration.md |
---
*Developer Reference Index v1.0 — Companion to the Blueprint Spec system. Update both together.*
*Developer Reference Index v1.2 — Companion to the Blueprint Spec system. Update both together.*