crate description + readme + license

fyrox-animation/Cargo.toml

@@ -1,7 +1,19 @@
 [package]
 name = "fyrox-animation"
 version = "0.1.0"
+authors = ["Dmitry Stepanov <[email protected]>"]
 edition = "2021"
+license = "MIT"
+description = "Flexible Animation System"
+keywords = ["animation", "game"]
+categories = ["game-development", "animation"]
+include = ["/src/**/*", "/Cargo.toml", "/LICENSE", "/README.md"]
+homepage = "https://fyrox.rs"
+documentation = "https://docs.rs/fyrox-animation"
+repository = "https://github.com/FyroxEngine/Fyrox"
+readme = "README.md"
+resolver = "2"
+rust-version = "1.72"
 
 [dependencies]
 fyrox-core = { version = "0.26.0", path = "../fyrox-core" }

fyrox-animation/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019-2024 Dmitry Stepanov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fyrox-animation/README.md

@@ -0,0 +1,18 @@
+# fyrox-animation
+
+Flexible, general-purpose, reflection-based animation system for game development.
+
+**NOTE:** even though this crate has `fyrox` prefix in its name, it can be used separately without any issues.
+
+## Features
+
+- Reflection-based animation.
+- Animation blending state machine.
+- Sprite sheet animation.
+- Various blending modes - blend by weight, blend by index, blend space.
+- Smooth state transition.
+- Ability to animate any numeric property, including vectors, bools, natural and real numbers.
+- Layer masks.
+- Root motion.
+- Fixed set of binding modes for most common cases.
+- Signals and events.