add install instructions

This commit is contained in:
Lee-Orr
2024-02-12 16:22:27 -05:00
parent 84f4e79cf4
commit 4737804ab3
4 changed files with 18 additions and 13 deletions
+15
View File
@@ -2,6 +2,20 @@
This is a project build for storyteller.ai, to provide support for importing ARKit data into bevy, and using it to drive shape keys.
## Install
Add this to your dependencies alongside bevy:
```toml
bevy = "0.12"
bevy-facial-mocap = { git = "https://github.com/caladluin/bevy-facial-mocap" } #TODO - once ownership of the repo transfers, set this to the correct repository
```
If you add the `file_watcher` feature to bevy, this also supports hot reloading:
```toml
bevy = { version = "0.12", default-features = true, features = ["file_watcher"]}
```
## Use
Import the asset loader:
@@ -19,6 +33,7 @@ let mut player = AnimationPlayer::default();
player.play(handle.clone()).repeat();
```
## Asset Preparation
To load a recording, you need 3 files: