diff --git a/Cargo.toml b/Cargo.toml index b1bdad5a8964cdba4a2c79031cd2bfe0df1891fa..c264aea6ac836e8080e68c83667d9cc02d11981c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "micro_banimate" -version = "0.10.0" +version = "0.11.0" edition = "2021" license = "Apache-2.0" description = "Easily manage complex Bevy 2D sprite animations" diff --git a/README.md b/README.md index 88120d5c65ebb9db0776092f831a1b01b2684f31..2b2d59542d9dc00f165b7989e50fdc5abc0444db 100644 --- a/README.md +++ b/README.md @@ -14,26 +14,21 @@ Easily manage complex 2D sprite animations ### Simple Animations -TODO: Describe simple animations - -- A simple looping animation with a single set of frames and frame rate, no control needed or provided +- A single list of frames to loop through based on a set framerate. Ideal for low-overhead animation of simple entities like a flickering lamp sprite ### Sprite Animations -TODO: Describe sprite animations - -- Sets the name of the animation to play, play the animation. Simple. +- Associate one or more named animations with a sprite-having entity +- Easily switch between looping and one-off animations by name - Interrupt the current animation temporarily with an `AnimationOverride` ### Directional Animations -TODO: Describe directional animations - -- Includes a component for altering the name of a playing animation based on its value, representing direction +- Everything that a Sprite Animation does, but will automatically change between named animations based on the value of the associated `Directionality` component ### Child Animations -Adding a `ChildAnimation` to an entity with a Sprite and an animated parent will cause its status to by synced to it's `Parent` entity +- Given an entity with a `Sprite` and a `ChildOf` relation, set the atlas index of the sprite based on the parent value ## Animation Sets @@ -98,6 +93,7 @@ frame_time = 100 | banimate version | bevy version | tilemap version | |---------------------|--------------|------------------------------------------| +| 0.11.0 | 0.16 | n/a | | 0.10.0 | 0.15 | n/a | | 0.9.x | 0.14 | n/a | | 0.8.0 | 0.13 | n/a |