agentleFS
chrisgliddonchrisgliddon/bevy-skills/skills/bevy-animation/SKILL.md

bevy-animation

Skill29 starsChanged 11 days agoMITView on GitHub

Use when wiring `AnimationPlayer` + `AnimationGraphHandle`, building an `AnimationGraph` from glTF clips, blending state-driven animations with `AnimationTransitions::play`, isolating body parts with `AnimationMask`, firing gameplay sync via `#[derive(AnimationEvent)]` + `On<E>` observers, tweening with `AnimatableCurve` / `EaseFunction` / `CubicSegment::new_bezier_easing` from `bevy::curve`, or applying the 12 Basic Principles of Animation to 3D characters in Bevy 0.20.

The file

We split this skill into the rules it gives an agent

2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    gltf_animation is on by default: No opt-in needed unless you ran default-features = false.

    line 139
  2. Very specific:

    Out of scope in 0.20 core animation: No built-in IK, no KHR_animation_pointer (still unsupported by bevy_gltf 0.20.1), particles are …

    line 146

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Bevy 0.20 — Animation (graphs, blending, events, 12 principles)

When to use this skill

  • Loading a glTF clip and playing it on a character: AnimationPlayer + AnimationGraphHandle.
  • Cross-fading between idle / walk / run via AnimationTransitions::play(player, node, Duration).
  • Building an AnimationGraph in code: blend nodes, additive nodes, weights, AnimationMask.
  • Triggering gameplay events from a clip timeline (footsteps, hitbox activation, VFX cues) with #[derive(AnimationEvent)] + clip.add_event_to_target(...) + On<MyEvent> observers.
  • Procedural tweening without an AnimationClip — sampling a Curve per frame via EasingCurve + EaseFunction or CubicSegment::new_bezier_easing.
  • Applying the 12 Basic Principles of Animation (Thomas & Johnston, 1981) to a Bevy character.
  • Importing a Blender rig and finding bones aren't animated — usually the Name requirement for AnimationTargetId::from_name.
  • Fixing bevy::math::curve / bevy::math::cubic_splines import errors after upgrading to 0.20.

Canonical end-to-end pattern

Verified against bevy = "0.20" — cargo check clean in bevy-skills-tester/examples/bevy_animation.rs.

use bevy::{
    animation::{
        animated_field,
        animation_curves::{AnimatableCurve, AnimatableKeyframeCurve},
        AnimationEvent, AnimationTargetId,
    },
    prelude::*,
};
use core::time::Duration;

#[derive(AnimationEvent, Clone)]
struct FootstepEvent { foot: u8 }

fn setup(
    mut commands: Commands,
    asset_server: Res<AssetServer>,
    mut clips: ResMut<Assets<AnimationClip>>,
    mut graphs: ResMut<Assets<AnimationGraph>>,
) {
    // 1. Load a glTF clip
    let walk: Handle<AnimationClip> =
        asset_server.load("models/character.glb#Animation0");

    // 2. Build a tiny procedural clip with a sample curve + an event
    let bone = AnimationTargetId::from_name(&Name::new("Hips"));
    let tween = AnimatableKeyframeCurve::new([
        (0.0_f32, Vec3::ZERO),
        (0.5,     Vec3::new(0.0, 1.0, 0.0)),
        (1.0,     Vec3::ZERO),
    ]).expect("strictly-increasing times");
    let curve = AnimatableCurve::new(animated_field!(Transform::translation), tween);
    let mut proc = AnimationClip::default();
    proc.add_curve_to_target(bone, curve);
    proc.add_event(0.5, FootstepEvent { foot: 0 });
    let proc = clips.add(proc);

    // 3. Compose a graph: root → walk + additive(proc, mask=group 0 excluded)
    const MASK_GROUP_0_BIT: u64 = 1 << 0;
    let mut graph = AnimationGraph::new();
    let root = graph.root;
    let _walk_node = graph.add_clip(walk, 1.0, root);
    let additive = graph.add_additive_blend(0.5, root);
    let _proc_node = graph.add_clip_with_mask(proc, MASK_GROUP_0_BIT, 1.0, additive);

    // 4. Spawn the player entity (bones come from the loaded glTF scene)
    commands.spawn((
        Name::new("AnimationRoot"),
        AnimationPlayer::default(),
        AnimationGraphHandle(graphs.add(graph)),
        AnimationTransitions::new(),
    ));
}

fn start(mut q: Query<(&mut AnimationTransitions, &mut AnimationPlayer), Added<AnimationPlayer>>) {
    use bevy::animation::{graph::AnimationNodeIndex, RepeatAnimation};
    for (mut tx, mut player) in &mut q {
        tx.play(&mut player, AnimationNodeIndex::new(1), Duration::from_millis(250))
            .set_repeat(RepeatAnimation::Forever);
    }
}

fn on_footstep(trigger: On<FootstepEvent>) {
    let foot = trigger.foot;                        // On<E> derefs to &E
    let _entity = trigger.trigger().target;          // AnimationEventTrigger::target
    let _ = foot;
}

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)                 // gltf_animation is a default feature
        .add_systems(Startup, setup)
        .add_systems(Update, start)
        .add_observer(on_footstep)
        .run();
}

Topics

