Crate bevy_trauma_shake

bevy_trauma_shake

Add camera shakes to your 2d Bevy game with three lines of code.

Goals

• Zero configuration required
• Sensible defaults
• Batteries included (default noise)
• Compatible with bevy_pancam

Usage

Add the plugin:

app.add_plugins(TraumaPlugin);

Simply add a component to your camera:

commands.spawn((Camera2dBundle::default(), Shake::default()));

Make it shake:

fn shake(mut shake: Query<&mut Shake>, keys: Res<Input<KeyCode>>) {
    if keys.just_pressed(KeyCode::Space) {
        shake.single_mut().add_trauma(0.2);
    }
}

There is also a convenience system param for applying trauma to all Shakes:

fn shake(mut shake: Shakes, keys: Res<Input<KeyCode>>) {
    if keys.just_pressed(KeyCode::Space) {
        shakes.add_trauma(0.2);
    }
}

And an event, if you prefer that:

fn shake(mut trauma: EventWriter<TraumaEvent>, keys: Res<Input<KeyCode>>) {
    if keys.just_pressed(KeyCode::Key1) {
        trauma.send(0.2.into());
    }
}

And even a command:

fn shake(mut commands: Commands, keys: Res<Input<KeyCode>>) {
    if keys.just_pressed(KeyCode::Key1) {
        info!("Adding small trauma");
        commands.add_trauma(0.2);
    }
}

Maybe I went a little overboard and I should remove one of those ways, in any case, they can be toggled through the features: system_param, events, commands.

Optional configuration

Optionally add ShakeSettings, if you’re not happy with the defaults.

    commands.spawn((
        Name::new("Camera"),
        Camera2dBundle::default(),
        Shake::default(),
        ShakeSettings {
            amplitude: 200.,
            trauma_power: 3.,
            decay_per_second: 0.3,
            frequency: 4.,
            octaves: 2,
        },
        PanCam::default(),
    ));

Bevy Version Support

The main branch targets the latest bevy release.

bevy	bevy_trauma_shake
0.13	0.2, main
0.12	0.1

License

bevy_trauma_shake is dual-licensed under either

• 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)

at your option.

Thanks

• https://www.youtube.com/watch?v=tu-Qe66AvtY
• bevy_camera_shake: 2D and 3D shakes and more configuration options. I used this a lot for reference, but I wanted a simpler API.

Contributions

PRs welcome!

Modules

• prelude
  Everything you need to use the plugin

Structs

• Shake
  Makes the entity shake according to applied trauma.
• ShakeSettings
  These can generally be left unchanged.
• Shakes
  Convenience [SystemParam] for adding trauma to all Shakes at the same time.
• TraumaEvent
  Event for adding trauma to all shakes
• TraumaPlugin
  Plugin for adding trauma-based shakes to 2d cameras (or other things).

Traits

• TraumaCommands
  Extension trait for [Command], adding commands for easily applying trauma fire-and-forget-style.