Ryuu/AetherOnline
Watch
1
0
Fork
You've already forked AetherOnline
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Page: editor extension and contribution registries
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
1 editor extension and contribution registries
forgejo-actions edited this page 2026-07-15 12:43:13 +00:00
Table of contents

Editor Extension And Contribution Registries

Purpose

Use this workflow when adding an editor domain or making a tool, command, inspector adapter, asset editor, validator, or importer discoverable as part of an existing domain. assets/editor/extensions.json is the ownership manifest: it says which extension owns each stable contribution ID. It does not instantiate the contribution or replace the native registry that implements its behavior.

The ownership boundary is deliberate. The extension registry owns domain identity, lifecycle state, labels, summaries, and contribution claims. EditorToolRegistry is the runtime gateway for dock-tool discovery, drawing, chrome, status, context requirements, and preview/resource demand; EditorDockTab remains the serialized workspace compatibility key while descriptors are migrated out of the legacy dock catalog. Import routing remains in src/editor/importer_registry.rs; asset-to-workbench routing lives in src/editor/asset_editor_registry.rs; inspector schemas and typed edit routing remain in src/editor/inspector_adapter.rs. Commands and validators likewise remain owned by their implementing systems even when their IDs are claimed by an extension. The manifest schema contains template_catalogs, but the current implementation has no template-catalog registration source, so that group must remain empty.

Extension enablement is executable editor state. Optional domains can be enabled or disabled from Engine Settings → Extensions; overrides persist atomically to aether_editor_extensions.json under the local config root. Disabled tool contributions are removed from dock and detached-window state and excluded from Window discovery, command-palette tool actions, and workspace application. Their inspector adapters, object factories, asset-editor routes, lifecycle-aware importer lookups, and authored-workspace diagnostics providers are also excluded. Validator enablement is captured as a sorted stable-ID selection for each background workspace job and is part of the workspace cache key. A lifecycle toggle immediately invalidates the old diagnostics projection; an already-running job with the previous selection is not allowed to install stale results. Required extensions declare "required": true and cannot be disabled. New contributions should query the registry's typed lifecycle methods rather than copying enabled IDs into subsystem-specific flags.

Steps

