Ryuu/AetherOnline
Watch
1
0
Fork
You've already forked AetherOnline
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Page: bake product registry
Pages
Authoring Debugging Home Operations Protocol Reference Runtime Systems abilities loadouts and progression ability rotation and combo planner active realtime session actor directory admin actions and internal auth animation workbench operator guide aoi snapshot replication app mode bootstrap and lifecycle architecture guardrails and module tree tests asset loading routing and vfs authored ui surface renderer authoring command bus and transaction history authoring reference registry contributor extension contract authoring reference registry authoritative audit event schema and projections authoritative world time calendar and environmental scheduler bake product registry build strategy and loadout optimizer campaign journey and progression simulator catalog source map and record routing character gameplay state json store character paperdoll assets character stats and equipment modifiers chat presence and social client local offline save and bootstrap cache client local user preferences and account sync client multiplayer connection flow and session cleanup client realtime authority store and frame projection client scene presentation and player preview client snapshot staging and repair receipts client ui focus and text input planning combat action resolution and mob ai semantics combat presentation cues and transient effects combat rewards and progression persistence content dependency graph and scenario playtests content migration and catalog refactors control agent api and remote service runner control panel config and secret persistence control panel service build invalidation and log normalization control panel service lifecycle and quality gates control plane allocation and zone transfer routing control plane and service ops control plane route policy and coordination api control service supervisor manifest and stale process recovery crafting recipes and service integration dependency aware content health deterministic combat balance lab developer workspace doctor and readiness report diagnostics provider input lanes and failure isolation dialogue quest localization handoff dialogue runtime state and choice authority duplicate realtime claim takeover durable retry and session cleanup durable work queue consumer contract dynamic world state and scene phasing editor authored content workspace manifest and cache editor event console and asset debug dashboards editor extension and contribution registries editor scene snapshot lane demand editor settings registry and workspace presets editor viewport and world tools editor workbench and dock encounter difficulty mutators and reward scaling encounter instance and wave director encounter lobby ready check and entry encounter mechanics and boss timelines encounter memory persistence encounter reward eligibility lockouts and pity enemy archetypes combat kits and encounters engine report log and recovery routing environment configuration reference external engine patterns and boundaries farming footstep surface audio materials forgejo wiki publishing and docs check game data catalog game data generated item family adapters game database schema readiness game server catalog load health and fallback policy game server reconciliation and transfer marker cleanup game server startup readiness and registration game transport endpoints and quic exposure gameplay action authority and command audit gameplay action replay ledger and idempotency gameplay authority replay fixtures and drift gates gameplay conditions effects and events gameplay system slice scaffold gameplay ui runtime and bevy sync generated artifact drift and repair generated artifact registry and quality gate integration glossary hotbar hud runtime projection and input in process zone transfer phase journal input profiles and keybinds interactive world map minimap and cartography internal auth and admin delegation chain inventory items and stack limit safety item authoring lifecycle and reference repairs json catalog hot reload batch and candidate revalidation legacy compatibility and migration register local player input control and reconciliation local playtest and standalone preview localization extraction and runtime catalog login account admin repository and cascades login database migrations and schema contracts login server auth sessions and character entry login session cache throttle and revocation loot table authoring and drop audits mob animation presentation events and projectile cues mob encounters and scene combat movement authority networking tick health and zone pressure npc ai schedules and deterministic behavior npc definition catalog npc schedules routines and contextual behavior npc services npc state memory and interactions pack export content gate party composition roles and synergy simulator passive traits and procs persistent interactive world objects placed light runtime budget and preview heatmap player appearance equipment persistence player economy authority player homesteads housing and property auctions player journal and codex player navigation tracking and world guidance player notification inbox authority and delivery player preview animation profile player preview debug gizmos and collision overlays player preview render cache and keyed entity lifecycle player preview weather masks and effect budget player snapshot assembly and durable row normalization post process volume blending and preview overlays project files import profiles and asset change impact public endpoint detection and upnp exposure quality gate jsonl events and panel failure summaries quest runtime projection and turn in authority quic reliable stream topology and negotiation realtime admission throttling and load shedding realtime bootstrap manifest and snapshot service realtime bootstrap wire sections and compression realtime client reconnect journal and command replay realtime datagram codecs and ingress policy realtime egress mailboxes and lane scheduling realtime ingress validation and failure policy realtime packet debug capture and triage realtime protocol registry realtime registry and wire contract realtime resume ledger record format realtime rollout policy and compatibility negotiation realtime runtime profile and transport adaptation realtime session activation hydration boundary realtime timebases tick ordering and clock ownership redis keyspace ttls and cleanup targets regions points of interest and exploration discovery relationship reputation gates and service deltas remote avatar replica binding and interpolation render surface guard and window safety runtime actor identity and authority contract runtime camera arrival and cutscene overrides runtime debug overlays and developer options runtime environment registry and startup config validation runtime path roots and packaged asset resolution runtime profiling tracy captures and budget gates runtime scene manifests and zone authoring runtime ui fonts and localized text presentation scenario sandbox and timeline inspector scene audio runtime routing scene command center and visual graph tools scene cutscene authoring scene documents scene layer schema depth and bands scene lighting post process and placed lights scene navigation and collision scene preview scenario replay cli scene runtime media weather and camera phases scene runtime schedule and frame budget scene trigger authority and reconciliation scene triggers scene validation and repairs service json rpc contracts service observability and metrics contract service registry heartbeats drain and shutdown session handoff and transfer shared content workspace shared test fixtures and fixture workspaces shared validation report schema source inventory and engine health standalone account realm and character flow standalone asset pack and preflight standalone loading pause death and recovery screens standalone shell flow and ui lifecycle standalone ui preview root and transient lifecycle starter character economy bootstrap status effects and combat modifiers story content loop text asset migration journals and atomic rollback tiled prefab import and placement tilemap asset import contracts tileset atlas preview surfaces trigger permissions targeting and action pipelines typed disconnect codes and transport advisories ui layout binding graph and editor workflow ui layout ui skins validation and bake validation errors validation provider registry and strict preflight vendor stock and shop economy authoring viewport spatial planning overlays vscode dev tasks and generated launch profiles workspace package roles and scoped quality profiles world entry smoke harness and soak telemetry world events and scenario director world gameplay assemblies world interactions and activity boards world mechanism and puzzle graphs world overlay gizmos and culling world travel waypoints and zone transitions xtask content gates and plans
2 bake product registry
forgejo-actions edited this page 2026-07-11 10:33:50 +00:00
Table of contents

