From 22bf3eb6b957558d25366a6e8ac07a10cbc1832b Mon Sep 17 00:00:00 2001 From: naumueller Date: Fri, 27 Mar 2026 08:01:40 +0100 Subject: [PATCH] docs: integrate Prototyp1_README_EN into docs index and cross-links --- README.md | 1 + docs/ARCHITECTURE.md | 2 ++ docs/INDEX.md | 11 +++++++---- docs/Prototyp1_README_EN.md | 3 +-- docs/SETUP_AND_RUN.md | 2 ++ 5 files changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5035cb3..3c2d3a0 100644 --- a/README.md +++ b/README.md @@ -155,6 +155,7 @@ src/main/resources - [Configuration](docs/CONFIGURATION.md) - [Testing](docs/TESTING.md) - [Source Map](docs/SOURCE_MAP.md) +- [Unreal Avatar](docs/Prototyp1_README_EN.md) - [Known Issues](docs/KNOWN_ISSUES.md) ## Known Limitations diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 6dc75c7..18b1a7e 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -74,6 +74,8 @@ Persistence schema (`binary_event`): - **External processes**: optional Python simulator and Unreal launcher script. - **Animation output**: JSON file written to `animation.output.path`. +For Unreal-specific implementation details, see [Unreal Avatar Prototype](Prototyp1_README_EN.md). + ## Shutdown Behavior `ApplicationShutdownManager` performs: diff --git a/docs/INDEX.md b/docs/INDEX.md index b7effeb..2f5f155 100644 --- a/docs/INDEX.md +++ b/docs/INDEX.md @@ -7,10 +7,11 @@ This folder contains detailed technical documentation for the project. 1. [Project Review](PROJECT_REVIEW.md) 2. [Architecture](ARCHITECTURE.md) 3. [Setup and Run](SETUP_AND_RUN.md) -4. [Configuration](CONFIGURATION.md) -5. [Testing](TESTING.md) -6. [Known Issues](KNOWN_ISSUES.md) -7. [Source Map](SOURCE_MAP.md) +4. [Unreal Avatar Prototype](Prototyp1_README_EN.md) +5. [Configuration](CONFIGURATION.md) +6. [Testing](TESTING.md) +7. [Known Issues](KNOWN_ISSUES.md) +8. [Source Map](SOURCE_MAP.md) ## Document Guide @@ -20,6 +21,8 @@ This folder contains detailed technical documentation for the project. Component responsibilities, runtime data flow, and integration boundaries. - [Setup and Run](SETUP_AND_RUN.md) Reproducible setup for minimal and full integration modes. +- [Unreal Avatar Prototype](Prototyp1_README_EN.md) + Unreal Engine prototype details (MetaHuman setup, assets, animation pipeline, and plugin requirements). - [Configuration](CONFIGURATION.md) Complete key reference, validation behavior, and script environment mapping. - [Testing](TESTING.md) diff --git a/docs/Prototyp1_README_EN.md b/docs/Prototyp1_README_EN.md index f600e61..619007b 100644 --- a/docs/Prototyp1_README_EN.md +++ b/docs/Prototyp1_README_EN.md @@ -51,7 +51,7 @@ The character Blueprint is the main logic blueprint. All character logic is handled inside the Blueprint class. -A picture of the current blueprint is in: docs/docs/blueprint.jpeg +Current blueprint image: [docs/blueprint.png](docs/blueprint.png) --- @@ -174,4 +174,3 @@ Password: 6gn56CZ6JyZzG4G Created on: 2026-03-24 - diff --git a/docs/SETUP_AND_RUN.md b/docs/SETUP_AND_RUN.md index b774f7a..0535892 100644 --- a/docs/SETUP_AND_RUN.md +++ b/docs/SETUP_AND_RUN.md @@ -28,6 +28,8 @@ unreal.enabled=false ### Mode B: Full integration run Enable simulator and/or Unreal startup only after all referenced paths are valid on your machine. +For Unreal Engine prototype setup details (MetaHuman, assets, plugins, and animation flow), see +[Unreal Avatar Prototype](Prototyp1_README_EN.md). ## Build