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

Game Data Catalog

What This System Is

The game-data catalog is the author-facing source of truth for item definitions and the authored economy links that consume them. Runtime and tooling read a prepared catalog snapshot; authors should edit the source shards and generated-family manifest, then regenerate the aggregate.

How Authors Use It

assets/gameplay/game_data_catalog.manifest.json describes the catalog composition. It points at the shard files under assets/gameplay/game_data/ and names the generated aggregate output at assets/generated/gameplay/game_data_catalog.json.

The current source shards are:

  • item_taxonomy: item kinds, categories, equipment kinds, class tokens, authoring templates, and snippets.
  • item_aliases: legacy or renamed item IDs that resolve to canonical live IDs.
  • items: authored item definitions.
  • vendor_stocks: vendor inventories, costs, availability conditions, and relationship deltas.
  • crafting_recipes: recipe inputs, outputs, optional conditions, and rewards.
  • loot_tables: weighted item drops, count ranges, guarantees, and drop chances.
  • loadout_rules: starter and rules-driven item grants.
  • gathering_nodes: gatherable sources and yielded items.

The aggregate is generated from those shards plus generated item-family content. Do not hand-edit assets/generated/gameplay/game_data_catalog.json; if it drifts, repair it with:

cargo run -p aether --bin aether-generated-artifact -- --write game_data_catalog_aggregate

Use --check game_data_catalog_aggregate in review or CI to prove the aggregate still matches the source shards.

Loading Contract

The pure loader entry point is load_game_data_catalog_from_str_with_context. The context supplies the manifest shards, optional generated item-family manifest JSON, generator adapters, composition errors, and asset validation signatures. Current-asset helpers are responsible for reading files and then calling the context-driven loader.

Catalog loading:

  • parses and migrates the source schema to the current target schema;
  • composes shard records through schema descriptors;
  • appends generated item-family rows when the catalog path requires them;
  • normalizes item definitions, taxonomy templates, and reference-friendly IDs;
  • records source locations for authored and generated rows;
  • validates references and metadata before the snapshot is handed to editor or runtime code.

The manifest and loader are intentionally shard-first. If a tool edits a catalog snapshot in memory, it still needs to write the appropriate source shard or manifest-backed source rather than treating the generated aggregate as canonical.

Rules And Invariants

Item IDs And Aliases

Item IDs are stable content IDs. Runtime and authoring lookup trims IDs and resolves them case-insensitively, while validation reports duplicate IDs instead of relying on the prepared index's first-match behavior.

Aliases are compatibility rows with alias_id, item_id, and reason. They let old references survive a rename while authors migrate sources to the new ID. Alias resolution can follow alias chains and protects itself from loops.

Alias validation rejects:

  • empty alias IDs or empty target IDs;
  • duplicate aliases;
  • aliases that conflict with a live item ID;
  • self-targeting aliases;
  • aliases pointing at missing or removed items.

Reference repair workflows should prefer rewriting references to the canonical ID, then keeping a short-lived alias only when old content or external data still needs it.

Taxonomy Templates

item_taxonomy.json owns the authoring vocabulary: item kinds, categories, equipment kinds, consumable categories, weapon kinds, playable class tokens, authoring templates, and reusable snippets.

Templates are how authors make consistent items quickly. Each template has an ID, label, display-name default, ID prefix, default kind/category/stack, and optional equipment or consumable defaults. The template registry validates that IDs are unique, labels are present, stacks are nonzero, and equipment or consumable defaults match the requested item kind.

Snippets are smaller reusable edits for existing items, such as stat blocks, trade metadata, repair metadata, or consumable effects. They should be used when a field group needs to be applied repeatedly without replacing the whole item.

CSV And Bulk Import

The item authoring workbench supports bulk authoring through variants, batch edits, snippets, and import dry runs. Import accepts CSV or catalog JSON. CSV is selected when the source name ends in .csv, or when the first non-empty input line looks comma-separated rather than JSON.

The dry run produces one row per parsed item with a status:

  • Create: the item ID is new and the draft builds cleanly.
  • Update: the item ID already exists and the imported draft builds cleanly.
  • MissingFields: the row has neither an item ID nor enough identity fields to generate one.
  • Invalid: the row parsed, but item metadata or draft validation failed.

Applying an import only persists Create and Update rows. Missing item IDs can be generated from the display name using the item kind prefix, then uniqued with a numeric suffix. CSV headers are routed through game-data item field descriptors, so prefer known headers such as item ID, display name/name, kind/type, equipment slot, weapon damage, repair material, market/trade flags, and effects. The CSV parser handles quoted fields, escaped quotes, CRLF, and quoted newlines, and reports malformed quotes with line numbers.

Vendors, Crafting, Loot

Vendor, crafting, loot, loadout, gathering, farming, equipment, quest, scene, and NPC-service references all flow through the shared item reference index.

Vendor stock entries can reference both sold items and cost items. Crafting recipes reference input and output items. Loot tables reference drop item IDs with weights and quantity/chance rules. Loadout rules and gathering nodes add more item references that can become stale after item renames.

When changing an item ID, preview reference repair before saving. The game-data rewrite path covers vendor rows, crafting rows, loot drops, loadouts, gathering yields, aliases, and equipment repair materials. Some usages are intentionally diagnostic-only or are queued to their owning subsystem, including farming crop fields, equipment interfaces, quests, scene trigger conditions, and NPC services.

Generated Item Families

assets/gameplay/game_data_item_families.json generates asset-backed item rows that would be noisy or brittle to author by hand. Its schema version is checked by the production parser. Core generators include:

  • farming_crops
  • named_icons
  • grid_icons
  • grid_sheets

Player-preview authoring can add generator adapters for paperdoll or preview-specific item families. Generated rows carry provenance through GameDataGeneratedItemFamilySource: source asset path, source record path, family ID, family tag, generator name, and item ID. The catalog doctor uses that provenance so generated family entries are not treated like orphaned hand-authored items.

Generated families are still catalog content. They must validate assets, IDs, aliases, references, and schema version just like source shards.

Validation And Debugging

Structured validation covers schema version, duplicate IDs, required item metadata, item icons, paperdoll assets, aliases, vendor stock, crafting recipes, loot tables, loadout rules, gathering nodes, farming references, and gameplay-condition item references.

The item catalog doctor is an on-demand lifecycle report. It flags:

  • MissingItemReference
  • RemovedItemReferenced
  • OrphanedItem
  • StaleAlias
  • UnusedVariant

Doctor reports produce shared validation issues with repair labels and why-this-matters text. Draft, hidden, removed, deprecated, and generated item-family rows are handled differently from live authored rows so the report focuses on actionable catalog cleanup.

Run the normal bake diagnostics after catalog edits:

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

Examples

  1. Edit the source shard or game_data_item_families.json, not the generated aggregate.
  2. Use templates, snippets, batch edits, or CSV/JSON import when making repeated item changes.
  3. Preview reference repair before renaming or removing item IDs.
  4. Regenerate or check the aggregate with aether-generated-artifact.
  5. Run bake diagnostics before handing content to runtime.

Related Systems