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

UI Skins

What This System Is

UI skins map authored semantic keys to runtime image entries. Authors reference keys such as menu-button-primary, slot-frame-filled, or close-icon; runtime profiles decide which built-in skin manifest supplies the pixels for each key.

How Authors Use It

Built-in skins live under assets/ui/*/skin.json. The current built-ins are mana-soul (default), dark-dwellers, and dragon-regalia. The manifest registry requires metadata, a non-empty id and label, a matching asset directory, unique ids and manifest paths, and exactly one default skin.

The loader prepares a manifest by reading each entry, expanding generated entries, validating assignments, and indexing resolved textures. Prepared manifests are cached by asset dependency revision so editor and runtime surfaces can reuse the same resolved data until a manifest, texture, registry, or catalog dependency changes.

Rules And Invariants

assets/ui/skin-key-catalog.json owns the canonical key order and author-facing grouping. Current groups include Editor, Chat, Status, Menu, Inventory, Window Controls, Navigation, and Pointers. Keys that appear in a manifest but not in the catalog are still accepted, then appended under an Other group.

The catalog is strict where it needs to be strict:

  • Duplicate ordered keys fail validation.
  • Catalog keys that are missing from every manifest fail validation.
  • Profile assignments to unknown keys fail validation.
  • A profile assignment fails if it points a key at a skin manifest that does not define that key or a compatible fallback.

Add new UI art by adding or generating the manifest entry first, then adding the key to the catalog when authors should see it as a supported semantic target.

Entry Kinds

Each manifest entry has a kind, texture, and optional source_rect, borders, content_padding, and paint_center.

  • nine_slice: a framed surface with four borders and a scalable center. Bevy builds a TextureSlicer from the borders.
  • three_slice_h: a horizontally sliced surface, usually for rows, tabs, or button-like strips. Bevy builds a horizontal slicer from the entry borders.
  • bar: a slice-capable status or fill surface. Bevy uses the same slicer path as other sliced entries.
  • icon: an image-only entry. It does not receive a slicer.
  • frame: an unsliced frame/static image entry. It does not receive a slicer.

source_rect is converted to the runtime texture rectangle. Bevy skin entries use nearest sampling, so atlas coordinates and border values should be exact rather than relying on filtering.

Generated Entries

Manifests can define generated_entries for families that reuse the same style rules with different texture slices. A generated entry names a new key, a template_key, a replacement texture, and an optional replacement source_rect. The loader clones the template entry, applies the replacement fields, and inserts the generated key into the manifest.

Generated entries are validated like authored entries. Empty generated keys, duplicate generated keys, missing templates, and empty textures are load errors. This is how the built-ins provide expanded families such as cursor variants, alternate panel frames, equipment slot frames, map-frame, and slot-frame-filled without repeating all style fields by hand.

Legacy Aliases

Legacy compatibility exists at two levels:

  • Built-in skin ids still accept old ids such as mana-soul, dark-dwellers, and dragon-regalia.
  • Legacy profile wire with { base, key_overrides } expands into explicit per-key assignments.

Missing keys may also resolve through compatible fallbacks. Examples include cursor-target-icon-alt falling back to cursor-target-icon, slot-frame-filled falling back to slot-frame, map-frame falling back to portrait-frame, and compass-icon falling back to close-icon. Equipment pants and generic *-variant-* keys have family-aware fallback chains.

Keep aliases in the resolver rather than scattering one-off substitutions through layout rendering. That keeps Egui, Bevy, validation, and standalone preview on the same compatibility path.

Runtime Profiles

UiSkinProfile can be uniform, where one built-in skin supplies every key, or per-key, where selected keys are assigned to different built-ins. Profiles normalize into explicit assignments and expose a stable signature shaped like:

assignments=key=skin|key=skin

Profile dependency paths include the skin registry, key catalog, assigned manifests, and resolved textures. This lets bake, preview, and runtime cache invalidation respond to skin changes without treating every UI document as changed.

Egui Cache

GameUiSkinCache is the Egui-side cache. It resolves the active profile through the shared resolved-profile cache and stores egui::TextureId values with the underlying Bevy image handles. Cache refresh uses the egui_ui_skin cache name and a small LRU profile cache.

Refresh failures become EngineReportSource::UiSkins reports. Typical causes are missing textures, invalid manifest JSON, generated-entry errors, unknown profile keys, or a profile assigning a key to a skin that does not define it.

Bevy Cache

BevyUiSkinCache is the runtime/standalone Bevy UI cache. It stores BevyUiManifestSkin entries containing the entry kind, image handle, optional source rectangle, and optional slicer. NineSlice, ThreeSliceH, and Bar entries get slicers; Icon and Frame entries do not.

The cache refreshes through the same profile dependency path as Egui. Refresh errors are logged and the old cache remains in place, which prevents one bad manifest edit from immediately blanking every existing UI surface.

Validation And Debugging

When a skin edit fails to appear, check these layers in order:

  1. The manifest JSON parses and its metadata matches the built-in registry path.
  2. Every generated entry has a valid key, template, and texture.
  3. The key exists in at least one manifest and, if listed in skin-key-catalog.json, appears only once.
  4. The active UiSkinProfile assigns the key to a built-in that can resolve it directly or through a supported fallback.
  5. The referenced texture path exists under the asset root.

Use cache reset helpers only after fixing the source data. Resetting the manifest/profile caches clears stale prepared Arc values, but it does not make invalid data valid.

Layout Node References

.aetherui nodes expose an optional skin string. Empty means no skin. Authored aliases resolve to canonical keys before validation and runtime rendering; examples include button-primary to menu-button-primary, button-secondary to menu-button-secondary, button-danger to menu-button-danger, tab-selected to menu-tab-active, and selected text input to menu-button-primary.

Skin support depends on node role:

  • Frames, containers, panels, and text inputs accept frame or button-like skins.
  • Buttons accept button skins.
  • Image nodes accept image-only skins.
  • Labels ignore skins and validation warns when a label tries to use one.

Standalone Bevy UI, gameplay Bevy UI, and editor preview resolve layout node skins through the same authored resolver, so a key that passes validation should render consistently across those surfaces.

Examples

To add a new button skin, add the entry to the built-in manifest under assets/ui/<skin>/skin.json, add or confirm the semantic key in assets/ui/skin-key-catalog.json, reference that key from a .aetherui node that supports button skins, then run bake diagnostics before checking preview or runtime.

Related Systems