Lib.rs

A sprouting integration of the Firewheel audio engine for Bevy.

bevy_seedling is powerful, flexible, and fast. You can play sounds, apply effects, and route audio anywhere. Creating and integrating custom audio processors is simple.

Getting started

First, you'll need to add the dependency to your Cargo.toml. Note that you'll need to disable Bevy's bevy_audio feature, meaning you'll need to specify quite a few features manually!

[dependencies]
bevy_seedling = "0.7.2"
bevy = { version = "0.18.0", default-features = false, features = [
  # 2d
  "2d_bevy_render",
  "default_app",
  "picking",
  "scene",

  # 3d
  "3d_bevy_render",

  # ui
  "ui_api",
  "ui_bevy_render",

  # default_platform
  "android-game-activity",
  "bevy_gilrs",
  "bevy_winit",
  "default_font",
  "multi_threaded",
  "std",
  "sysinfo_plugin",
  "wayland",
  "webgl2",
  "x11",
] }

Then, you'll need to add the SeedlingPlugin to your app.

use bevy::prelude::*;
use bevy_seedling::prelude::*;

fn main() {
    App::default()
        .add_plugins((DefaultPlugins, SeedlingPlugin::default()))
        .run();
}

Once you've set it all up, playing sounds is easy!

fn play_sound(mut commands: Commands, server: Res<AssetServer>) {
    // Play a sound!
    commands.spawn(SamplePlayer::new(server.load("my_sample.wav")));

    // Play a sound... with effects :O
    commands.spawn((
        SamplePlayer::new(server.load("my_ambience.wav")).looping(),
        sample_effects![LowPassNode { frequency: 500.0 }],
    ));
}

The crate docs provide an overview of bevy_seedling's features, and the repository's examples should help you get up to speed on common usage patterns.

Feature flags

Bevy version compatibility

License