zwitschi
5ab8b556f3
Split the former ROADMAP.md checklists into TODO.md, which now holds all actionable work and progress marks. ROADMAP.md keeps milestone goals, scope, and release gates as prose with no checkboxes. Update AGENTS.md, Docs/, Geo/README.md, MEMORY.md, and README.md to point to the new file roles.
48 lines
2.8 KiB
Markdown
48 lines
2.8 KiB
Markdown
# Gig Line
|
|
|
|
A Linux-first Unreal Engine game about walking and driving through a real city. The first release, `0.1.0`, is a walkable exterior demo around **6840 Hollywood Blvd / El Capitan Entertainment Centre**, covering the south-side frontage between Highland Avenue and Orange Drive plus the north-side frontage within 50 m of the boulevard.
|
|
|
|
## Status
|
|
|
|
`0.1.0` is in progress. The workstation, engine, geo pipeline and project bootstrap are done and verified; a walkable `DemoMap` exists with terrain, street, sidewalks, kerbs and the hero façade placed from measured coordinates. Façades are still blockouts, and materials are flat colours — both are planned patches.
|
|
|
|
Current tasks are in [TODO.md](TODO.md) and the development plan is in [ROADMAP.md](ROADMAP.md); what was learned the hard way is in [MEMORY.md](MEMORY.md).
|
|
|
|
## Layout
|
|
|
|
| Path | Contents |
|
|
| --- | --- |
|
|
| `Game/` | Unreal project, configuration, source, game-ready content |
|
|
| `Art/` | Editable Blender sources, blockouts, terrain, street, hero façade, and a local (uncommitted) reference library |
|
|
| `Geo/` | Source manifests, permitted geographic data, and every geographic tool |
|
|
| `Tools/` | Unreal-side importers, level builders, and reference gathering |
|
|
| `Docs/` | Setup, toolchain pins, build and content pipeline, licensing, release checks |
|
|
| `Screenshots/` | Rendered review captures and their approval state |
|
|
|
|
## Getting started
|
|
|
|
```bash
|
|
git lfs install # required: content, images, audio, and geo files are LFS-tracked
|
|
git lfs pull
|
|
Tools/check-lfs.sh # verifies the lfs filter is active and files are stored as pointers
|
|
```
|
|
|
|
The engine is installed outside the repository and pinned in [Docs/toolchain.md](Docs/toolchain.md). Setup is in [Docs/setup.md](Docs/setup.md); building and the content pipeline are in [Docs/build.md](Docs/build.md).
|
|
|
|
## Documents
|
|
|
|
- [TODO.md](TODO.md) — living task list, source of truth for progress
|
|
- [ROADMAP.md](ROADMAP.md) — development plan: milestone goals, scope, and release gates
|
|
- [MEMORY.md](MEMORY.md) — shared session memory: discoveries, traps, decisions
|
|
- [AGENTS.md](AGENTS.md) — contributor and agent rules
|
|
- [PLAN.md](PLAN.md) — scope, stack, release policy, timeline
|
|
- [Docs/toolchain.md](Docs/toolchain.md) · [Docs/environment.md](Docs/environment.md) — pins and workstation audit
|
|
- [Docs/build.md](Docs/build.md) — fresh-checkout build and content pipeline
|
|
- [Docs/release-checks.md](Docs/release-checks.md) — release gates
|
|
- [Docs/licensing.md](Docs/licensing.md) · [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md) — licensing
|
|
- [CHANGELOG.md](CHANGELOG.md) — release history
|
|
|
|
## Licensing
|
|
|
|
Code licence is an open decision (MIT proposed). Engine, art, and geographic data are licensed separately; see [Docs/licensing.md](Docs/licensing.md). OSM-derived output carries "© OpenStreetMap contributors".
|