Start M0 editor workflow polish

This commit is contained in:
Rbanh committed 2026-06-06 02:15:14 -04:00
1 parent 3e053a81ab
commit 19c4d017dc
8 files changed
+236 -40

No files matched your search

+2
View File
@@ -34,6 +34,7 @@ Immutable-style log of significant decisions. Add a new numbered ADR when changi
| [0017](adr/0017-normalized-static-mesh-assets.md) | Normalized static mesh assets and renderer placement |
| [0018](adr/0018-componentized-actor-inspector-and-materials.md) | Componentized actor inspector, imported asset refs, collider split, material overrides |
| [0019](adr/0019-local-bevy-render-timeout-patch.md) | Local `bevy_render` patch for transient Linux swapchain timeouts |
| [0020](adr/0020-jackdaw-inspired-editor-roadmap.md) | Jackdaw-inspired roadmap source policy and attribution requirements |
## Editor framework
@@ -58,6 +59,7 @@ Detailed milestone and feature plans live in [`.cursor/plans/`](../.cursor/plans
| `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)
@@ -0,0 +1,49 @@
Status: Accepted
Context
=======
Blacksite is evolving from a game-specific editor scaffold into a reusable
Bevy editor sandbox for future game work. The Jackdaw editor provides useful
public reference material for editor workflows such as brush geometry, material
browser organization, terrain tools, physics placement, project launchers, and
extension boundaries.
The roadmap should use those references as product and workflow inspiration
without accidentally turning Blacksite into a fork, importing code without
attribution, or overriding Blacksite's existing authoring/hydration model.
Decision
========
Treat Jackdaw as an inspiration source, not as an architecture or format
authority. Blacksite keeps its current foundations: Bevy DynamicScene RON,
schema stamping and migration, authoring-only validation, hydration into runtime
components, in-process PIE, and the unified viewport.
Each Jackdaw-inspired ticket must identify whether the work is:
- Design-inspired: adapted from public behavior, screenshots, docs, or workflow
descriptions.
- API-inspired: adapted from public API shape or concepts without copied code.
- Code-derived: containing copied or closely translated source code.
Code-derived work requires a source URL, upstream commit or release reference,
compatible license confirmation, and preserved file-level notices when required
by the source license. Prefer clean-room implementation for geometry, terrain,
operators, and extension APIs because Blacksite's scene and runtime ownership
model differs from Jackdaw's.
Consequences
============
The Jackdaw roadmap can be used for planning and prioritization while keeping
Blacksite's architecture coherent and auditable.
M0-M5 planning details live in `.cursor/plans/` until implemented. Durable
decisions move into `docs/adr/` or `docs/editor/`; user-visible workflows move
into the root README. The Gitea issue tracker is the production task board, but
docs remain the long-term source for accepted policy and architecture.
Reviewers should reject Jackdaw-inspired changes that do not declare their
inspiration level or that copy source without license and source attribution.
+2 -1
View File
@@ -34,6 +34,7 @@ Docs for the in-process egui editor (`crates/editor/`). Update this index when a
## Design intentions (stable)
- **EditorOnly** helper entities never appear in hierarchy or saved scenes. Visualizer proxies are editor-only but selectable; selection resolves to their source entity.
- **Jackdaw-inspired roadmap work** follows ADR 0020: use Jackdaw as design/API inspiration only unless a ticket explicitly marks code-derived work with source, license, and upstream commit notes. Clean-room implementation is preferred for geometry, terrain, operator, and extension systems.
- **Dedicated egui `Camera2d`** at full window — never attach `PrimaryEguiContext` to a viewport-cropped 3D camera (NaN layout panic).
- **Unified viewport** uses one render-to-texture target for both the editor fly camera and the possessed player camera so HDR/atmosphere is not broken by sub-viewport cropping.
- **PIE:** F8 possess/eject while sim runs; **F6** pauses/resumes simulation in Play; project settings drive shared rendering for the active viewport camera.
@@ -48,7 +49,7 @@ Docs for the in-process egui editor (`crates/editor/`). Update this index when a
- **World lighting** has two layers: project default sun/ambient settings, and optional scene-authored directional `LightDesc` overrides. **Scene → Lighting** menu and **Rendering** panel (Window) restore project sun or bake a scene directional from project settings. **Apply** in Project Settings updates ambient and sun illuminance live.
- **Rendering** — `GiMode` + post-process volumes; see [rendering.md](rendering.md). **Window → Rendering** shows requested/effective active-camera stack, fallback reason, Solari eligibility, viewport GI badge, and volume HUD.
- **Inspector** shows a responsive header, **Transform**, registered authoring component cards, and a pinned bottom Add Component footer (`actor_inspector`); only the component body scrolls. Rows wrap or stack inside narrow docks instead of forcing the panel wider, and legacy authoring sections use the same component-card shell. Component card carets collapse/expand for the current editor session, status dots toggle persisted active state, and triple-dot menus provide reset, copy/paste values, move, remove, and documentation slots. Inactive authoring components remain in the scene but are skipped by hydration/runtime queries, stripping their generated meshes, lights, physics, or post-process effects. `StaticMeshRenderer` uses concept-style slot cards with model thumbnails, imported mesh/material selectors, visibility, shadow flags, and per-actor material overrides. Empty actor material refs display the inherited source material from the generated static mesh artifact as **Source default**; selector **Browse** assigns explicit normalized imported sub-assets, **Locate** focuses the owning asset in the Asset Browser, and **Clear** returns optional material slots to the inherited source default. `ColliderDesc` and `RigidBodyDesc` are separate component cards. Game crates add sections via `ActorInspectorSection` + `game::editor_ext::actor_inspector_section_ids()`.
- **Command palette** (`Ctrl+P`): `scene.reset_lighting`, `rendering.create_volume`, `rendering.select_volumes_at_camera`, `rendering.focus_active_volumes`, `selection.group`, `selection.focus`, and play commands.
- **Command palette** (`Ctrl+P`): focuses the filter on open, selects the first filtered command, supports arrow-key selection and Enter to run. Commands include `scene.reset_lighting`, `rendering.create_volume`, `rendering.select_volumes_at_camera`, `rendering.focus_active_volumes`, `selection.group`, `selection.focus`, `selection.reset_transform`, and play commands.
- **ActorKind** is required on saved level objects (schema v2). Save strips hydrated ECS before writing `.scn.ron`.
- **Scene visualizers** expose actor root icons, colliders, lights, player spawns, prefab/model anchors, Project Sun, and runtime player/camera markers without changing saved scene data. Viewport options include actor icon size and transform gizmo size sliders.
- **Clean game-view overlay** (`G`) hides editor chrome, grid, selection outlines, transform gizmos, actor root icons, visualizers, and selectable proxies without changing camera ownership; `Ctrl+G` toggles grid.