Skip to content

Commit f8ccd4e

Browse files
committed
README.md: Add documentation of cargo features
1 parent d00efed commit f8ccd4e

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ Implementations of character controllers that take common input events and map t
44

55
This design is intended to allow use of these controller systems with whichever physics or camera setup you like. For example, you may use a kinematic rigid body in your physics engine and set its position based on the translation events, or a dynamic rigid body and apply the impulses or forces.
66

7+
## Features
8+
9+
* `use_rapier` - for `bevy_rapier3d` character controller support
10+
* `use_physx` - for `bevy_prototype_physx` character controller support, using `physx`
11+
712
## Demos
813

914
### First-Person Character Controller
@@ -26,10 +31,10 @@ You can choose between:
2631

2732
Pitch and yaw are handled in the same way for both options.
2833

29-
`cargo run --release --example rapier3d -- DynamicImpulse`
34+
`cargo run --release --features use_rapier --example rapier3d -- DynamicImpulse`
3035
![Third-person Rapier 3D dynamic impulse character controller demo](https://github.com/superdump/bevy_prototype_character_controller/raw/gh-pages/images/20201017%20212543%20-%20Bevy%20Rapier%203D%20Dynamic%20Impulse%20Character%20Controller.gif)
3136

32-
`cargo run --release --example rapier3d -- DynamicForce`
37+
`cargo run --release --features use_rapier --example rapier3d -- DynamicForce`
3338
![Third-person Rapier 3D dynamic force character controller demo](https://github.com/superdump/bevy_prototype_character_controller/raw/gh-pages/images/20201017%20213044%20-%20Bevy%20Rapier%203D%20Dynamic%20Force%20Character%20Controller.gif)
3439

3540
### PhysX Third-Person Character Controller
@@ -41,13 +46,13 @@ You can choose between:
4146

4247
Pitch and yaw are handled in the same way for both options.
4348

44-
`cargo run --release --example physx -- KinematicTranslation`
49+
`cargo run --release --features use_physx --example physx -- KinematicTranslation`
4550
![Third-person PhysX kinematic translation character controller demo](https://github.com/superdump/bevy_prototype_character_controller/raw/gh-pages/images/20201017%20224653%20-%20Bevy%20PhysX%20Kinematic%20Translation%20Character%20Controller.gif)
4651

47-
`cargo run --release --example physx -- DynamicImpulse`
52+
`cargo run --release --features use_physx --example physx -- DynamicImpulse`
4853
![Third-person PhysX dynamic impulse character controller demo](https://github.com/superdump/bevy_prototype_character_controller/raw/gh-pages/images/20201017%20224853%20-%20Bevy%20PhysX%20Dynamic%20Impulse%20Character%20Controller.gif)
4954

50-
`cargo run --release --example physx -- DynamicForce`
55+
`cargo run --release --features use_physx --example physx -- DynamicForce`
5156
![Third-person PhysX dynamic force character controller demo](https://github.com/superdump/bevy_prototype_character_controller/raw/gh-pages/images/20201017%20225103%20Bevy%20PhysX%20Dynamic%20Force%20Character%20Controller.gif)
5257

5358
## How-To

0 commit comments

Comments
 (0)