TopicReference
Building blend / additive graphs, AnimationMask, hot-swapreferences/animation-graph.md
Blender → glTF → Bevy import: Name, axis, multi-clip, morph targets, unsupported extensionsreferences/gltf-import.md
Procedural animation in Update vs FixedUpdate, root-motion extractionreferences/procedural-animation.md
Idle / walk / run blending; AnimationTransitions::play + Bevy States integrationreferences/state-machines.md
#[derive(AnimationEvent)], add_event_to_target, On<E> observer wiringreferences/animation-events.md
AnimatableCurve, EasingCurve, EaseFunction, cubic-bezier, UnevenSampleAutoCurvereferences/curves-and-tweening.md
AnimationPlayer cost, skin buffers, graph complexity, runtime graph swapsreferences/performance.md
Principles — Slow In/Out, Timing, Anticipation → easing + durationreferences/principles-easing-and-timing.md
Principles — Squash & Stretch, Arc, Exaggeration → Transform keyframesreferences/principles-transform-keyframes.md
Principles — Staging, Follow Through, Secondary Action → graph layering + masksreferences/principles-graph-layering.md
Principles — Straight-Ahead vs Pose-to-Pose, Solid Drawing, Appeal → upstream authoringreferences/principles-authoring.md

The 12 Basic Principles of Animation

The four principles-*.md references group Thomas & Johnston's twelve principles by which Bevy primitive they actually exercise. Quick map:

  • Easing & Timing — Slow In/Out, Timing, Anticipation map to EaseFunction / EasingCurve / CubicSegment::new_bezier_easing and clip duration + ActiveAnimation::set_speed.
  • Transform keyframes — Squash & Stretch, Arc, Exaggeration are AnimatableKeyframeCurve over Transform::scale / ::translation via animated_field!.
  • Graph layering — Staging, Follow Through & Overlapping Action, Secondary Action are AnimationGraph::add_additive_blend + AnimationMask group isolation.
  • Authoring — Straight-Ahead vs Pose-to-Pose, Solid Drawing, Appeal live in your DCC tool (Blender, Maya). Bevy plays whatever you authored.

Gotchas

  • 0.20: curves moved to bevy_curve. bevy::math::curve::{EasingCurve, EaseFunction} and bevy::math::cubic_splines::CubicSegment are now bevy::curve::{EasingCurve, EaseFunction} and bevy::curve::cubic_splines::CubicSegment. bevy::prelude still re-exports them, so most code only needs the use lines fixed. Signatures are unchanged (EasingCurve::new(start, end, ease_fn), CubicSegment::new_bezier_easing(p1, p2)).
  • 0.19: AnimationTargetId hash algorithm changed. Different joint hierarchies no longer collide. Regenerate any serialized target IDs; IDs computed at runtime with from_name / from_iter are fine.
  • 0.19: morph targets live in Mesh. GltfAssetLabel::MorphTarget is gone; MeshMorphWeights can reference an entity with MorphWeights instead of being auto-copied. See references/gltf-import.md.
  • 0.20: observers lost the bundle generic. On<E> is unchanged for AnimationEvents. Lifecycle observers on bone entities are On<Add<AnimatedBy>>, not On<Add, AnimatedBy>.
  • 0.17 → 0.18 split. AnimationTarget { id, player } no longer exists. It's two components on each bone entity: AnimationTargetId(Uuid) + AnimatedBy(Entity). The glTF loader spawns these for you.
  • gltf_animation is on by default. No opt-in needed unless you ran default-features = false.
  • AnimationTransitions::play_with_transition does NOT exist. The only method is play(&mut self, player, node, Duration) -> &mut ActiveAnimation. Chain .set_repeat(RepeatAnimation::Forever) / .set_speed(f32) on the returned value.
  • animated_field! and AnimatableCurve are not in the prelude. Import from bevy::animation::{animated_field, animation_curves::{AnimatableCurve, AnimatableKeyframeCurve}}.
  • On<AnimationEvent> is not an EntityEvent observer. On<E> derefs to &E. The firing entity is trigger.trigger().target (AnimationEventTrigger::target). .target() / .entity are not available.
  • Name is required on bone entities for AnimationTargetId::from_name(&Name) to resolve. The glTF loader sets this; hand-built skeletons must too. Since 0.20 Name::new from &str needs 'static; use String for runtime names.
  • AnimationMask bit polarity. A set bit means that node will not animate targets in that group. Register a bone via graph.add_target_to_mask_group(target_id, group_u32). To restrict a node to one group, set every bit except that group's.
  • Schedule. Animation systems run in PostUpdate inside the AnimationSystems set (a unit set in 0.20), before TransformSystems::Propagate. Procedural systems that also write Transform should run in Update or order explicitly against AnimationSystems.
  • Out of scope in 0.20 core animation. No built-in IK, no KHR_animation_pointer (still unsupported by bevy_gltf 0.20.1), particles are separate — see references/gltf-import.md.

See also

  • bevy-migration-0-19-to-0-20 — the bevy_curve split and observer generic change in full.
  • bevy-cameras — camera animation (panning, dolly, focus follow) uses the same EaseFunction / EasingCurve toolkit.
  • bevy-core-concepts — Update vs FixedUpdate choice for procedural animation; see procedural-animation.md.
  • bevy-ecs-systems — observer wiring patterns (On<E>, add_observer) used for AnimationEvents.
  • bevy-pbr-materials — material-parameter animation via AnimatableCurve targeting StandardMaterial fields.
  • bevy-custom-assets — AssetLoader patterns if you serialise AnimationGraph to RON and load it as an asset.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.