Files

T

jpmschweitzerandClaude Opus 4.6 e56061ecbc docs(docs): add frontmatter to asset pipeline docs

Standardized YAML frontmatter on all 13 docs/assets/ files covering
audio, visual, and video pipeline docs, palettes, and templates.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

2026-03-14 00:15:51 +01:00

3.0 KiB

Raw Blame History

title, description, type, status

title	description	type	status
Asset Pipeline Index	Master index linking all asset pipelines (audio, visual, video) with structure and conventions	design	active

Asset Pipeline Index

Centralized tracking for all production assets across pipelines. Each pipeline has its own index, palette (style bible), and per-category asset tables.

Pipelines

Pipeline	Index	Palette	Status
Audio	audio/README.md	audio/palette.md	Active — Sprint 7
Visual	visual/README.md	visual/palette.md	Stub
Video	video/README.md	video/palette.md	Stub

Structure

docs/assets/
  README.md              # This file — master index
  _templates/
    audio.md             # Row template + detailed entry template for audio
    sprite.md            # Row template + detailed entry template for sprites
    video.md             # Row template + detailed entry template for video
  audio/
    README.md            # Audio pipeline index — categories, status summary
    palette.md           # Sonic palette, aesthetic guide, generation approach
    ambient.md           # All ambient loops (station, planet, biome, weather)
    sfx.md               # All SFX (footsteps, doors, impacts, events)
    ui.md                # All UI sounds (cursor, chimes, insert-tech)
  visual/
    README.md            # Visual pipeline index
    palette.md           # Art direction, "the angle", color relationships
    sprites.md           # Entities (NPCs, player, creatures)
    furniture.md         # Furniture items (hundreds, by location/type)
    tilesets.md          # Floor/wall tiles by biome/planet
    icons.md             # UI icons, status indicators
    effects.md           # Fog shaders, particles, overlays
  video/
    README.md            # Video pipeline index
    palette.md           # Motion/editing style guide
    trailers.md          # Marketing / Steam page trailers
    cutscenes.md         # In-game narrative moments

Conventions

One .md per category — asset table with one row per asset, detailed entries below for complex items
palette.md per pipeline — the style bible. Aesthetic baseline, theme, generation approach.
Status values: planned | in-progress | placeholder | final
Templates: _templates/{type}.md — row format + detailed entry format
Asset files live in client/assets/{type}/ — these docs track design and production metadata
Category splitting: When a category file grows too long, split by domain (e.g., furniture-station.md, furniture-colony.md)

Cross-References

Decision files: decisions/ (D-038 audio scope, D-033 entity colors, D-019 camera angle)
Art direction workshop: docs/workshops/art-direction-mood-board/
Sprint briefings: docs/sprints/sprint-N/{team}.md

3.0 KiB Raw Blame History