Avian is an ECS-driven 2D and 3D physics engine for the Bevy game engine.
Below are some of the core design principles used in Avian.
Below are some of the current features of Avian.
SpatialQuery
system parameterf32
/f64
precision (f32
by default)You can find a more complete list along with documentation in the Table of contents on docs.rs.
First, add avian2d
or avian3d
to your dependencies in Cargo.toml
:
# For 2D applications:
[dependencies]
avian2d = "0.1"
# For 3D applications:
[dependencies]
avian3d = "0.1"
# If you want to use the most up-to-date version, you can follow the main branch:
[dependencies]
avian3d = { git = "https://github.com/Jondolf/avian", branch = "main" }
Below is a very simple example where a cube with initial angular velocity falls onto a circular platform.
This is a modified version of Bevy's 3d_scene
example.
use avian3d::prelude::*;
use bevy::prelude::*;
fn main() {
App::new()
// Enable physics
.add_plugins((DefaultPlugins, PhysicsPlugins::default()))
.add_systems(Startup, setup)
.run();
}
fn setup(
mut commands: Commands,
mut meshes: ResMut<Assets<Mesh>>,
mut materials: ResMut<Assets<StandardMaterial>>,
) {
// Static physics object with a collision shape
commands.spawn((
RigidBody::Static,
Collider::cylinder(4.0, 0.1),
PbrBundle {
mesh: meshes.add(Cylinder::new(4.0, 0.1)),
material: materials.add(Color::WHITE),
..default()
},
));
// Dynamic physics object with a collision shape and initial angular velocity
commands.spawn((
RigidBody::Dynamic,
Collider::cuboid(1.0, 1.0, 1.0),
AngularVelocity(Vec3::new(2.5, 3.5, 1.5)),
PbrBundle {
mesh: meshes.add(Cuboid::new(1.0, 1.0, 1.0)),
material: materials.add(Color::srgb_u8(124, 144, 255)),
transform: Transform::from_xyz(0.0, 4.0, 0.0),
..default()
},
));
// Light
commands.spawn(PointLightBundle {
point_light: PointLight {
shadows_enabled: true,
..default()
},
transform: Transform::from_xyz(4.0, 8.0, 4.0),
..default()
});
// Camera
commands.spawn(Camera3dBundle {
transform: Transform::from_xyz(-2.5, 4.5, 9.0).looking_at(Vec3::ZERO, Dir3::Y),
..default()
});
}
You can find lots of 2D and 3D examples in /crates/avian2d/examples and /crates/avian3d/examples respectively.
The examples support both f32
and f64
precisions, so the code contains some feature-dependent types like Scalar
and Vector
.
In actual usage these are not needed, so you can just use f32
or f64
types depending on the features you have chosen.
By default the examples use f32
. To run the f64
versions, you need to disable default features and manually choose the dimension
and precision:
# Manually specify dimension and precision. `parry-f64` enables collision detection using Parry.
cargo run --example cubes --no-default-features --features "3d f64 parry-f64"
Bevy | Avian |
---|---|
0.14 | 0.1 |
If you encounter any problems, feel free to open issues or create pull requests. For larger changes and additions, it's better to open an issue or ask me for input before making a pull request.
You can also ask for help or ask questions on the Bevy Discord
server's Avian Physics
thread in #crate-help
. My username on the Discord is Jondolf
(@jondolfdev
).
Huge thanks to the entire Bevy community for the incredible support! All of your contributions, insight and requests are a massive help in driving the state of physics in Bevy forward, and it's what keeps me motivated to build the best engine I can.
I would also like to give a special thanks to Johan Helsing
for inspiring this project and helping me significantly in the early stages.
His original tutorial series is the reason avian
exists in the first place, and without his support and contributions,
the project wouldn't be anywhere near where it is today.
Avian is free and open source. All code in this repository is dual-licensed under either:
at your option.