@roost2d/chikn-rigs

Apache-2.0 Chikn/Roostr rig definitions and animation metadata for Roost2D. This package contains no Chikn images and grants no rights to the separately licensed artwork.

npm install @roost2d/contracts @roost2d/rig2d @roost2d/chikn-rigs

import {
  applyCharacterRecipe,
  CHARACTER_RECIPE_SCHEMA,
  loadChiknAnimations,
  loadChiknRig,
} from '@roost2d/chikn-rigs';
const [definition, clips] = await Promise.all([loadChiknRig(), loadChiknAnimations()]);

const recipe = {
  schema: CHARACTER_RECIPE_SCHEMA,
  species: 'chikn',
  skinId: 'Celestial',
  traitGroupIds: ['head/admiral', 'tail/golden-plumage'],
  animationId: 'chikn.walk',
};

applyCharacterRecipe(rig, recipe, definition, clips);

Both species ship the same 40 animation names, prefixed with chikn. or roostr.:

• Movement: walk, slowed, fly, run, sneak, crouch, jump, fall, land, dodge, charge, swim, spawn_drop
• Combat: attack, peck, attack_peck, attack_heavy, block, parry, kick, wing_slap, headbutt, cast
• Reactions: hit, stagger, knockback, knockdown, get_up, death_burst
• Emotes: extraction_bow, draft_cheer, victory, wave, dance, panic
• Ambient: idle_breathe, idle_alert, sleep, eat, look_around

Loop and loop-mode metadata travels with every clip. One-shots preserve their authored end pose, so call resetPose() before switching independently previewed actions; persistent states such as knockdown can instead flow directly into get_up.

Resolve each definition.attachments[].texture.assetId through a separately hosted Chikn runtime manifest before creating the display factory. Chikn integration tutorial.