Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Multirious committed Jul 5, 2024
1 parent 870f786 commit 028a4c7
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,17 @@

# `bevy_tween`

An ECS-based [Bevy](https://github.com/bevyengine/bevy) procedural and asset animation library.
[Bevy](https://github.com/bevyengine/bevy) procedural and keyframe animation library.

This is a young plugin and APIs are to be fleshed out.
Breaking changes are to be expected!

See changelog [here](CHANGELOG.md).

## Features
- **Ergonomic and user-friendly API**: API are designed to be concise, expressive, and simple to use.
Animation can be built using the combinator framework.
- **Ergonomic and user-friendly API**: You can always spawn the animator manually but this crate provide
APIs that abstracted over the boilerplate process.
Animation can be built using the builder with function combinators.
<details>
<summary>Example</summary>

Expand Down Expand Up @@ -48,16 +49,17 @@ See changelog [here](CHANGELOG.md).
```

</details>
- **Flexible and Extensible**: Everything is components and systems with a sprinkle of dependency injection.
- **Flexible and Extensible**: This crate is built on top of [`bevy_time_runner`](https://github.com/Multirious/bevy_time_runner)
which mean we can extend this crate by adding *any* components and systems.
- Tween anything from anywhere, built-in or custom system.
- Interpolate with any curve, built-in or custom system.
- *Literally anything* as long as they're time controlled.
- Anything else.

- **Parallelism**: Since a tween or an animation primitive is one component and one system,
they have great chances for system parallelism and increase in performance.
- **Parallelism**: Tweens are typed and can be query over by their typed system
which increase chances for system parallelism.
- **Rich timer control**:
- Looping
- Fastforward or Rewind
- Time scaling
- Skip backward or forward
- Jumping to anywhen

Expand Down

0 comments on commit 028a4c7

Please sign in to comment.