Falling-Metal-Interactive/Blacksite
2
0
Fork 0
Code Issues 15 Pull Requests Actions Packages Projects Releases Wiki Activity

BS-JD-212 - Project content and derived-artifact contract #60

New Issue
Closed
opened 2026-07-13 16:51:50 -04:00 by Rbanh · 1 comment
Rbanh commented 2026-07-13 16:51:50 -04:00
Owner
Copy Link

Summary

Define the hard-to-reverse storage, identity, typing, import-provenance, material-resolution, and crate-boundary contract for the M2 content-workspace refactor.

Decisions to record in ADR 0045

  • User content may live in any normal nested folder under the project assets/ root; external absolute links are out of scope.
  • Folder names are organizational only. Registry kind plus extension/parsed authored-document schema determines type.
  • AssetId is authoritative identity and project-relative path is mutable metadata/cached loading data.
  • Registry schema/resolution contracts live in shared::content; UI-independent scanning/import/transaction/processing lives in a content_pipeline crate consumed by editor, validator, watcher, and xtask.
  • The registry becomes a versioned document with project content defaults and typed asset kinds; packaged builds receive a stripped runtime catalog.
  • .index, .trash, thumbnails, and UUID-keyed derived artifacts are implementation-owned, hidden, and protected.
  • Import provenance/reimport recipes never become runtime dependencies on external absolute paths.
  • Material precedence is: runtime MaterialPropertyBlock -> scene/prefab assignment -> model-asset default -> imported source -> project default -> built-in DefaultGrid.
  • Missing layers inherit downward. A configured but broken authored reference uses DefaultGrid/project fallback with diagnostics rather than silently revealing another authored layer.
  • Reimport and moves reconcile by stable IDs and retain unresolved mappings as explicit orphans.
  • Ordinary loading is read-only; registry/settings/scene migrations are explicit through cargo upgrade-project.

Acceptance criteria

  • ADR 0045 is accepted and indexed.
  • ADR 0035 reflects model defaults, fallback precedence, and completed property-block behavior.
  • A fixed-folder consumer/migration inventory covers editor catalog/import, shared hydration, scene validation, project settings, build/package, watcher, and headless processing.
  • Existing project UUIDs and explicit renderer assignments have a deterministic migration path.
  • Managed-directory, terrain-fallback, and external-link boundaries are explicit.
  • No parallel catalog, renderer, or Material representation is introduced.

Dependency

Child of epic #59; blocks the other new implementation slices.

## Summary Define the hard-to-reverse storage, identity, typing, import-provenance, material-resolution, and crate-boundary contract for the M2 content-workspace refactor. ## Decisions to record in ADR 0045 - User content may live in any normal nested folder under the project `assets/` root; external absolute links are out of scope. - Folder names are organizational only. Registry kind plus extension/parsed authored-document schema determines type. - `AssetId` is authoritative identity and project-relative path is mutable metadata/cached loading data. - Registry schema/resolution contracts live in `shared::content`; UI-independent scanning/import/transaction/processing lives in a `content_pipeline` crate consumed by editor, validator, watcher, and xtask. - The registry becomes a versioned document with project content defaults and typed asset kinds; packaged builds receive a stripped runtime catalog. - `.index`, `.trash`, thumbnails, and UUID-keyed derived artifacts are implementation-owned, hidden, and protected. - Import provenance/reimport recipes never become runtime dependencies on external absolute paths. - Material precedence is: runtime MaterialPropertyBlock -> scene/prefab assignment -> model-asset default -> imported source -> project default -> built-in DefaultGrid. - Missing layers inherit downward. A configured but broken authored reference uses DefaultGrid/project fallback with diagnostics rather than silently revealing another authored layer. - Reimport and moves reconcile by stable IDs and retain unresolved mappings as explicit orphans. - Ordinary loading is read-only; registry/settings/scene migrations are explicit through `cargo upgrade-project`. ## Acceptance criteria - [ ] ADR 0045 is accepted and indexed. - [ ] ADR 0035 reflects model defaults, fallback precedence, and completed property-block behavior. - [ ] A fixed-folder consumer/migration inventory covers editor catalog/import, shared hydration, scene validation, project settings, build/package, watcher, and headless processing. - [ ] Existing project UUIDs and explicit renderer assignments have a deterministic migration path. - [ ] Managed-directory, terrain-fallback, and external-link boundaries are explicit. - [ ] No parallel catalog, renderer, or Material representation is introduced. ## Dependency Child of epic #59; blocks the other new implementation slices.
Rbanh added this to the M2 - Content workspace and asset pipeline milestone 2026-07-13 16:51:50 -04:00
Rbanh commented 2026-07-17 23:46:45 -04:00
Author
Owner
Copy Link

