Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lommix/bevy_aseprite_ultra
The ultimate bevy aseprite plugin. Featuring animations and static atlas loading with pivots. Full support for hot reloading!
https://github.com/lommix/bevy_aseprite_ultra
animation aseprite asset atlas bevy hotreload loader
Last synced: 6 days ago
JSON representation
The ultimate bevy aseprite plugin. Featuring animations and static atlas loading with pivots. Full support for hot reloading!
- Host: GitHub
- URL: https://github.com/lommix/bevy_aseprite_ultra
- Owner: Lommix
- License: mit
- Created: 2024-01-31T10:08:55.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-07-26T08:48:44.000Z (6 months ago)
- Last Synced: 2024-07-28T15:13:40.562Z (5 months ago)
- Topics: animation, aseprite, asset, atlas, bevy, hotreload, loader
- Language: Rust
- Homepage:
- Size: 2.45 MB
- Stars: 24
- Watchers: 4
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Bevy Aseprite Ultra
[](./LICENSE)
[](https://crates.io/crates/bevy_aseprite_ultra)
The ultimate bevy aseprite plugin. This plugin allows you to import aseprite files into bevy, with 100% unbreakable
hot reloading. You can also import static sprites from an aseprite atlas type file using slices with functional pivot offsets!
| Bevy Version | Plugin Version |
| -----------: | -------------: |
| 0.15 | 0.4.1 |
| 0.14 | 0.2.4 |
| 0.13 | 0.1.0 |
## Supported aseprite features
- Animations
- Tags
- Frame duration, repeat, and animation direction
- Layer visibility
- Blend modes
- Static slices and pivot offsets
## Features in bevy
- Hot reload anything, anytime, anywhere!
- Full control over animations using Components.
- One shot animations and events when they finish.
- Static sprites with slices. Use aseprite for all your icon and UI needs!
(hot reloading requires the `file_watcher` feature in bevy)
## Embedding Assets
There is currently no asset preprocessor. If you do not want to ship raw aseprite files, use [`bevy_embedded_assets`](https://github.com/vleue/bevy_embedded_assets)
to embed your assets into the final binary.
## Example
```bash
cargo run --example slices
cargo run --example animations
cargo run --example ui
```
character animation by [Benjamin](https://github.com/headcr4sh)
---
```rust
use bevy::prelude::*;
use bevy_aseprite_ultra::prelude::*;
...
// Load an animation from an aseprite file
fn spawn_demo_animation(mut cmd : Commands, server : Res){
cmd.spawn((
AseSpriteAnimation {
aseprite: server.load("player.aseprite"),
animation: Animation::tag("walk-right")
.with_repeat(AnimationRepeat::Count(1))
.with_speed(2.)
// Aseprite provides a repeat config per tag, which is beeing ignored on purpose.
.with_repeat(AnimationRepeat::Count(42))
// The direction is provided by the asperite config for the tag, but can be overwritten.
.with_direction(AnimationDirection::PingPong)
// you can also chain finite animations, loop animations will never finish
.with_then("walk-left", AnimationRepeat::Count(4))
.with_then("walk-up", AnimationRepeat::Loop),
},
Sprite {
// under the hood its just sprites.
// only the image and atlas is touched.
// this works
flip_x: true,
..default()
},
));
}
// Load a static slice from an aseprite file
// create for any static atlas with marked regions aka slices.
fn spawn_demo_static_slice(mut cmd : Commands, server : Res){
cmd.spawn((
AseSpriteSlice {
name: "ghost_red".into(),
aseprite: server.load("ball.aseprite"),
},
));
}
// animation events
// this is useful for one shot animations like explosions
fn despawn_on_finish(mut events: EventReader, mut cmd : Commands){
for event in events.read() {
match event {
AnimationEvents::Finished(entity) => cmd.entity(*entity).despawn_recursive(),
// you can also listen for loop cycle repeats
AnimationEvents::LoopCycleFinished(_entity) => (),
};
}
}
```
## Bevy Ui
There is also an Ui Bundle for Bevy Ui Nodes!
```rust
// animations in bevy ui
cmd.spawn((
Button,
AseUiAnimation {
aseprite: server.load("player.aseprite"),
animation: Animation::tag("walk-right"),
},
));
// slices in bevy ui
cmd.spawn((
Node {
width: Val::Px(100.),
height: Val::Px(100.),
border: UiRect::all(Val::Px(5.)),
..default()
},
AseUiSlice {
name: "ghost_red".into(),
aseprite: server.load("ghost_slices.aseprite"),
},
));
```