History

Rbanh b2305932d9 Some checks are pending CI / Format, lint, test, build (push) Waiting to run Details Expand brush validation coverage		2026-06-06 06:38:37 -04:00
..
adr	Add brush authoring schema	2026-06-06 05:42:19 -04:00
editor	Expand brush validation coverage	2026-06-06 06:38:37 -04:00
mission.md	Initial project import	2026-06-05 21:44:45 -04:00
README.md	Add brush authoring schema	2026-06-06 05:42:19 -04:00

README.md

Project Documentation

Central index for design decisions, mission, and editor framework docs. Agents and contributors should keep this map current—see .cursor/rules/documentation.mdc.

Core

Document	Purpose
mission.md	Why the editor framework exists, principles, audience, non-goals
../README.md	Run/build instructions, controls, implementation checklist

Architecture Decision Records (ADRs)

Immutable-style log of significant decisions. Add a new numbered ADR when changing boundaries, formats, or policies.

ADR	Topic
0001	Crate split, sim/protocol direction, milestone north star
0002	Bevy upgrade cadence and verification
0003	Editor as reusable in-process framework
0004	Dev-only `game_hot` dylib hot reload
0005	Prefab instances + stable asset registry
0006	Scene schema versioning and validation
0007	EditorPlugin extensibility surface
0008	Editor domain modules, lib/bin split, plugin group
0009	Authoring vs hydrated components; strip-on-save
0010	ActorKind, validation, actor inspector
0011	Project sun vs scene directional policy
0012	Zero tech debt / no dual inspector
0013	GI tiers, post-process volumes, editor model
0014	Unified viewport render target and clean game-view overlay
0015	Viewport camera FX ownership and Solari local-light authoring policy
0016	Requested/effective render stack, Solari eligibility, emissive materials
0017	Normalized static mesh assets and renderer placement
0018	Componentized actor inspector, imported asset refs, collider split, material overrides
0019	Local `bevy_render` patch for transient Linux swapchain timeouts
0020	Jackdaw-inspired roadmap source policy and attribution requirements
0021	Brush authoring schema and hydration contract

Editor framework

Document	Purpose
editor/release-notes.md	Editor framework 1.0 baseline
editor/evaluations/	Horizon gate sign-offs (R1–R6)
editor/architecture.md	Viewport / PIE / settings data flow
editor/roadmap.md	Phased editor roadmap and status
editor/brp.md	BRP automation and authoring-only policy
editor/debt-audit.md	Zero-debt phase gates
editor/brushes.md	Brush authoring schema, hydration behavior, and MVP limits

Working plans (not canonical long-term)

Detailed milestone and feature plans live in .cursor/plans/. Promote stable outcomes into ADRs or docs/ when shipped.

Plan	Topic
`project_roadmap_*.plan.md`	M0–M8 program index
`editor_framework_mission_roadmap_*.plan.md`	Editor mission + phased roadmap
`project_settings_and_pie_eject_*.plan.md`	M1.5: settings, rendering parity, PIE eject
`rendering_unification_*.plan.md`	Unified rendering stack, Hybrid Auto GI, emissive materials
`static_mesh_asset_refactor_*.plan.md`	Static mesh renderer, normalized model artifacts, inspector redesign
`component_system_refactor_*.plan.md`	Component registry, imported asset refs, collider split, material overrides
`jackdaw_feature_roadmap_*.plan.md`	Jackdaw-inspired production roadmap; tracked in Gitea as `BS-JD-*` issues

Crate responsibilities (quick reference)

crates/protocol/   Tick rate, input intent, message shapes
crates/sim/        Fixed-step gameplay; no rendering
crates/shared/     Authoring components + hydration
crates/game/       Client presentation, GamePlugin, rendering
crates/editor/     In-process egui editor, BRP, PIE
crates/settings/   Project settings, active/effective render profile contracts

When adding a crate or moving responsibilities, update this table and ADR 0001 (or a follow-up ADR).