Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Gradientfall is an in-development 3D action-adventure that turns machine-learnin

![Gradientfall portfolio preview](docs/assets/social-preview.png)

**Explore:** [documentation map](docs/README.md) · [current roadmap](docs/ROADMAP.md) · [worldbook](docs/WORLDBOOK.md) · [runtime architecture](docs/ARCHITECTURE.md) · [run locally](#run-locally)

## Visual proof from the current slice

| Datasedge Meadows | Gradient Peaks |
Expand All @@ -28,9 +30,12 @@ These are in-engine progress captures, not target renders. They document the cur
- Third-person movement and camera controls in a generated 3D landscape.
- Melee/ranged combat foundations, enemy spawning, health, damage shards, and combat HUD.
- Bit companion behavior and landmark reactions.
- Bootstrap town with 13 approved villagers, lit buildings, and proximity dialogue.
- The Perceptron Vault's playable 2-3-1 neural-network dungeon and Gatekeeper encounter.
- A 700-bloom Iris field whose specimen measurements feed an in-game classifier compendium.
- Dynamic sky, celestial layers, clouds, water, terrain, grass, vegetation, particles, and painterly shaders.
- Schema-validated JSON pipeline for quests, NPCs, items, monsters, quizzes, lore, and points of interest.
- 70 approved content entries plus 15 staged inbox entries in the preserved active-work snapshot.
- 111 approved content entries across all seven content types; the staging inbox currently validates empty.

This repository does **not** claim that the ten-region, 40–80 hour design is complete. The vision is documented in [the GDD](docs/GDD.md); the shipped scope and next gates live in [the roadmap](docs/ROADMAP.md) and [devlog](docs/DEVLOG.md).

Expand Down
45 changes: 45 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Gradientfall documentation map

Gradientfall's documentation separates the playable truth, the long-range
vision, the world canon, and the development record. Start with the path that
matches your question.

| If you want to... | Read |
| --- | --- |
| Understand the game and its design pillars | [`GDD.md`](GDD.md) |
| See what is implemented, next, or still gated | [`ROADMAP.md`](ROADMAP.md) |
| Follow the newest engineering and visual decisions | [`DEVLOG.md`](DEVLOG.md) |
| Learn the regions, characters, creatures, and ML metaphors | [`WORLDBOOK.md`](WORLDBOOK.md) |
| Navigate the continent and regional relationships | [`WORLD_ATLAS.md`](WORLD_ATLAS.md) |
| Understand runtime boundaries and system wiring | [`ARCHITECTURE.md`](ARCHITECTURE.md) |
| Add or validate authored JSON content | [`CONTENT_PIPELINE.md`](CONTENT_PIPELINE.md) |
| Understand the autonomous-work quality bar | [`AUTONOMY.md`](AUTONOMY.md) |

## Evidence and art direction

- [`progress/`](progress/) contains in-engine evidence tied to completed
milestones, including Kern studies, Datasedge Meadows, Bootstrap, and time-of-day
captures.
- [`concept-art/`](concept-art/) contains clearly labeled mood studies for
future regions. These images guide tone; they are not presented as current
gameplay or locked canon.
- [`assets/`](assets/) contains repository presentation artwork such as the
social preview.

## Content production

- [`briefs/`](briefs/) holds self-contained authoring briefs.
- Runtime-ready records live under [`../content/approved/`](../content/approved/).
- New records enter through [`../content/inbox/`](../content/inbox/) and must
pass `python tools/validate_content.py --inbox` before promotion.
- Schemas under [`../content/schemas/`](../content/schemas/) are the structural
contract for all seven content types.

## Current verification

The repository's `verify` workflow and local validator check content structure,
Python tooling, and Godot script parsing. Visible milestones also require
human inspection of rendered evidence; a clean headless boot is necessary but
does not substitute for that visual gate.

[Return to the project README](../README.md)