feat: Update README files to provide detailed project structure and usage instructions for Wolfenstein 3D workspace

Signed-off-by: Hans Kokx <hans.d.kokx@gmail.com>
2026-03-24 14:53:25 +01:00
parent 8a9be477e4
commit a08af99b6f
6 changed files with 442 additions and 28 deletions
@@ -0,0 +1,52 @@
+# wolf_3d_assets
+
+Shared asset package that exposes Wolfenstein 3D game-data trees for workspace apps.
+
+## What This Package Is
+
+`wolf_3d_assets` is a content package used by Flutter hosts to bundle known asset directories.
+
+This package does not expose runtime logic APIs; it exists to provide structured asset roots consumed by hosts and tooling.
+
+## Current Asset Layout
+
+Configured asset roots (see `pubspec.yaml`):
+
+- `assets/retail/`
+- `assets/shareware/`
+- `assets/sod/shareware/`
+
+## Setup
+
+From this directory:
+
+```bash
+flutter pub get
+```
+
+## How Hosts Consume It
+
+- Dependent Flutter apps/packages include `wolf_3d_assets` as a workspace dependency.
+- Flutter build tooling includes directories listed in this package `pubspec.yaml`.
+- Runtime data discovery/selection is handled by host and engine packages.
+
+## Maintenance Guidelines
+
+When updating assets:
+
+1. Preserve directory structure conventions by game/version.
+2. Update `pubspec.yaml` asset entries if new top-level roots are introduced.
+3. Validate that host apps still discover and load the updated data sets.
+
+## Verification
+
+Because this is a content package, verification is integration-focused:
+
+- run `apps/wolf_3d_gui` and confirm expected data appears,
+- run `apps/wolf_3d_cli` with explicit `--data-directory` when testing local trees.
+
+## Related Modules
+
+- Core runtime: [`../wolf_3d_dart/README.md`](../wolf_3d_dart/README.md)
+- Flutter integration package: [`../wolf_3d_flutter/README.md`](../wolf_3d_flutter/README.md)
+- Workspace overview: [`../../README.md`](../../README.md)