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

Player Preview Animation Profile

Purpose

Player preview animation profiles describe the clips, actions, timeline cues, effect overlays, and per-layer sprite overrides used by the character paperdoll preview and animation workbench. The default authored profile is assets/character/preview_animation_profile.json, referenced in code as the asset-relative path character/preview_animation_profile.json.

Use this profile when an authored player action needs to appear in preview, be reviewed as a fixture, or produce paperdoll snapshot images.

Steps

  1. Edit the root manifest or split fragment through the animation workbench when possible.
  2. Add or update clips with matching frame and timer counts.
  3. Add action metadata, typed cues, effects, and layer overrides for the authored action.
  4. Use scenario proof before exporting fixtures.
  5. Generate paperdoll snapshots or fixture exports for review.
  6. Run bake or validation checks before handing the profile to runtime.

Split Profile Files

The root profile file is a manifest with version: 1 and a fragments list. The editor save path writes split fragments beside the manifest in a directory named after the manifest stem. For the default profile, that means:

  • assets/character/preview_animation_profile.json
  • assets/character/preview_animation_profile/core.json
  • assets/character/preview_animation_profile/combat.json
  • assets/character/preview_animation_profile/tools.json
  • assets/character/preview_animation_profile/gathering.json
  • assets/character/preview_animation_profile/interact.json
  • assets/character/preview_animation_profile/movement.json
  • assets/character/preview_animation_profile/fishing.json
  • assets/character/preview_animation_profile/reaction.json

Fragments may contain clips, actions, action_effects, and layer_overrides. Empty buckets are omitted from the manifest, and stale fragment files are removed when a save no longer produces that bucket.

Bucket assignment is descriptor-driven. Actions prefer their category; otherwise clips, effects, and overrides are assigned from the key. The current bucket slugs are core, combat, tools, gathering, interact, movement, fishing, and reaction.

Clips

Each clip is keyed by key and displayed with name. It selects a paperdoll page, then maps animation frames to timers. frames and timers must have the same length.

Important clip fields:

  • root_motion: optional per-frame movement; when present, it must match the number of frames.
  • facing_override: forces down, up, left, or right.
  • side_only and side_fallback_facing: allow side-authored clips to stand in for left/right views.
  • body_rows and tool_rows: override facing row selection for body and tool sheets.
  • looped: marks clips that should repeat in preview.
  • tool_name_token and tool_pages: connect action clips to tool sheets; tool_pages requires a tool token.

Actions And Cues

Actions connect clips to gameplay-facing metadata. Every action needs a key and label; optional fields include category, required_equipment, gameplay_mode, stamina_cost, mana_cost, cooldown_ms, lockout_ms, interrupt_policy, completion_follow_up, and events.

Valid categories are combat, tools, gathering, interact, movement, fishing, and reaction. Valid equipment tokens include hands, farm_tool, pickaxe, axe, hammer, bug_net, fishing_rod, bow, polearm, and one_hand. Valid gameplay modes are exploration, bow_combat, polearm_combat, and one_hand_combat.

Each event has a step and can use a legacy event string or typed cues. Typed cues are preferred:

  • vfx: effect_key and optional image_path.
  • sfx: audio cue.
  • camera: camera cue.
  • hitbox: hitbox key.
  • projectile: projectile_key and optional effect_image_path.

Known legacy events include gameplay_window_open, gameplay_window_close, projectile_spawn, hit_frame, and recovery_frame.

Effects And Layer Overrides

action_effects add visual overlays for a keyed action or clip. Each effect has a key, optional facing, optional image_path, and at least one step. Steps can set frame_id, atlas, offset, flip_x, flip_y, sorting, and rotation_degrees.

layer_overrides replace or hide a paperdoll layer for a keyed action or clip. Each override has a key, optional facing, optional asset_page, a layer, and at least one step. Supported layers are body, tool, tool_a, and tool_b. Steps can set hidden, atlas, offset, sorting, flip_x, and flip_y.

Facing lookup prefers an exact facing match, then side for left/right clips, then the generic empty-facing entry.

Scenario Proof And Fixture Export

The animation workbench builds scenario proof from the selected source row and its runtime comparison. Use it before exporting fixtures so the authored clip, expected timeline labels, and observed runtime snapshots agree.

Fixture export produces an AnimationFixtureExport JSON payload with:

  • fixture_id
  • source_key and source_label
  • proof steps
  • exported frames
  • runtime_snapshots
  • pack gate references such as pack_export:replay_fixture, engine_health:animation_fixture, and scenario_proof:<source_key>

The workbench previews the JSON and uses assets/fixtures/animation/<fixture_id>.json as the default fixture destination.

Review Image Generation

Use aether-paperdoll-snapshot when reviewers need PNG sheets or GIFs instead of an in-editor preview. The packaged command name is aether-paperdoll-snapshot; from the repo, run it through Cargo:

cargo run --bin aether-paperdoll-snapshot -- --clip bow_shoot_up --facing down --step 0 --layer all --out target/paperdoll-animation-export/review/bow_shoot_up_down.png --scale 4

Batch export generates review sheets and GIFs under target/paperdoll-animation-export unless another output directory is supplied:

cargo run --bin aether-paperdoll-snapshot -- --export-all --family classic --out-dir target/paperdoll-animation-export/classic --scale 4
cargo run --bin aether-paperdoll-snapshot -- --export-all --family farmer --out-dir target/paperdoll-animation-export/farmer --scale 4

The snapshot CLI supports classic and farmer families, facings down, up, left, and right, layers all, base, outfit, tool-a, tool-b, effect, and farmer tracks such as 01body, 14head, farmer_tools, farmer_bow, fishing_right_left, and slash_effects. Tool and offhand variants can be forced with --tool-token, --tool-variant, --offhand-token, and --offhand-variant.

Expected Outputs

A valid profile save keeps the root manifest and split fragments synchronized, provides playable clip/action rows in the workbench, produces scenario proof for fixture export, and generates PNG sheets or GIFs under target/paperdoll-animation-export when snapshot export is requested.

Common Mistakes

  • Editing a split fragment without keeping the root manifest in sync.
  • Giving a clip mismatched frames and timers.
  • Adding root_motion with a different length than the clip frame list.
  • Using unsupported equipment, category, gameplay mode, facing, or layer tokens.
  • Adding effects or layer overrides without at least one step.

Validation Checklist

Before handing a profile to runtime or review:

  • Save through the workbench so the root manifest and split fragments stay in sync.
  • Confirm every clip has key, name, at least one frame, and matching frames/timers.
  • Confirm root_motion, if present, has one entry per frame.
  • Confirm action categories, equipment tokens, gameplay modes, facing tokens, and layer names use supported values.
  • Keep lockout_ms less than or equal to cooldown_ms when both are set.
  • Give every effect and layer override at least one step.
  • Keep atlas cell sizes positive and effect rotations finite.
  • Use typed cues for new authoring, and make sure cue payloads are not blank.

Recovery Paths

When preview fails, first save through the workbench to rewrite the root and fragments, then fix the first validation error in the clip/action/effect bucket. If review images look wrong, export a single frame with explicit --clip, --facing, --step, and --layer arguments before running --export-all. If a fixture proof no longer matches runtime, regenerate scenario proof from the current profile and update the fixture export.

Related Pages