# Changelog
## 5.0.0 - 2025-11-04
This release comes with a significant rework of the high-level API that tightens up the relationships between spritesheets, clips and animations.
It also removes the `AnimationLibrary` resource in favor of registering animations in `Assets<Animation>` like other Bevy assets.
As a consequence of the `AnimationLibrary` removal, it's no longer possible to name clips, animations or markers to retrieve them by name across systems.
An alternative (and safer!) way to retrieve animation data is to save it in custom resources, as demonstrated in the examples (eg. `examples/character.rs`, `examples/events.rs`).
If you still prefer to use names, you can update your code by replacing the removed `AnimationLibrary` with a custom resource that wraps some name-based lookup, such as:
```rust
#[derive(Resource)]
struct MyAnimations(HashMap<String, Handle<Animation>>);
```
Migrating to this new version should be pretty straightforward. Please check out the updated examples and documentation!
### Added
- `Spritesheet` can now create animation-ready sprites, 3D sprites, UI images, cursors and texture atlases to reduce boilerplate when creating animated entities
- Add an example showcasing animated UI images
### Changed
- Animations are now exclusively created with `Spritesheet::create_animation()` which returns an `AnimationBuilder`
- Clips are now exclusively created with `AnimationBuilder::start_clip()`/`AnimationBuilder::copy_clip()`
- Rename `AnimationMarkerId` to `Marker`
### Removed
- Remove the `AnimationLibrary` resource (you can now register animations in `Assets<Animation>`)
### Fixed
- Fix a few panics when selecting out-of-bounds cells in spritesheets
## 4.0.1 - 2025-10-09
No actual changes. Had to bump the version to republish the crate and fix docs.rs failing to build the documentation.
## 4.0.0 - 2025-10-09
### Added
- Add support for Bevy 0.17
- Add an example showcasing animated cursors
### Changed
- Remove the `3d` feature, 3D sprites are now available by default
- Add the `custom_cursor` feature to the defaults
## 3.2.0 - 2025-09-20
### Fixed
- Fix 3D sprites not casting shadows from both sides (by luisbg)
## 3.1.0 - 2025-08-18
### Changed
- Replace the `enable_3D` option of `SpritesheetAnimationPlugin` with the `3d` cargo feature (by mirsella)
- Bump the Rust edition from 2021 to 2024
### Fixed
- Fix CursorIcon::Custom usage (by mirsella)
- Fix SpritesheetAnimation::reset not restarting animation (by mirsella)
## 3.0.0 - 2025-05-11
### Added
- Add support for Bevy 0.16.0 (by mgi388)
- Add support for animated cursor icons (by mgi388)
### Fixed
- Fix wrong IDs being returned for new clips and animations after deregistering some (by mgi388)
## 2.1.0 - 2025-03-14
### Added
- Add `deregister_clip()` and `deregister_animation()` to `AnimationLibrary` (by mgi388).
- Add an `unlit` property to `Sprite3d` (by Microwonk).
- Add support for ImageNode (by mgi388).
### Fixed
- Fix the lighting of 3D sprites (by Microwonk).
- Fix `SpritesheetAnimation` and `Sprite3d` not being registered (by mgi388).
## 2.0.0 - 2024-12-14
### Added
- Add support for Bevy 0.15
### Removed
- Remove `Sprite3dBundle` and `Sprite3dBundle`.
Thanks to required components, simply adding a `Sprite3d` component will just work.
## 1.0.0 - 2024-11-20
### Added
- Add `get_clip_name()`, `get_animation_name()` and `get_marker_name()` to `AnimationLibrary` (by mirsella)
- Add an `enable_3d` option to `SpritesheetAnimationPlugin` (by mirsella).
This is especially useful to use this plugin in a headless app without bevy_render.
Due to this new field, it is now necessary to use `SpritesheetAnimationPlugin::default()` when configuring the app.
### Fixed
- Fix some timing bugs due to the internal use of u32 instead of std::time::Duration
## 0.4.3 - 2024-11-11
### Added
- Add `clip_names()`, `animation_names()` and `marker_names()` methods to the library
### Changed
- Add reflection to types and registered resources (by mgi388)
- Make system sets public (by mgi388)
## 0.4.2 - 2024-09-02
### Changed
- Optimize playback for 3D sprites (~x3 speedup)
## 0.4.1 - 2024-08-30
### Added
- Add a `progress` field to the SpritesheetAnimation component to query and control the animation state
- Add a `switch()` method to SpritesheetAnimation component to switch to another animation and reset the progress
- Add `get_clip()` and `get_animation()` methods to the library
- Attach more information to some animation events (current clip ID, current clip repetition, current animation repetition)
### Changed
- Change the type for repetitions from `u32` to `usize` for consistency
## 0.4.0 - 2024-08-28
This update simplifies the high-level API of the library.
A few structs have been renamed for clarity and consistency.
More importantly, creating animations is more straightforward.
You can now directly instantiate clips and animations, configure them and register them with the library, which gives them unique IDs.
The animation stages that acted like "clip instances" have been removed.
To create a variant of a clip, just clone and reconfigure it before registering the variant.
### Added
- Add `with_xxx()` methods to `Clip` and `Animation` to make it easier to set their parameters
- Add `Spritesheet::atlas_layout()` to create a `TextureAtlasLayout` from a spritesheet
### Changed
- `Clip` and `Animation` can be instantiated directly and must then be registered with the library
- Rename `AnimationClip` to `Clip`
- Rename `SpritesheetLibrary` to `AnimationLibrary`
- Rename "cycles" to "repetitions"
- Rename `AnimationRepeat::Cycles` to `AnimationRepeat::Times`
- Rename `AnimationDuration::PerCycle` to `AnimationDuration::PerRepetition`
- Rename structs related to 3D sprites with lowercase "3d" to better match Bevy
### Removed
- Remove `AnimationStage`
## 0.3.0 - 2024-08-26
### Added
- Add support for 3D sprites
## 0.2.0 - 2024-07-06
### Added
- Add support Bevy 0.14.0 (by BLumbye)
- Add a `reset()` method to the SpritesheetAnimation component
### Fixed
- Switch `new_clip`/`new_animation` closures to FnMut to allow mutations
## 0.1.0 - 2024-04-10
### Fixed
- Fix some direction combinations emitting events on the wrong frames
## 0.1.0-beta.1 - 2024-04-08
### Fixed
- Fix `AnimationLibrary::name_clip`/`animation`/`marker` returning an error when naming an item with a name it already has
- Fix `MarketHit` events reporting an incorrect stage index when an animation has empty clips
- Fix `Easing::Out` with the `Cubic` and `Quartic` modes generating incorrect values
## 0.1.0-beta.0 - 2024-04-07
Initial release