Authoring Bake Product Registry

Purpose

The authoring bake product registry is the contract between editable source content and generated runtime-ready products. Product descriptors say who owns an output, which input lanes invalidate it, which consumers need it, and how diagnostics and fingerprints prove it is current.

Registry Contract

src/authoring_bake/products.rs is the source of truth. src/authoring_bake/products_manifest.json is generated from that source and is read by pack/export tooling. Do not hand-edit the generated manifest.

Each AuthoringBakeProductDescriptor declares:

  • output_id: stable product ID used in bake manifests and tooling.
  • label: human-readable name for UI and reports.
  • output_path: runtime-cache-relative output path.
  • baker_id: implementation owner for the bake.
  • schema_version: output schema owned by the product.
  • baker_fingerprint: semantic implementation fingerprint.
  • input_domains: input lanes that the product reads.
  • consumers: cli, editor_reload, and/or pack_export.
  • invalidation_keys: source path patterns that trigger rebake.
  • validation_report_label: diagnostics label for bake reports.
  • default_baker_factory: the baker constructor used by the default registry.

Output paths must be normalized, relative paths inside authored asset domains. Descriptor validation rejects empty IDs, duplicate IDs, duplicate output paths, missing input domains, missing consumers, invalid invalidation keys, and keys that do not match an input lane.

Products

Output ID Owner Inputs Consumers Output
quest.catalog.projection QuestCatalogProjectionBaker quest_catalog cli, editor_reload, pack_export runtime/quests/quest_catalog_projection.json
ui.layout.runtime_cache UiLayoutRuntimeCacheBaker ui_layout_documents cli, editor_reload, pack_export runtime/ui/ui_layout_runtime_cache.json
localization.extraction LocalizationExtractionBaker scene_cutscenes, ui_layout_documents, dialogue_catalog, quest_catalog, game_data_catalog cli, pack_export runtime/localization/localization_entries.json

When adding a product, update the descriptor and baker together, then regenerate products_manifest.json. Pack/export reads the manifest, not Rust source, so a descriptor change without a regenerated manifest can make local bakes pass while pack planning still sees old product metadata.

