Ryuu/AetherOnline
Watch
1
0
Fork
You've already forked AetherOnline
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Page: ui layout
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 ui layout
forgejo-actions edited this page 2026-07-11 10:33:50 +00:00
Table of contents

UI Layout

What This System Is

UI layout is Aether's authored UI document system. Authors edit .aetherui source files, the editor validates them against slot contracts and skin references, and runtime consumes the authored documents through shared layout and binding descriptors.

The built-in layout source files live under assets/ui/layouts/*.aetherui. They are JSON documents with the current UI layout format version, design size, and a rooted UiLayoutNode tree.

How Authors Use It

The schema-owned asset manifest lists the built-in layout assets and their authored surface. There are two surfaces:

  • gameplay: in-world and player HUD layouts.
  • standalone: title, login, realm, character, loading, and death screens.

Current gameplay layouts are system_menu, chat_hud, hotbar_hud, emote_panel, keybind_menu, inventory_panel, armoury_panel, character_panel, journal_panel, and npc_service_panel.

Current standalone layouts are standalone_title, standalone_login, standalone_realm_select, standalone_character_create, standalone_character_select, standalone_loading, and standalone_death.

The asset manifest in src/ui_layout/schema.rs owns the stable asset id, label, asset path, surface, export policy, and bundled fallback bytes for each built-in document.

Document Model

A layout document has a root node and stable runtime dimensions. The root node size is the runtime width and height, with a safe minimum of one pixel.

Each UiLayoutNode records its id, authored slot string, display name, node kind, rectangle, min/max size, text, skin key, font, stack layout mode, anchors, auto-size flag, and children. Supported node kinds are container, panel, button, label, text input, and image.

Layout versions migrate in memory when possible. Future versions are rejected so an older runtime does not silently reinterpret new layout data.

Rules And Invariants

Slot contracts are table-driven in src/ui_layout/slots/manifest.rs and exposed through UiLayoutSlotDescriptor. A slot descriptor owns:

  • Stable UiLayoutSlotId
  • Owning layout asset
  • Authored slot string
  • Required flag
  • Default label
  • Optional gameplay binding
  • Optional runtime action
  • Optional dynamic text role
  • Optional text input role
  • Optional runtime-owned region role

Slot strings are the authored handshake between a .aetherui node and runtime behavior. Treat them as stable API. Renaming a slot requires updating the slot manifest, default/bundled documents, runtime adapters, validation expectations, and any localization or template references that mention the old slot.

Validation reports missing required slots and duplicate resolved slots for both gameplay and standalone layouts. Optional slots may be absent, but if they appear more than once they still violate the contract.

Skin References

Node skin values are semantic keys, not texture paths. Node kinds declare whether they support frame/button skins, button-only skins, image-only skins, or no skin.

Validation resolves authored skin keys through the UI skin manifest. It reports unknown skin names, missing skin textures, and node-kind/skin-family mismatches. Labels ignore skins, so a label with a non-empty skin is reported as a warning.

When a layout references a skin, layout dependency extraction includes the relevant skin key catalog and resolved skin texture dependencies. That is what makes skin changes participate in stale-cache and bake decisions.

Generated Manifests

assets/ui/layouts/manifest.json is generated from UiLayoutAssetDescriptor rows. Do not hand-edit it. Update the descriptor rows in src/ui_layout/schema.rs, then run the generated-artifact workflow so the checked-in manifest matches the schema.

The editor also loads ui/layout_templates.json through the UI layout authoring manifest. Templates are insert-time authoring helpers; they do not replace the required slot manifest.

Validation And Debugging

The authoring bake product is ui.layout.runtime_cache. It writes runtime/ui/ui_layout_runtime_cache.json with schema version 1.

The runtime cache contains a validation summary and one record per included layout: id, asset path, label, surface, export policy, required slots, and the full authored document. The baker includes every UiLayoutAssetId::ALL document whose export policy is included in runtime cache output.

Default bake inputs load the current .aetherui source document for each built-in asset and capture a dependency signature for that path. The product invalidation key is ui/layouts/*.aetherui; changes to layout source files invalidate the runtime cache. The broader authored asset dependency graph also tracks templates, fonts, skin key catalogs, and skin textures used by a layout.

After changing a layout source or manifest descriptor, run:

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

Use the generated-artifact gate when changing assets/ui/layouts/manifest.json or descriptor rows.

Editor And Runtime Consumption

The editor consumes source documents and the UI layout authoring manifest so authors can browse assets, slots, and insert templates. Preview uses the shared resolver and binding descriptors, which keeps editor feedback close to runtime behavior.

Runtime consumes authored documents through shared resolution and renderer paths. Gameplay UI registers the gameplay layout surfaces and dispatches gameplay slot actions into gameplay UI commands. Standalone screens load their standalone layout assets and map standalone actions, dynamic text roles, and text-input roles through the slot manifest.

Editor code may rewrite or save .aetherui source files. Runtime code should not mutate source documents; it should consume baked cache records or bundled fallbacks and report diagnostics when required contracts are not satisfied.

Examples

  1. Edit the .aetherui source file under assets/ui/layouts.
  2. Keep required slot strings present and unique.
  3. Use skin keys supported by the node kind.
  4. If adding a runtime behavior, add a slot manifest descriptor and runtime action or role.
  5. If adding a new built-in layout, add an asset descriptor and regenerate assets/ui/layouts/manifest.json.
  6. Bake with diagnostics before runtime testing.

Related Systems