add readme

This commit is contained in:
Bram Buurlage 2022-09-18 12:44:08 +02:00
parent ea5ddbf099
commit f7191c1b32
2 changed files with 38 additions and 0 deletions

38
README.MD Normal file
View File

@ -0,0 +1,38 @@
# Inverse kinematics for Bevy
[![crates.io](https://img.shields.io/crates/v/bevy_mod_inverse_kinematics)](https://crates.io/crates/bevy_mod_inverse_kinematics)
[![docs.rs](https://docs.rs/bevy_mod_inverse_kinematics/badge.svg)](https://docs.rs/bevy_mod_inverse_kinematics)
![demo](https://github.com/Kurble/bevy_mod_inverse_kinematics/blob/master/demo.gif)
A [Bevy](https://github.com/bevyengine/bevy) plugin for inverse kinematics. Supports positional and pole targets.
## Bevy Version Support
I intend to track the latest releases of Bevy.
| bevy | bevy_mod_inverse_kinematics |
| ----- | --------------------------- |
| 0.8.1 | 0.1 |
## Examples
Have the right arm of a skinned mesh follow the mouse cursor:
```shell
cargo run --example skin_mesh
```
Turn on the debug_lines feature to see how the bone rotations are calculated:
```shell
cargo run --example skin_mesh --features debug_lines
```
## Licensing
This project is dual-licensed under either
- MIT License: Available [online](http://opensource.org/licenses/MIT)
- Apache License, Version 2.0: Available [online](http://www.apache.org/licenses/LICENSE-2.0)
at your option.

BIN
demo.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 160 KiB