Merge pull request #59 from FelixEngl/main

Make `Animation` serializable via optional `serde` feature

Author: merwaaan

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 5.1.0 - 2026-01-04
+
+### Added
+
+- Added feature-flag `serde`.
+- Added serde support to `Animation` struct.
+
 ## 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.

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bevy_spritesheet_animation"
-version = "5.0.0"
+version = "5.1.0"
 description = "A Bevy plugin for animating sprites"
 repository = "https://github.com/merwaaan/bevy_spritesheet_animation"
 readme = "README.md"
@@ -20,17 +20,21 @@ default = [
 ]
 custom_cursor = ["bevy/custom_cursor"]
 
+# Allows to serialize the animations
+serde = ["dep:serde"]
+
 [dependencies]
 bevy = { version = "0.17.0", default-features = false, features = [
   "bevy_log",
   "bevy_sprite",
   "bevy_pbr",
   "bevy_ui"
 ] }
+serde = { version = "1.0.228", optional = true }
 
 [dev-dependencies]
 approx = "0.5.1"
-bevy = { version = "0.17.0", features = [
+bevy = { version = "0.17", features = [
   # Needed for the "stress" example  as it uses Bevy's FPS overlay
   "bevy_dev_tools"
 ] }

README.md

@@ -379,13 +379,14 @@ For more examples, browse the [examples/](examples) directory.
 
 # Compatibility
 
-| bevy | bevy_spritesheet_animation |
-| ---- | -------------------------- |
-| 0.17 | 4.0.0                      |
-| 0.16 | 3.0.0                      |
-| 0.15 | 2.0.0                      |
-| 0.14 | 0.2.0                      |
-| 0.13 | 0.1.0                      |
+| bevy   | bevy_spritesheet_animation |
+|--------|----------------------------|
+| 0.17   | 5.0.0                      |
+| 0.17   | 4.0.0                      |
+| 0.16   | 3.0.0                      |
+| 0.15   | 2.0.0                      |
+| 0.14   | 0.2.0                      |
+| 0.13   | 0.1.0                      |
 
 # Credits
 

src/animation.rs

@@ -1,9 +1,12 @@
 use bevy::prelude::*;
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Serialize};
 
 use crate::{clip::Clip, easing::Easing};
 
 /// The duration of an [Animation].
 #[derive(Debug, Clone, Copy, Reflect)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[reflect(Debug)]
 pub enum AnimationDuration {
     /// Specifies the duration of one frame in milliseconds (default = `PerFrame(100)`).
@@ -20,6 +23,7 @@ impl Default for AnimationDuration {
 
 /// How many times an [Animation] repeats.
 #[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Hash, Reflect)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[reflect(Debug, PartialEq, Hash)]
 pub enum AnimationRepeat {
     /// Loops forever (default).
@@ -31,6 +35,7 @@ pub enum AnimationRepeat {
 
 /// The direction in which the frames of an [Animation] are played.
 #[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Hash, Reflect)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[reflect(Debug, PartialEq, Hash)]
 pub enum AnimationDirection {
     /// Frames play from left to right (default).
@@ -84,6 +89,7 @@ pub enum AnimationDirection {
 /// # }
 /// ```
 #[derive(Asset, Debug, Clone, Reflect)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[reflect(Debug)]
 pub struct Animation {
     pub(crate) clips: Vec<Clip>,

src/clip.rs

@@ -1,22 +1,24 @@
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Serialize};
 use std::{
     fmt,
     sync::atomic::{AtomicUsize, Ordering},
 };
 
-use bevy::{platform::collections::HashMap, prelude::*};
-
 use crate::{
     animation::{AnimationDirection, AnimationDuration},
     easing::Easing,
     events::Marker,
 };
+use bevy::{platform::collections::HashMap, prelude::*};
 
 /// An opaque identifier for a [Clip]
 ///
 /// Clip-related [AnimationEvents](crate::prelude::AnimationEvent) will contain this ID.
 ///
 /// Wen creating animations, use [AnimationBuilder::get_current_clip_id()](crate::prelude::AnimationBuilder::get_current_clip_id) to retrieve a clip's ID.
 #[derive(Clone, Copy, Eq, PartialEq, Hash, Reflect)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize), serde(transparent))]
 #[reflect(Debug, PartialEq, Hash)]
 pub struct ClipId {
     pub(crate) value: usize,
@@ -68,6 +70,7 @@ impl ClipId {
 ///
 /// See [AnimationEvent](crate::prelude::AnimationEvent) for more details.
 #[derive(Debug, Clone, Reflect)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[reflect(Debug)]
 pub struct Clip {
     id: ClipId,

src/easing.rs

@@ -1,3 +1,5 @@
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Serialize};
 use std::f32::consts::PI;
 
 use bevy::prelude::*;
@@ -9,6 +11,7 @@ use bevy::prelude::*;
 /// - <https://easings.net/>
 /// - <http://robertpenner.com/easing/penner_chapter7_tweening.pdf>
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Reflect)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[reflect(Debug, PartialEq, Hash)]
 pub enum EasingVariety {
     Quadratic,
@@ -41,6 +44,7 @@ pub enum EasingVariety {
 /// # }
 /// ```
 #[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Hash, Reflect)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[reflect(Debug, Default, PartialEq, Hash)]
 pub enum Easing {
     /// Linear interpolation.

src/events.rs

@@ -1,3 +1,5 @@
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Serialize};
 use std::{
     fmt,
     sync::atomic::{AtomicUsize, Ordering},
@@ -157,6 +159,7 @@ pub enum AnimationEvent {
 ///
 /// Add markers to a clip with [AnimationBuilder::add_clip_marker()](crate::prelude::AnimationBuilder::add_clip_marker).
 #[derive(Clone, Copy, Eq, PartialEq, Hash, Reflect)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize), serde(transparent))]
 #[reflect(Debug, PartialEq, Hash)]
 pub struct Marker {
     pub(crate) value: usize,