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

Game Server Catalog Load Health And Fallback Policy

Purpose

Game-server catalog health turns file reads, JSON parsing, duplicate ids, and cross-catalog integrity checks into one startup decision. Required failures stop the server before database connection and runtime assembly proceed. Optional failures may substitute empty content, but remain visible as warnings and zero-count summaries.

ServerContentBundle Order

ServerContentBundle::load resolves the workspace asset root and uses one mutable CatalogLoadHealth for the complete load. Order is part of the authority contract:

  1. ServerGameplayCatalogs::load_from_asset_root loads game data, NPC services, quests, dialogue, and the manually attached world catalogs.
  2. Gameplay integrity checks add duplicate-id and cross-catalog reference failures after all gameplay catalogs are available.
  3. SceneCombatCatalogs::load_from_asset_root receives the already parsed GameDataCatalog. Mob loot hydration therefore reuses the same normalized item and loot-table indexes instead of parsing game data again.
  4. Scene-combat integrity checks add normalized mob/NPC duplicate failures and related reference failures.
  5. The bundle checks has_required_failures() once, after every load and integrity pass has had a chance to report. Any required issue returns the complete health object.
  6. On success, the same aggregated health snapshot is cloned into gameplay and scene-combat catalogs, then both catalog sets are wrapped in Arc.

The bundle test server_content_bundle_loads_game_data_once_and_builds_normalized_indexes verifies that game data has one summary and is reused for mob loot hydration. server_content_bundle_reports_duplicate_and_missing_references_in_one_health_report verifies that duplicate item/mob ids and missing loot references survive in one failure report.

Required And Optional Fallback

Requirement Read/parse result Health projection Startup result
Required The loader returns Default temporarily so later catalogs and integrity checks can still run. It does not record a successful summary for that fallback. Error, blocking, CatalogLoad domain. The aggregate fails after collection. The empty value must never reach a running server.
OptionalFallbackToEmpty The loader returns Default and records its zero-value telemetry summary. Warning, non-blocking, CatalogLoad domain. Startup may continue with the related feature incomplete.

CatalogLoadStage::Read separates path/permission/missing-file failures from CatalogLoadStage::Parse JSON or semantic failures. A registry-backed issue targets catalog_registry:<registry_id>; a manual issue targets catalog:<label>. Both carry the resolved source path and a reason explaining whether the issue blocks startup.

Current intentional exceptions are code-backed, not global policy:

  • Server dialogue uses the manual dialogue/dialogue_catalog.json descriptor and may fall back to an empty catalog.
  • Enemy content treats a missing file as an optional, silent empty catalog and other read failures as optional warnings. Once the file exists, malformed JSON and invalid references are required failures.
  • The other manually attached gameplay world catalogs are currently required. Do not infer optional behavior merely because their runtime type implements Default.

Aggregated Health

CatalogLoadHealth preserves an ordered list of issues and successful/fallback summaries. Summaries carry catalog label, relative path, optional registry id, and catalog-specific metrics such as item, quest, mob, route, or encounter counts. Duplicate detection canonicalizes ASCII ids before reporting, so case or surrounding whitespace cannot hide a collision.

validation_report(group) converts the aggregate into the shared validation schema. format_required_failures("server content") includes only blocking messages and is the error returned by load_authoritative_catalogs. This is why startup can report several independent missing, duplicate, and dangling-reference problems in one run instead of stopping at the first unreadable file.

Because the successful bundle installs the same health snapshot in both catalog owners, startup calls to gameplay_catalogs.log_summary() and scene_combat_catalogs.log_summary() can emit the same aggregate issue/summary under two catalog_domain values. Correlate repeated entries by registry id, path, source, and stage rather than counting each domain copy as a separate load.

Registry And Manual Boundaries

The world-domain catalog registry owns semantic identity, aggregate paths, source patterns, item-id namespaces, source priority, fallback rules, and authority availability. It intentionally performs no filesystem probing and does not attach loaders.

The current authoritative registry is game data, quest, NPC service, mob, and NPC. Gameplay uses CatalogDescriptor::from_registry for game data, quest, and NPC service. Scene combat uses registry metadata for NPC and for its custom mob loader, which also reads sorted mob fragments and hydrates loot from shared game data.

Dialogue exists in the wider registry but has authority_available == false there; its aggregate authoring path is not the manual server dialogue path. World event, interaction, object, mechanism, gameplay assembly, scene phase, NPC routine, world time, world travel, world exploration, housing, and enemy content are also manually attached today. Manual loaders must explicitly supply the same health data: label, path, requirement, stage, error, telemetry, and any integrity issues.

Adding an enum or registry row does not make the server load a catalog. Conversely, adding only a manual server loader leaves editor/catalog discovery without shared registry identity. Choose the boundary deliberately.

Logs And Triage

Successful or optional-fallback bundles use these structured messages:

  • loaded authoritative catalog at info with catalog_domain, optional registry_id, catalog, path, and metric text.
  • optional catalog load fell back to empty at warning with domain, registry, catalog, relative path, resolved source, stage, and error.
  • loaded authoritative gameplay catalogs and loaded authoritative scene combat catalogs with owner-specific aggregate counts.

CatalogLoadHealth::log_issues defines required catalog load failed at error, but normal startup returns a failed bundle before the per-owner summary log calls. The startup error is therefore the formatted server content failed required catalog health: ... aggregate. If startup exits before database connection, search that message for the first source path and stage, then fix every reported issue before retrying.

Use these focused checks while triaging:

cargo test -p aether-game-server catalog_health
cargo test -p aether-game-server server_content_bundle
cargo test -p aether-game-server startup_catalog_loading_fails_before_runtime_with_required_catalog_errors
cargo test -p aether-world-domain catalog_registry

Adding A Catalog

  1. Decide whether the catalog needs shared semantic identity. If so, add its registry id, descriptor, source patterns, item-id kinds, source layers, fallback rule, and authority availability in catalog_registry.rs. Keep an authoring-only registry out of authoritative_catalog_registry() until a server owner actually loads it.
  2. Define the file type, normalized runtime catalog, Default, conversion/parser, and telemetry. Use CatalogDescriptor::from_registry for a simple JSON aggregate. A custom sharded or hydration loader may remain manual, but should copy requirement/path/registry id from the shared descriptor when one exists.
  3. Attach the loader to ServerGameplayCatalogs or SceneCombatCatalogs in dependency order. Shared prerequisites must load once and be passed down, as game data is passed to scene combat.
  4. Record read and parse failures with the correct requirement. Record a summary on success and on allowed empty fallback. Add duplicate and cross-reference checks to the post-load integrity pass so all dependencies are available.
  5. Add owner count fields to log_summary, and add fixture-workspace tests for success, missing/invalid input, fallback behavior, normalized duplicate ids, and aggregate cross-catalog failures.
  6. Run the focused commands above, then run cargo run -p xtask -- quality-gate --root . --profile full when the change affects shared registry metadata or startup behavior.

Do not downgrade a required catalog to optional merely to make startup pass. Optional means the running feature is explicitly designed to operate against an empty catalog and expose the degraded state.

Related Pages