Input Lanes

Input lanes are AuthoringBakeInputLaneDescriptor values. A lane owns three things:

  • snapshot loading for the source domain;
  • dependency signature loading for cache and rebuild checks;
  • invalidation-key matching for source changes.

Current lanes are:

  • quest_catalog: quest catalog source and quests/*.json changes.
  • ui_layout_documents: .aetherui layout documents under the UI layout asset domain.
  • dialogue_catalog: dialogue JSON under dialogue/*.json.
  • game_data_catalog: the game-data composition manifest, shards, item-family manifest, and relevant gameplay assets.
  • scene_cutscenes: cutscene data embedded in scenes/*.scene.

Every product input domain should have at least one invalidation key, and every invalidation key should be covered by one of the declared input domains.

Fingerprints And Dependencies

An output rebuilds when its baker fingerprint changes, when its dependency signatures change, or when the previous manifest is missing the output. Bake output records include output ID/path, baker ID, schema version, baker fingerprint, content hash, dependency graph hash, validation hash, source provenance, dependencies, and validation issues.

Use the baker fingerprint for semantic implementation changes that may keep source inputs identical but change output meaning. Use source dependencies and lane signatures for authored content changes. Localization extraction also includes dependency-path information in its runtime fingerprint because its source set spans several domains.

Diagnostics Policy

Bakers attach validation summaries and issues to their output records. The CLI also merges shared authoring diagnostics. Diagnostics are reportable by default and become a hard gate when running with --fail-on-diagnostics.

Use product-specific validation_report_label values so authors can identify the failing output without knowing the baker module name. Diagnostics should point back to source assets, not generated cache files, whenever the source path is known.

Generated Manifests

There are two generated manifest layers:

  • src/authoring_bake/products_manifest.json: registry metadata generated from product descriptors.
  • authoring_bake_manifest.json: bake-run output metadata generated beside runtime cache outputs.

The products manifest is checked or repaired with:

cargo run -p aether --bin aether-generated-artifact -- --check authoring_bake_products_manifest
cargo run -p aether --bin aether-generated-artifact -- --write authoring_bake_products_manifest

The bake-run manifest is produced by the bake CLI and records the actual outputs, hashes, dependencies, and validation payloads for that run.

Pack And Export Discovery

Pack/export planning reads src/authoring_bake/products_manifest.json, filters products whose consumers include pack_export, prefixes their output paths with the runtime cache root, and includes authoring_bake_manifest.json. Tests in xtask/tests/pack_export_gate.rs verify that pack/export uses the generated manifest, ignores CLI-only products, and rejects missing or malformed manifests.

Run a diagnostic bake before export:

cargo run --bin aether-bake -- --fail-on-diagnostics

Use the pack/export gate when changing products or consumers:

cargo test -p xtask --test pack_export_gate

Steps

  1. Create or update the baker implementation.
  2. Register a product descriptor with a stable output ID, output path, schema version, and baker fingerprint.
  3. Choose the input lanes the baker actually reads.
  4. Add invalidation keys covered by those lanes.
  5. Choose consumers; include pack_export only when the product must ship in exported packs.
  6. Regenerate products_manifest.json.
  7. Run the generated-artifact check, bake diagnostics, and pack/export gate tests.

Expected Outputs

A successful bake-product change produces an updated Rust descriptor, a matching generated src/authoring_bake/products_manifest.json, the product runtime cache output when the baker runs, and an authoring_bake_manifest.json entry that records hashes, dependencies, validation issues, and source provenance for the bake run.

Pack/export should be able to discover every product whose consumers include pack_export, and editor reload should only see products whose consumer list includes editor_reload.

Common Mistakes

  • Hand-editing products_manifest.json instead of regenerating it from descriptors.
  • Adding a product without an input lane or without invalidation keys covered by that lane.
  • Forgetting pack_export on a product that must ship in exported content.
  • Changing output semantics without changing the baker fingerprint.
  • Emitting diagnostics against generated output paths instead of authored source paths.

Recovery Paths

If product metadata drifts, run:

cargo run -p aether --bin aether-generated-artifact -- --write authoring_bake_products_manifest

Then run cargo run --bin aether-bake -- --fail-on-diagnostics to confirm the product can bake and cargo test -p xtask --test pack_export_gate when the product is pack/export visible.

Related Pages