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

NPC Services

What This System Is

NPC services turn an NPC interaction into an overlay of shop, crafting, or direct service actions. They are authored in assets/npc/npc_service_catalog.json and linked from NPC interaction slots through service event IDs.

Every service ID uses this shape:

npc_service:<npc>|<service>

Examples:

  • npc_service:merchant|shop
  • npc_service:blacksmith|forge
  • npc_service:healer|heal
  • npc_service:innkeeper|inn
  • npc_service:toolsmith|shop

How Authors Use It

The NPC part must match the owning NPC interaction. Validation rejects malformed IDs, empty parts, and non-quest NPC interactions that point at missing service definitions.

Authoring Schema

Each service definition has:

  • event_id: the full npc_service:<npc>|<service> ID.
  • title: overlay title.
  • summary: short overlay description.
  • kind: shop, service, or quest.
  • vendor_stock_id: optional vendor stock source.
  • crafting_recipe_ids: optional crafting recipe sources.
  • entries: optional direct service entries.

Direct entries have:

  • id
  • label
  • description
  • availability_conditions
  • cost_items
  • effects
  • unlock_ids
  • event_ids
  • relationship_delta

Entry IDs are resolved case-insensitively when a player selects an overlay action.

Overlay Entry Sources

A service overlay can gather entries from three sources:

  • Direct entries from the service definition.
  • Vendor stock entries from vendor_stock_id.
  • Crafting recipes listed in crafting_recipe_ids.

The projection path resolves those sources into one overlay list. Prepared service catalogs index the same three entry kinds so repeated overlay builds and selected-entry lookups can reuse the prepared data when the catalog sources still match.

Rules And Invariants

Costs come from the selected entry source:

  • Direct entries use cost_items.
  • Vendor entries use their stock entry cost_items.
  • Crafting entries use recipe input_items.

Availability conditions use NPC-state condition tokens. If the condition parser cannot evaluate the condition or the NPC context is missing, the option is treated as unavailable rather than accepted optimistically.

Effects are projected into gameplay operations, including scene variables, quest flags, party tags, inventory deltas, reputation deltas, unlocks, runtime events, and relationship deltas. Cost items are applied as negative inventory deltas as part of the selected entry transaction.

Shipped Services

The current service catalog includes:

  • merchant|shop: Traveling Wares, a shop backed by vendor stock merchant_shop_core.
  • blacksmith|forge: Forge Services, a service backed by recipes temper_blade and reforge_edge.
  • healer|heal: Healing Services, direct entries bind_wounds and restore_spirit.
  • innkeeper|inn: Inn Services, direct entries rent_room and home_cooked_meal.
  • toolsmith|shop: Starter Tool Shop, a shop backed by vendor stock vendor.tools.starter.

Use the full npc_service:<npc>|<service> form in NPC interactions; the shortened forms above are only for compact documentation.

NPC Interaction Links

NPC catalog interaction slots link to services by setting their interaction event_id to the service ID. For example, the merchant shop interaction points at npc_service:merchant|shop, while the blacksmith forge interaction points at npc_service:blacksmith|forge.

Validation enforces two important ownership rules:

  • The service must exist for non-quest service interactions.
  • The service owner NPC in the ID must match the NPC that exposes the interaction.

This keeps overlay actions from silently opening another NPC's shop or applying service effects under the wrong relationship context.

Local Vs Server Ownership

Local preview and offline flows may call the local service authority helper directly. That helper exists for editor and preview simulation.

Authoritative runtime paths must submit gameplay action requests instead. The client queues service overlay and entry requests when realtime is available, and only falls back to local preview behavior when that mode is allowed. The game server resolves the selected NpcServiceOverlay or NpcServiceEntry, loads authoritative inventory and currency state, checks availability and duplicate-output rules, then commits costs and effects through gameplay authority.

In practice: authors can preview services locally, but player-owned inventory, currency, quest, and service outcomes belong to the server.

Validation And Debugging

Run the shared bake diagnostics after editing assets/npc/npc_service_catalog.json or the NPC interactions that reference it:

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

If an overlay does not open, check the service ID shape, the owning NPC id, referenced vendor stock or recipe ids, and availability conditions before investigating runtime transport.

Examples

  • Use the full npc_service:<npc>|<service> ID in both the service catalog and NPC interaction.
  • Keep the NPC ID portion equal to the owning NPC.
  • Choose shop for vendor-stock overlays, service for direct or crafting service overlays, and quest only for quest-owned service flow.
  • For vendor services, verify the vendor_stock_id exists in game data.
  • For crafting services, verify every recipe ID exists in game data.
  • For direct entries, keep id stable because it is the selected overlay action key.
  • Express costs in cost_items for direct entries, or let vendor stock and recipe definitions provide their own costs.
  • Add availability conditions only when they can be evaluated from NPC/service context.

Related Systems