53 lines
1.5 KiB
Markdown
53 lines
1.5 KiB
Markdown
# 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)
|