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

Editor Settings Registry And Workspace Presets

Purpose

Use the settings registry to expose typed, searchable editor, project, export, and preview values with stable paths, defaults, validation, and explicit apply policy. Use workspace presets to switch the main dock to a task-focused tool arrangement without discarding tools the author already opened.

These systems have separate ownership and persistence boundaries. EditorSettingsRegistry owns setting metadata and typed bindings into EditorShellState; export_settings.rs owns the shipped config/exported_game.json; standalone_preview_preferences.rs owns editor-local preview overrides. EditorWorkspacePresetRegistry owns preset metadata, default selection, dock regions, and tab order from assets/editor/workspaces.json; EditorDockLayoutPreset remains a compatibility request key. Dock layout and general workspace UI posture are saved as separate local documents.

Steps

Edit Settings Safely

  1. Open Engine Settings from the main toolbar and use search, scope filters, and Modified only to locate a descriptor. Search matches the stable path, label, summary, category, scope, value type, and apply-policy label.

  2. Identify the setting by its stable path, not its display label. Current path families are:

    • editor/viewport/... for live editor overlay posture;
    • project/authoring/... for project authoring detail;
    • export/... for shipped standalone defaults; and
    • editor/preview/... for local standalone-preview overrides.

    Paths must be globally unique in EDITOR_SETTING_DESCRIPTORS. They are lookup and automation contracts and should not be renamed merely to improve UI wording.

  3. Check the scope and apply policy shown beside the setting. The current descriptors use:

    • Live (Immediate) for viewport posture and authoring density;
    • Save required (SaveRequired) for values bound to config/exported_game.json; and
    • Apply preview (PreviewApply) for values bound to the editor-local preview document.

    RestartRequired exists in the policy type for future descriptors but is not currently assigned to a setting.

  4. Enter a value within the descriptor's type and bounds. Integer and float controls enforce ranges, choices must be one of the registered options, required text must be non-empty, and HTTP URLs must start with http:// or https://. The UI uses set_draft_value, so a temporarily invalid text draft remains visible with its validation error; set_value rejects semantic invalidity before mutation and is the appropriate API for non-UI callers.

  5. Persist according to the binding owner.

    • Live editor/project values update shell state immediately. Workspace posture, including authoring density and viewport overlay state, is captured into local workspace UI state on the editor's throttled persistence pass.
    • Export values remain an in-memory form until Save Export Settings succeeds. Saving normalizes and validates the full exported settings document before atomically writing the authoring asset config/exported_game.json.
    • Preview values remain separate from export defaults. Apply Preview Only saves editor_standalone_preview_settings.json under the local config root and queues a preview-only apply. Sync Preview From Export Defaults intentionally replaces the preview draft from export defaults, saves it, and queues apply.

  6. Use the per-setting Reset to restore that descriptor's registered default. For export or preview settings, follow the normal save/apply action afterward. Reset Saved Defaults rewrites shipped export defaults but deliberately leaves preview overrides untouched. Reset UI Posture resets workspace UI state, not the dock layout and not either standalone settings document.

Apply Or Extend A Workspace Preset

  1. Choose a preset from the dock/workspace controls or Scene Command Center. The shipped stable IDs are worldbuilding, scene_wiring, characters, and atmosphere. Labels and summaries come from assets/editor/workspaces.json; the enum keeps matching fallback strings for recovery.

  2. When applied, the request reattaches detached dock tabs, builds the preset from manifest dock regions, tab order, and split ratios, and preserves every enabled, already-open or previously detached tab as an extra tab. Tool IDs resolve through EditorToolRegistry; disabled extension tools are omitted. The manifest's default_preset also drives the initial registry-built layout.

  3. Let the editor persist the result. Dock topology is stored under the local config root as aether_editor_dock_layout.json with schema version 14. Workspace UI posture is independently stored as aether_editor_workspace_ui_state.json with schema version 4 and includes active workbench, authoring density, collapsed lanes, event filters and incident state, Engine Settings sections, viewport overlay posture, per-scene UI state, surface mementos, and route history. Both use atomic writes and a 0.75-second minimum auto-persist interval.

  4. To add a setting, add a typed binding read/write path, a default function, and one EditorSettingDescriptor. Keep the descriptor path unique; choose the real scope, type validation, apply policy, and persistence target. If a new value belongs to shipped export or local preview state, extend that schema and its validation/migration tests instead of storing it generically in the registry.

  5. To add a preset, update the EditorDockLayoutPreset compatibility enum, ALL, stable id() mapping, and fallback label/summary. Add a version-1 manifest descriptor with a unique non-empty ID, label, summary, at least one tool placed under dock, unique tool IDs across every region, and each ratio in 0.1..=0.9. Every tool must be registered and owned by an editor extension. Change top-level default_preset when the new preset should become the startup layout.

  6. Verify settings, presets, persistence, and documentation:

    cargo test -p aether registry_paths_are_unique_and_cover_all_scopes
