micro_musicbox 0.10.0

Opinionated service interface for bevy_kira_audio
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

//! micro_musicbox provides a convenience wrapper around bevy_kira_audio, handling all the
//! setup for the common game audio scenario. This includes channel management, giving you
//! control of the audio levels for your music, ambiance, sound effects and UI separately
//! from the start.
//!
//! ## Quickstart
//!
//! - Implement `SuppliesAudio` for a resource (or use the built-in impl on `AssetServer`)
//! - Include the MusixBocPlugin plugin, or the CombinedAudioPlugins plugin group in your app, providing your `SuppliesAudio` impl as the generic parameter
//! - Use `MusicBox<T: SuppliesAudio>` as a parameter on a system
//! - Call one of the `MusicBox::play_*` methods to play sounds
//!
//! ```rust
//! # use bevy::prelude::*;
//! # use micro_musicbox::prelude::*;
//! # use micro_musicbox::CombinedAudioPlugins;
//! fn main() {
//!     App::new()
//!         .add_plugins(AssetPlugin::default())
//!         .add_plugins(CombinedAudioPlugins::<AssetServer>::new())
//!         .add_systems(Startup, |mut music_box: MusicBox<AssetServer>| {
//!             music_box.play_music("music/bing_bong.mp3");
//!         });
//! }
//! ```

use std::marker::PhantomData;

use bevy::app::PluginGroupBuilder;
use bevy::prelude::*;
use bevy_kira_audio::{AudioApp, AudioPlugin};

use crate::channels::{
	AmbianceAudioChannel, MusicAudioChannel, SfxAudioChannel, UiSfxAudioChannel,
};
use crate::music_box::MusicBoxState;
use crate::utilities::{AudioSettings, SuppliesAudio};

/// The available channels that you can play audio on
pub mod channels;
pub mod music_box;
pub mod utilities;

pub mod prelude {
	pub use bevy_kira_audio::{
		prelude::*, AudioChannel, AudioControl, AudioEasing, AudioInstance,
		AudioSettings as KiraAudioSettings, AudioSource, AudioTween,
	};

	pub use super::channels::*;
	pub use super::music_box::MusicBox;
	pub use super::utilities::AudioSettings;
}

/// A Bevy plugin that sets up all of the audio channels,
/// creates the required settings resources, and configures
/// syncing volume levels for a `MusicBox` that uses the supplied
/// `T` parameter for fetching audio
pub struct MusicBoxPlugin<T: SuppliesAudio> {
	_t: PhantomData<T>,
}

impl<T: SuppliesAudio> Default for MusicBoxPlugin<T> {
	fn default() -> Self {
		Self { _t: PhantomData }
	}
}

impl<T: SuppliesAudio> MusicBoxPlugin<T> {
	/// Create a new MusicBoxPlugin
	pub fn new() -> MusicBoxPlugin<T> {
		Default::default()
	}
}

impl<T: SuppliesAudio> Plugin for MusicBoxPlugin<T> {
	fn build(&self, app: &mut App) {
		app.add_audio_channel::<MusicAudioChannel>()
			.add_audio_channel::<AmbianceAudioChannel>()
			.add_audio_channel::<SfxAudioChannel>()
			.add_audio_channel::<UiSfxAudioChannel>()
			.insert_resource(AudioSettings::default())
			.insert_resource(MusicBoxState::default())
			.add_systems(Last, utilities::sync_music_volume::<T>);
	}
}

/// A Bevy plugin group that adds `bevy_kira_audio` as well as the
/// plugin required to be able to use a `MusicBox`
pub struct CombinedAudioPlugins<T: SuppliesAudio> {
	_t: PhantomData<T>,
}

impl<T: SuppliesAudio> Default for CombinedAudioPlugins<T> {
	fn default() -> Self {
		Self { _t: PhantomData }
	}
}

impl<T: SuppliesAudio> CombinedAudioPlugins<T> {
	pub fn new() -> CombinedAudioPlugins<T> {
		Default::default()
	}
}

impl<T: SuppliesAudio> PluginGroup for CombinedAudioPlugins<T> {
	fn build(self) -> PluginGroupBuilder {
		let mut group = PluginGroupBuilder::start::<Self>();
		group = group.add(AudioPlugin).add(MusicBoxPlugin::<T>::new());
		group
	}
}