- Aim
- Zoom in/out
- Orbit
- Custom Offset
- Movement Controls (WASD + sprint)
- Cursor Lock
- Custom Sensitivity
- Full Gamepad Support!
Add the bevy_third_person_camera crate:
cargo add bevy_third_person_camera
Import the bevy_third_person_camera crate:
use bevy_third_person_camera::*;
use bevy_third_person_camera::controller::*; // optional if you want movement controls
use bevy_third_person_camera::camera::*; // optional for additional camera settings
Add the ThirdPersonPlugin:
.add_plugins(ThirdPersonCameraPlugin)
Add the ThirdPersonCamera component to the camera entity:
commands.spawn((
ThirdPersonCamera::default(),
Camera3dBundle::default()
));
Add the ThirdPersonCameraTarget component to your player:
// Player
commands.spawn((
PbrBundle {
mesh: meshes.add(Mesh::from(shape::Cube::new(1.0))),
material: materials.add(Color::BLUE.into()),
transform: Transform::from_xyz(0.0, 0.5, 0.0),
..default()
},
ThirdPersonCameraTarget,
ThirdPersonController::default() // optional if you want movement controls
Player,
));
That's it!
- default
- custom
- controller
cargo run --example <example name>
The offset
will 'offset' the x and y values of the camera respectively. Offset is disabled by default. Turn on with offset_enabled: true
offset_enabled: true,
offset: Offset::new(0.5, 0.25),
offset_toggle_key: Some(KeyCode::T),
offset_toggle_speed: 5.0 // default
Aiming is calculated using the aim_zoom
& the zoom.min
values. Please note that the actual zoom level will vary if you change the zoom.min
value, even if the aim_zoom
value stays the same. Aiming is disabled by default. Turn on with aim_enabled: true
aim_enabled: true, // default
aim_speed: 3.0, // default
aim_zoom: 0.7, // default
aim_button: Some(MouseButton::Right), // default
zoom: Zoom::new(1.5, 3.0)
The ThirdPersonController component adds basic input controls (WASD movements + LShift sprint) to the entity it is attached to. This component must be inserted into the same entity that the 'ThirdPersonCameraTarget' component is attached to.
Usage example:
fn spawn_player(mut commands: Commands) {
commands.spawn((
PbrBundle::default(),
ThirdPersonCameraTarget,
ThirdPersonController::default()
));
}
// default settings
move_left: KeyCode::KeyA,
move_right: KeyCode::KeyD,
move_forward: KeyCode::KeyW,
move_back: KeyCode::KeyS,
sprint_enabled: true,
sprint: KeyCode::ShiftLeft,
sprint_speed: 2.0,
speed: 2.5,
gamepad_settings: ControllerGamepadSettings::default(),
// default gamepad settings
sprint: GamepadButton::new(gamepad, GamepadButtonType::LeftTrigger),
The cursor lock feature allows the mouse cursor to toggle between a locked, hidden state, to an unlocked, visible state. When unlocked, the orbiting feature is disabled, thus allowing the cursor to move freely within the window without disrupting the camera's transform. This feature can be fully disabled by setting the enable_cursor_lock_toggle value to false and will keep the cursor locked and hidden.
cursor_lock_toggle_enabled: true,
cursor_lock_active: true,
cursor_lock_key: KeyCode::Space,
Orbiting is enabled by default. However, you can set the mouse_orbit_button_enabled
setting to true
and the orbiting will only be active while the mouse_orbit_button
is pressed.
Most settings can be overridden:
let gamepad = Gamepad::new(0);
commands.spawn((
// These are the default settings
ThirdPersonCamera {
aim_enabled: false,
aim_button: Some(MouseButton::Right),
aim_speed: 3.0,
aim_zoom: 0.7,
cursor_lock_toggle_enabled: true,
cursor_lock_active: true,sa
cursor_lock_key: KeyCode::Space,
sensitivity: Vec2::new(1.0, 1.0),
mouse_orbit_button_enabled: false,
mouse_orbit_button: MouseButton::Middle,
offset_enabled: false,
offset: Offset::new(0.5, 0.4),
offset_toggle_speed: 5.0,
offset_toggle_key: Some(KeyCode::T), // default is None
zoom: Zoom::new(1.5, 3.0),
zoom_sensitivity: 1.0,
gamepad_settings: CameraGamepadSettings {
aim_button: Some(GamepadButton::new(gamepad, GamepadButtonType::LeftTrigger2)),
mouse_orbit_button: GamepadButton::new(gamepad, GamepadButtonType::LeftTrigger),
sensitivity: Vec2::new(1.0, 1.0),
offset_toggle_button: Some(GamepadButton::new(gamepad, GamepadButtonType::DPadRight)), // default is None
zoom_in_button: GamepadButton::new(gamepad, GamepadButtonType::DPadUp),
zoom_out_button: GamepadButton::new(gamepad, GamepadButtonType::DPadDown),
},
..default()
},
Camera3dBundle::default(),
));
commands.spawn((
ThirdPersonCameraTarget,
// default settings
ThirdPersonController {
move_left: KeyCode::KeyA,
move_right: KeyCode::KeyD,
move_forward: KeyCode::KeyW,
move_back: KeyCode::KeyS,
sprint_enabled: true,
sprint: KeyCode::ShiftLeft,
sprint_speed: 2.0,
speed: 2.5,
gamepad_settings: ControllerGamepadSettings {
sprint: GamepadButton::new(gamepad, GamepadButtonType::LeftTrigger)
}
}
));
Action | Mouse/Keyboard | Gamepad | Enabled by Default |
---|---|---|---|
Zoom In | Scroll Up | D Pad Up | Yes |
Zoom Out | Scroll Down | D Pad Down | Yes |
Aim | Right Mouse Button | Left Trigger | No |
Toggle Offset | E | D Pad Right | No |
Cursor Lock/Unlock | Space | n/a | Yes |
Orbit Button | Middle Mouse Button | Left Bumper | No |
Move Left | A | Left Joystick | Yes |
Move Right | D | Left Joystick | Yes |
Move Forward | W | Left Joystick | Yes |
Move Back | S | Left Joystick | Yes |
Sprint | Left Shift | Left Bumper | Yes |
bevy | bevy_third_person_camera |
---|---|
0.13 | 0.1.9 - 0.1.11 |
0.12 | 0.1.7 - 0.1.8 |
0.11 | 0.1.1 - 0.1.6 |
Refer to the Changelog to view breaking changes and updates.
- MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)