cargo test -p aether typed_validation_rejects_invalid_values_before_mutation
cargo test -p aether shipped_workspace_manifest_exposes_four_complete_presets
cargo test -p aether workspace_manifest_drives_preset_tools_and_split_ratios
cargo test -p aether editor_dock_layout_preset_preserves_user_opened_tabs
cargo run -p xtask -- docs-check --root .

Expected Outputs

  • A searchable descriptor for every exposed setting, with one stable path, typed value, default, scope, validation rule, apply policy, and concrete binding.
  • Invalid drafts displayed for correction, while validated programmatic writes reject invalid values without changing state.
  • Shipped export settings and local preview overrides persisted to different documents with explicit save/apply actions.
  • A valid version-1 workspace manifest whose stable tool IDs resolve to registered, extension-owned tools and whose dock regions own placement and tab order.
  • Preset application that changes the intended arrangement while preserving user-opened tabs.
  • Independently recoverable dock-layout and workspace-posture documents under the local config root.

Common Mistakes

  • Using a display label as a setting or preset key. Labels can change; descriptor paths, preset IDs, and tool IDs are compatibility contracts.
  • Adding registry metadata without a binding or persistence owner. EditorSettingsRegistry does not provide generic storage.
  • Calling set_draft_value from automation and assuming the value is valid. Draft writes enforce the runtime variant only so the UI can show semantic errors.
  • Editing export settings and expecting them to persist without Save Export Settings, or editing preview values and expecting the shipped export asset to change.
  • Resetting an export descriptor but forgetting to save, or using Reset Saved Defaults when the intended target was the local preview override.
  • Adding a tool to workspaces.json without registering it in EditorToolRegistry and claiming it in assets/editor/extensions.json.
  • Placing one tool in multiple dock regions or relying on a dock descriptor anchor to override manifest placement.
  • Treating workspace presets, dock persistence, and workspace UI posture as one document. They recover and reset independently.

Recovery Paths

If a setting is missing, search by its exact path with scope All and Modified only disabled, then verify it is in EDITOR_SETTING_DESCRIPTORS and included by the active Engine Settings surface. A Type mismatch row means the descriptor kind and binding value variant disagree. A validation message should be corrected before save/apply; use per-setting Reset to return to the registered default.

If export saving fails, inspect the status text, validate the full ExportedGameSettings, and verify the authoring asset path for config/exported_game.json is writable. If preview load is corrupt or unsupported, the client-local preference recovery path migrates supported older versions and otherwise recovers to defaults; resync from export defaults only when that replacement is intentional.

If a preset is incomplete, verify its manifest ID matches EditorDockLayoutPreset::id(), every tool resolves through EditorToolRegistry, every tool has an extension owner, and every split ratio is in range. A disk manifest load failure uses the compile-time shipped manifest and records EditorWorkspacePresetRegistry::load_warning(); restart after repairing the asset because the process-wide registry is lazy-initialized once.

If the dock layout cannot be parsed, the editor records a persistence error and starts from the default layout; supported older schemas migrate through version 14. Use the dock reset action when the saved topology is no longer useful. If only workbench posture, filters, overlays, or mementos are wrong, use Reset UI Posture instead. Persistence errors are retained for the editor's status/notification surfaces until a successful atomic save clears them.

Related Pages