This library provides a simple, lightweight way of having a "flycam" style camera for debugging. It's confirgurable, letting you easily enable the system locally for a camera or globally for all cameras with a component and resource.
| Bevy Version | bevy-debug-camera version | |--------------|---------------------------| | 0.9.1 | ^0.1.0 | | ^0.10.0 | ^0.2.0 |
You can look at the examples folder for practical uses of this crate, but to get started you can simply do the following when setting up your app:
```rust use bevy::prelude::*; use bevydebugcamera::{DebugCamera, DebugCameraPlugin};
fn main() { App::new() .addplugins(DefaultPlugins) .addplugin(DebugCameraPlugin::default()) .addstartupsystem(setup) .run(); }
fn setup(mut commands: Commands) { // ... other setup code commands .spawn(Camera3dBundle::default()) .insert(DebugCamera { position: Vec3::new(-5., 1., 0.), ..default() }); } ```
The default bindings are as follows:
| Action | Binding |
|---------------|----------|
| Move forward | W |
| Move backward | S |
| Move left | A |
| Move right | D |
| Move up | Lshift |
| Move down | Space |
| Yaw | Mouse X |
| pitch | Mouse Y |
| Roll left | Q |
| Roll right | E |
| Action | Binding |
|-----------------|------------|
| Move fwd/bwd | Lstick Y |
| Move left/right | Lstick X |
| Move up | RTrigger |
| Move down | LTrigger |
| Yaw | Rstick X |
| pitch | Lstick Y |
| Roll left | LBumper |
| Roll right | RBumper |
The plugin comes with some configuration options you can set on startup that use to customise behaviour of the cameras in use. You can configure:
All these customisation are exposed as resources, which are constantly read and can be modified
during runtime as well An example using all configuration options can be seen below and in the
configuration example:
```rust use bevy::prelude::*; use bevydebugcamera::{ DebugCamera, DebugCameraPlugin, GamepadBindings, KeyboardBindings, DebugCameraActive, };
fn main() {
App::new()
.addplugins(DefaultPlugins)
// Each field in DebugCameraPlugin can be set directly or picked up from
// default.
.addplugin(DebugCameraPlugin {
gamepadbindings: GamepadBindings {
// Overrides only the roll buttons
rollleft: GamepadButtonType::West,
rollright: GamepadButtonType::East,
..default()
},
keyboardbindings: KeyboardBindings {
// Override WASD with arrows
fwd: KeyCode::Up,
bwd: KeyCode::Down,
left: KeyCode::Left,
right: KeyCode::Right,
..default()
},
debugcameraactive: DebugCameraActive {
// Disable keyboard + mouse only
keymouse: false,
..default()
},
})
.addstartupsystem(setup)
.run();
}
fn setup() { // Setup logic here... } ```