Add Or Change A Contribution

  1. Choose the owning extension before writing manifest data. Prefer an existing domain such as aether.core, aether.scene, or aether.runtime. Add a new extension only when the contribution has a distinct ownership and maintenance boundary; every extension requires a non-empty label and summary.

  2. Choose an ID that is stable, namespaced, and independent of display text. Extension and contribution IDs may contain only lowercase ASCII letters, digits, ., -, and _. Tool IDs have the stricter EditorToolId invariant: they must also contain a dot and may not start or end with one. Treat IDs as compatibility keys for commands, preferences, workspace manifests, and future plugin registrations; change labels rather than renaming IDs for presentation reasons.

  3. Implement the contribution in its native registry.

    • For a dock tool, add or update its EditorDockTabDescriptor, declare its draw/status providers, chrome policy, context capabilities, resource demand, and placement metadata, then map the compatibility-era EditorDockTab to its EditorToolId in compatibility_tool_id. Dock hosts resolve those behaviors through EditorToolRegistry; do not dispatch new tools directly from EditorDockTab. Dock layouts still serialize enum variants, so do not remove that adapter when adding the stable ID.
    • For an importer, register an EditorImporterDescriptor with an ID, label, extensions, optional normalized asset-path prefix, asset kind, hot-reload policy, and priority. Higher priority wins; for equal priority, path-specific importers sort before general importers. For example, prefabs/*.tmx must resolve to aether.importer.prefab before the general TMX importer.
    • For an asset editor, register an EditorAssetEditorDescriptor with a stable ID, code-declared extension owner, label, button label, resource kinds, optional path-prefix or path-contains matchers, priority, and typed handler. Higher priority resolves path-specific editors before kind-wide fallbacks. Project Files and the Asset Inspector must resolve this registry instead of adding another ProjectAssetKind or path switch.
    • For an inspector adapter, add a stable adapter ID, object-kind binding, section/property schema, a property snapshot projection, and typed property-edit routes. The selected-object Inspector renders those schemas generically as text, numeric, boolean, enum, resource-reference, and read-only controls. Keep property IDs unique within the adapter, ensure every section refers to a declared property, and keep read_only synchronized with has_property_edit_route: startup invariants reject editable metadata without executable routing.
    • For a command or validator, register its implementation in the subsystem that dispatches it. A string in extensions.json is only an ownership claim.

  4. Add the exact contribution ID to one currently backed group on its owning descriptor in assets/editor/extensions.json: tools, commands, inspector_adapters, object_factories, asset_editors, validators, or importers. Keep manifest version at 1. A contribution may have only one owner within its contribution kind, and the same descriptor may not repeat an ID. Code-declared command and asset-editor owners must match the manifest owner. Do not populate template_catalogs: ownership validation rejects those claims until registered_editor_contributions gains a template-catalog registration source.

  5. If the contribution is a tool used by a workspace, add the same tool ID to the applicable dock region in assets/editor/workspaces.json. The available regions are root, scene_tree, inspector, bottom_panel, and network_stack; array order is tab order inside that region. Workspace tool IDs must resolve through EditorToolRegistry, must be owned by an extension, and may appear in only one region per preset.

  6. Exercise the runtime load path. The editor first reads editor/extensions.json through the configured asset roots. A missing, unreadable, undecodable, unsupported, or invalid disk manifest falls back to the compile-time shipped manifest and records EditorExtensionRegistry::load_warning(). The shipped manifest is the last known-good contract; if that embedded copy is invalid, startup panics instead of running with ambiguous ownership.

  7. Run the focused registry checks, followed by the documentation check:

    cargo test -p aether editor::extensions::tests
cargo test -p aether editor::tool_registry::tests
cargo test -p aether editor::importer_registry::tests
cargo test -p aether editor::asset_editor_registry::tests
cargo test -p aether editor::inspector_adapter::tests
cargo run -p xtask -- docs-check --root .

Verify The Ownership Graph

Confirm that the implemented registry contains the contribution and that the extension manifest names the same ID. The shipped contract test checks every registered tool, command, importer, asset editor, inspector adapter, and validator has an extension owner, and checks every workspace tool has both a registered tool and an owner. It also rejects duplicate extension IDs, duplicate IDs within a contribution group, cross-extension collisions within the same contribution kind, and code/manifest owner disagreement for commands and asset editors.

For a new contribution kind, add its native registrations to registered_editor_contributions before allowing manifest claims, then add focused implementation-to-manifest coverage. A new manifest field alone is not an extension point.

Expected Outputs

  • One implemented native contribution with a stable, namespaced ID.
  • Exactly one extension owner for that ID and contribution kind in assets/editor/extensions.json.
  • A tool-to-dock compatibility route when the contribution is a dock surface.
  • Workspace membership only where the tool should be opened by a preset.
  • Passing uniqueness, ownership, routing, and docs checks.
  • No load warning when the disk manifest is valid; a usable shipped registry plus a diagnostic warning when disk loading fails.
  • A reversible enable/disable lifecycle for optional extensions, with required domains protected and local overrides persisted independently of project assets.
  • For writable inspector adapters, one snapshot value for every declared property and a typed command route for every non-read-only property. Complex domain workbenches may remain below the generic property grid, but must not duplicate its scalar controls.
  • For asset editors, one deterministic highest-priority route whose owning extension is enabled; disabling that extension removes the route without adding UI-specific conditions.
  • For validators, a deterministic enabled-ID selection passed to the background authored-workspace build; changing the selection invalidates the cached diagnostics projection even when authored files did not change.

Common Mistakes

  • Adding an ID to extensions.json and assuming that it registers behavior. The manifest owns metadata; the native registry owns execution.
  • Reusing an importer or tool ID under two extensions. Manifest validation rejects cross-domain ownership collisions before registration.
  • Renaming an ID when only the label changed. Stable IDs may already be referenced by workspace presets, commands, preferences, or persisted compatibility data.
  • Adding a dock descriptor without extending compatibility_tool_id, or adding a workspace tool that cannot resolve to an EditorDockTab.
  • Calling a legacy EditorDockTab draw, chrome, status, or demand accessor from a runtime host. Resolve the registered tool first so disabled or missing contributions remain recoverable.
  • Registering a broad importer at a priority that shadows a path-specific importer, especially for shared extensions such as .tmx.
  • Adding another ProjectAssetKind/path match inside Project Files or the Asset Inspector instead of registering an asset editor descriptor.
  • Treating successful manifest parsing as complete integration for commands, templates, or validators without testing their implementing registry.
  • Showing or dispatching a contribution without consulting its owning extension's lifecycle state.
  • Marking an inspector property editable without adding its typed route, or rendering another object-kind switch for scalar fields instead of extending the adapter snapshot and property editor.

Recovery Paths

If startup reports that a contribution is owned twice, search all extension groups for the exact ID and leave one owner. If a stable ID error appears, remove uppercase letters, whitespace, slashes, or other unsupported characters; for tools, also restore a dotted namespace.

If a tool is absent from a workspace, verify the chain in order: the dock descriptor exists, compatibility_tool_id returns the manifest ID, the runtime registry resolves the tab, the owning extension lists it, and the workspace preset lists it. If a saved workspace contains a tool whose contribution is unavailable, the editor preserves the layout and shows a recovery surface; restore the owning extension or reset the workspace. If an importer chooses the wrong loader, call or test importer_for_path with the normalized res://-relative path, then compare priority, prefix, and extension matching.

If load_warning() is set, fix the disk asset path or JSON and restart so the process-wide lazy registry reloads. The current process keeps the shipped fallback once initialized. If the embedded manifest itself fails a test, repair assets/editor/extensions.json before rebuilding; bypassing validation would make ownership nondeterministic.

Related Pages