zwitschi
01939de9a0
AGENTS.md now states that planned work is checkbox items in ROADMAP.md marked open, in progress, or done, and that discoveries, gotchas, notes, and bugs go to MEMORY.md for coordination between collaborators. MEMORY.md is seeded with what this build-up actually cost: the Unreal read-only-home crash, Blender/Blosm headless workarounds and the spherical projection, the tiled-TIFF DEM trap, the reference licensing and throttling rules, and the LFS silent-blob trap. Also stages the concurrently created Unreal project files, and stops per-project Build/ output (FileOpenOrder logs) from entering the repository.
44 lines
2.2 KiB
Markdown
44 lines
2.2 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
|
|
|
|
Pre-production. Workstation setup and repository scaffolding are in progress; no engine, content, or geographic data is committed yet. Current state is tracked in [ROADMAP.md](ROADMAP.md), and the per-task setup state in [Docs/setup.md](Docs/setup.md).
|
|
|
|
## Layout
|
|
|
|
| Path | Contents |
|
|
| --- | --- |
|
|
| `Game/` | Unreal project, configuration, source, game-ready content |
|
|
| `Art/` | Editable Blender files and original textures |
|
|
| `Geo/` | Source manifests, permitted geographic data, processing scripts |
|
|
| `Tools/` | Repeatable import/export helpers |
|
|
| `Docs/` | Setup, toolchain pins, licensing, release checks |
|
|
|
|
## 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). The full procedure is in [Docs/setup.md](Docs/setup.md).
|
|
|
|
## Documents
|
|
|
|
- [ROADMAP.md](ROADMAP.md) — living task list, source of truth for progress
|
|
- [PLAN.md](PLAN.md) — scope, stack, release policy, timeline
|
|
- [AGENTS.md](AGENTS.md) — contributor and agent rules
|
|
- [MEMORY.md](MEMORY.md) — shared session memory: discoveries, gotchas, bugs
|
|
- [Docs/toolchain.md](Docs/toolchain.md) — pinned versions
|
|
- [Docs/environment.md](Docs/environment.md) — workstation audit
|
|
- [Docs/release-checks.md](Docs/release-checks.md) — release gate definitions
|
|
- [Docs/licensing.md](Docs/licensing.md) and [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".
|