WIP

Author: merwaaan

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 5.0.0 - 2025-??-??
+
+### Changed
+
+- ???
+
 ## 4.0.0 - 2025-10-09
 
 ### Added

README.md

@@ -48,7 +48,7 @@ fn setup(
     mut atlas_layouts: ResMut<Assets<TextureAtlasLayout>>,
     assets: Res<AssetServer>,
 ) {
-    // Create a clip
+    // Create a clip from a row of an 8x8 spritesheet
 
     let spritesheet = Spritesheet::new(8, 8);
 
@@ -82,7 +82,7 @@ fn setup(
         Sprite::from_atlas_image(image, atlas),
 
         // Add a SpritesheetAnimation component that references our newly created animation
-        SpritesheetAnimation::from_id(animation_id),
+        SpritesheetAnimation::new(animation_handle),
     ));
 
     commands.spawn(Camera2d);
@@ -156,7 +156,7 @@ fn create_animation(mut commands: Commands, mut library: ResMut<AnimationLibrary
 
     commands.spawn((
         Sprite::from_atlas_image(image, atlas),
-        SpritesheetAnimation::from_id(animation_id),
+        SpritesheetAnimation::new(animation_handle),
     ));
 }
 ```
@@ -184,7 +184,7 @@ fn spawn_characters(mut commands: Commands, mut library: ResMut<AnimationLibrary
 
         commands.spawn((
             Sprite::from_atlas_image(/* .... */),
-            SpritesheetAnimation::from_id(animation_id),
+            SpritesheetAnimation::new(animation_handle),
         ));
     }
 }
@@ -229,7 +229,7 @@ fn spawn_enemies(mut commands: Commands, library: Res<AnimationLibrary>) {
         for _ in 0..100 {
             commands.spawn((
                 Sprite::from_atlas_image(/* .... */),
-                SpritesheetAnimation::from_id(animation_id),
+                SpritesheetAnimation::new(animation_handle),
             ));
         }
     }
@@ -256,7 +256,7 @@ fn spawn_character(mut commands: Commands, mut library: ResMut<AnimationLibrary>
             .with_atlas(atlas_layout)
             .with_anchor(Anchor::BottomRight)
             .build(),
-        SpritesheetAnimation::from_id(animation_id),
+        SpritesheetAnimation::new(animation_handle),
     ));
 }
 ```
@@ -282,7 +282,7 @@ fn create_animated_cursor(
             texture_atlas: Some(atlas),
             ..default()
         })),
-        SpritesheetAnimation::from_id(animation_id),
+        SpritesheetAnimation::new(animation_handle),
     ));
 }
 ```

examples/3d.rs

@@ -20,8 +20,8 @@ fn main() {
 
 fn spawn_sprites(
     mut commands: Commands,
-    mut library: ResMut<AnimationLibrary>,
     mut atlas_layouts: ResMut<Assets<TextureAtlasLayout>>,
+    mut animations: ResMut<Assets<Animation>>,
     assets: Res<AssetServer>,
 ) {
     // 3D sprites require a 3D camera
@@ -37,11 +37,9 @@ fn spawn_sprites(
 
     let clip = Clip::from_frames(spritesheet.row(3));
 
-    let clip_id = library.register_clip(clip);
+    let animation = Animation::from_clip(clip);
 
-    let animation = Animation::from_clip(clip_id);
-
-    let animation_id = library.register_animation(animation);
+    let animation_handle = animations.add(animation);
 
     // Create an image and a texture atlas like you would for any Bevy sprite
 
@@ -79,7 +77,7 @@ fn spawn_sprites(
     for (i, sprite) in sprites.into_iter().enumerate() {
         commands.spawn((
             sprite,
-            SpritesheetAnimation::from_id(animation_id),
+            SpritesheetAnimation::new(animation_handle.clone()),
             Orbit {
                 start_angle: i as f32 * std::f32::consts::TAU / sprite_count as f32,
             },

examples/basic.rs

@@ -10,7 +10,7 @@ fn main() {
     App::new()
         .add_plugins(DefaultPlugins)
         // Add the plugin to enable animations.
-        // This makes the AnimationLibrary resource available to your systems.
+        // This makes the Assets<Animation> resource available to your systems.
         .add_plugins(SpritesheetAnimationPlugin)
         .add_systems(
             Startup,
@@ -19,7 +19,12 @@ fn main() {
         .run();
 }
 
-fn create_animation(mut commands: Commands, mut library: ResMut<AnimationLibrary>) {
+#[derive(Resource)]
+struct MyAnimation {
+    handle: Handle<Animation>,
+}
+
+fn create_animation(mut commands: Commands, mut animations: ResMut<Assets<Animation>>) {
     commands.spawn(Camera2d);
 
     // Create a clip that references some frames from a spritesheet
@@ -28,49 +33,52 @@ fn create_animation(mut commands: Commands, mut library: ResMut<AnimationLibrary
 
     let clip = Clip::from_frames(spritesheet.row(3));
 
-    let clip_id = library.register_clip(clip);
-
     // Create an animation that uses the clip
+    //
+    // This is a simple animation with a single clip but we can create more sophisticated
+    // animations with multiple clips, each one having different parameters.
+    //
+    // See the `composition` example for more details.
 
-    let animation = Animation::from_clip(clip_id);
-
-    let animation_id = library.register_animation(animation);
+    let animation = Animation::from_clip(clip);
 
     // Name the animation to retrieve it from other systems
 
-    library.name_animation(animation_id, "walk").unwrap();
+    let animation_handle = animations.add(animation);
 
-    // This is a simple animation with a single clip but we can create more sophisticated
-    // animations with multiple clips, each one having different parameters.
-    //
-    // See the `composition` example for more details.
+    commands.insert_resource(MyAnimation {
+        handle: animation_handle,
+    });
 }
 
 // We split the setup in two separate systems to show how to retrieve animations from their name
 
 fn spawn_sprite(
     mut commands: Commands,
-    library: Res<AnimationLibrary>,
-    mut atlas_layouts: ResMut<Assets<TextureAtlasLayout>>,
     assets: Res<AssetServer>,
+    mut atlas_layouts: ResMut<Assets<TextureAtlasLayout>>,
+    my_animation: Res<MyAnimation>,
 ) {
     // Retrieve our animation from the library
 
-    if let Some(animation_id) = library.animation_with_name("walk") {
-        // Create an image and a texture atlas like you would for any Bevy sprite
+    // Create an image and a texture atlas like you would for any Bevy sprite
+    //
+    // However, here we use the Spritesheet helper to easily generate the atlas.
+    // This is optional and you may prefer to build the atlas manually.
+
+    let image = assets.load("character.png");
 
-        let image = assets.load("character.png");
+    let spritesheet = Spritesheet::new(8, 8);
 
-        let atlas = TextureAtlas {
-            layout: atlas_layouts.add(Spritesheet::new(8, 8).atlas_layout(96, 96)),
-            ..default()
-        };
+    let atlas = TextureAtlas {
+        layout: atlas_layouts.add(spritesheet.atlas_layout(96, 96)),
+        ..default()
+    };
 
-        // Spawn a sprite with a SpritesheetAnimation component that references our animation
+    // Spawn a sprite with a SpritesheetAnimation component that references our animation
 
-        commands.spawn((
-            Sprite::from_atlas_image(image, atlas),
-            SpritesheetAnimation::from_id(animation_id),
-        ));
-    }
+    commands.spawn((
+        Sprite::from_atlas_image(image, atlas),
+        SpritesheetAnimation::new(my_animation.handle.clone()),
+    ));
 }