Closed against M2 candidate cf6eaba

The M2 tracking/architecture contract is implemented in accepted ADRs 0045–0049, shared registry/content types, the content-pipeline boundary, authored documents, modular editor composition, the debt ratchet, and canonical documentation. Architecture and documentation audits pass on the candidate.

Consolidated code, deterministic, native, and package evidence: M2 evaluation record. Candidate gates passed in full and the commit is published on codex/m2-content-workspace.

## Closed against M2 candidate `cf6eaba` The M2 tracking/architecture contract is implemented in accepted ADRs 0045–0049, shared registry/content types, the content-pipeline boundary, authored documents, modular editor composition, the debt ratchet, and canonical documentation. Architecture and documentation audits pass on the candidate. Consolidated code, deterministic, native, and package evidence: [M2 evaluation record](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/src/commit/cf6eaba53473d2825d0109f5a18f44794af5bd48/docs/editor/evaluations/content-workspace-m2/README.md). Candidate gates passed in full and the commit is published on `codex/m2-content-workspace`.
Rbanh closed this issue 2026-07-17 23:46:50 -04:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels   
area:animation

Skeletal animation import, preview, graph/state authoring, and runtime integration.

  
area:assets

Asset browser, material browser, thumbnails, import, processing, and asset watcher.

  
area:audio

Audio source/listener authoring, buses, spatial preview, and runtime integration.

  
area:brushes

Brush geometry, CSG, face editing, UVs, and brush diagnostics.

  
area:build-release

Build profiles, packaging, content validation, release gates, and distribution diagnostics.

  
area:extensions

Static extension API, extension scaffolds, dylib exploration.

  
area:governance

Policy, attribution, planning, and production process.

  
area:hierarchy

Outliner hierarchy, parenting, grouping, prefab structure, ordering, and selection workflows.

  
area:inspector

Inspector, component metadata, component editing UX.

  
area:navigation

Navigation mesh authoring, baking, diagnostics, and AI path preview.

  
area:operators

Editor operator/action framework, undo, commit/cancel semantics.

  
area:physics

Physics placement, colliders, rigid bodies, diagnostics, and overlays.

  
area:project-ux

Project launcher, profiles, templates, or first-run project workflow.

  
area:quality

Regression packs, tests, performance budgets, profiler, first-hour UX.

  
area:rendering

Static and skinned renderers, material slots, shaders, ray tracing, and render-path integration.

  
area:runtime

BRP, remote inspector, PIE, game preview, runtime integration.

  
area:scene-io

Scene document, save/load, schema, migration, or reference repair.

  
area:terrain

Terrain authoring, terrain sculpting, heightmaps, and terrain materials.

  
area:viewport

Viewport interaction, selection, shortcuts, camera, overlays, and controls.

  
priority:P0

Must-have prerequisite or milestone-critical item.

  
priority:P1

Important production feature after P0 work is stable.

  
priority:P2

Useful follow-up or polish item.

  
priority:P3

Exploratory or later spike.

  
roadmap:jackdaw

Jackdaw-inspired Blacksite editor roadmap item.

  
roadmap:production

Blacksite production-readiness roadmap item beyond the Jackdaw-inspired foundation.

  
type:architecture

Architecture, internal framework, or hard-to-reverse technical decision.

  
type:docs

Documentation, policy, samples, or issue-board structure.

  
type:epic

Tracking epic that groups related milestone work.

  
type:feature

User-visible feature or capability.

No Label
area:animation
area:assets
area:audio
area:brushes
area:build-release
area:extensions
area:governance
area:hierarchy
area:inspector
area:navigation
area:operators
area:physics
area:project-ux
area:quality
area:rendering
area:runtime
area:scene-io
area:terrain
area:viewport
priority:P0
priority:P1
priority:P2
priority:P3
roadmap:jackdaw
roadmap:production
type:architecture
type:docs
type:epic
type:feature
Milestone
Clear milestone
No items
No Milestone
M2 - Content workspace and asset pipeline
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: Falling-Metal-Interactive/Blacksite#60
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?