Benimator

A sprite sheet animation plugin for bevy

Features

• A SpriteSheetAnimation component to automatically update the indices of the TextureAtlasSprite in the same entity
• Animation modes: Repeat or Once
• An animation is playing if, and only if, a Play component is present in the entity
  • Simply remove/insert the Play component to pause/resume an animation
• The animation can be defined from an index-range, or an arbitrary list of indices
• Each frame may have a different duration

Usage

```rust fn main() { App::build() .addplugins(DefaultPlugins) .addplugin(AnimationPlugin) // <-- Add the plugin .addstartupsystem(spawn.system()) .run(); }

fn spawn( mut commands: Commands, assetserver: Res, mut textures: ResMut>, mut animations: ResMut>, ) { // Don't forget the camera ;-) commands.spawnbundle(OrthographicCameraBundle::new_2d());

// Create an animation // Here we use an index-range (from 0 to 4) where each frame has the same duration let animationhandle = animations.add(SpriteSheetAnimation::fromrange( 0..=4, Duration::from_millis(100), ));

commands // Spawn a bevy sprite-sheet .spawnbundle(SpriteSheetBundle { textureatlas: textures.add(TextureAtlas::fromgrid(assetserver.load("coin.png"), Vec2::new(16.0, 16.0), 5, 1)), transform: Transform::fromscale(Vec3::splat(10.0)), ..Default::default() }) // Insert the asset handle of the animation .insert(animationhandle) // Start the animation immediately. Remove this component in order to pause the animation. .insert(Play); } ```

Here is the result:

(Asset by La Red Games - CC0)

For more details see the documentation

Installation

Add to Cargo.toml:

toml benimator = "0.3.1"

Cargo features

• warnings (enabled by default). Log warnings in case of incorrect usage detected.

Bevy Version Compatibility

| bevy | benimator | |------|------------| | 0.5 | >= 0.1 |

Contribute / Contact

Issues, pull requests are welcome.

It is possible to directly discuss with me (Jomag#2675) via the bevy discord

License

Licensed under either of

• The Unlicense (UNLICENSE or https://opensource.org/licenses/Unlicense)
• MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.