Hanabi — a GPU particle system for the Bevy game engine.
The Hanabi particle system is a modern GPU-based particle system for the Bevy game engine. It focuses on scale to produce stunning visual effects (VFX) in real time, offloading most of the work to the GPU, with minimal CPU intervention. The design is inspired by modern particle systems found in other industry-leading game engines.
🚧 This project is under heavy development, and is currently lacking both features and performance / usability polish. However, for moderate-size effects, it can already be used in your project. Feedback and contributions on both design and features are very much welcome.
The 🎆 Bevy Hanabi plugin is only compatible with Bevy v0.6.
Add the HanabiPlugin to your app:
```rust use bevy_hanabi::*;
App::default() .addplugins(DefaultPlugins) .addplugin(HanabiPlugin) .run(); ```
Create an EffectAsset describing a visual effect:
```rust
fn setup(mut effects: ResMut
// Create the effect asset
let effect = effects.add(EffectAsset {
name: "MyEffect".to_string(),
// Maximum number of particles alive at a time
capacity: 32768,
// Spawn at a rate of 5 particles per second
spawner: Spawner::rate(5.0.into()),
..Default::default()
}
// On spawn, randomly initialize the position and velocity
// of the particle over a sphere of radius 2 units, with a
// radial initial velocity of 6 units/sec away from the
// sphere center.
.init(PositionSphereModifier {
center: Vec3::ZERO,
radius: 2.,
dimension: ShapeDimension::Surface,
speed: 6.0.into(),
})
// Every frame, add a gravity-like acceleration downward
.update(AccelModifier {
accel: Vec3::new(0., -3., 0.),
})
// Render the particles with a color gradient over their
// lifetime.
.render(ColorOverLifetimeModifier { gradient })
);
} ```
Use a ParticleEffectBundle to create an effect instance from an existing asset:
rust
commands
.spawn()
.insert(Name::new("MyEffectInstance"))
.insert_bundle(ParticleEffectBundle {
effect: ParticleEffect::new(effect),
transform: Transform::from_translation(Vec3::new(0., 1., 0.)),
..Default::default()
});
See the examples/ folder.
Animate an emitter by moving its Transform component, and emit textured quad particles with a ColorOverLifetimeModifier.
shell
cargo run --example gradient --features="bevy/bevy_winit bevy/png"
This example demonstrates the force field modifier ForceFieldModifier, which allows creating some attraction and repulsion sources affecting the motion of the particles.
shell
cargo run --example force_field --features="bevy/bevy_winit"
This example demonstrates manual activation and deactivation of a spawner, from code (CPU). The circle bobs up and down in the water, spawning square bubbles when in the water only.
shell
cargo run --example activate --features="bevy/bevy_winit"
This example demonstrates three spawn modes:
It also shows the applying of constant force (downward gravity-like, or upward smoke-style).
shell
cargo run --example spawn --features="bevy/bevy_winit"
This example demonstrates how to emit a burst of particles when an event occurs. This gives total control of the spawning to the user code.
shell
cargo run --example spawn_on_command --features="bevy/bevy_winit"
This example demonstrates the circle spawner type, which emits particles along a circle perimeter or a disk surface. This allows for example simulating a dust ring around an object colliding with the ground.
shell
cargo run --example circle --features="bevy/bevy_winit bevy/png"
This example spawns particles with randomized parameters.
shell
cargo run --example random --features="bevy/bevy_winit"
The main branch is compatible with the latest Bevy release.
Compatibility of bevy_hanabi versions:
| bevy_hanabi | bevy |
| :-- | :-- |
| 0.1 | 0.6 |