Update to bevy 0.12, bka 0.18

Cargo.toml

 [package]
 name = "micro_musicbox"
-version = "0.7.0"
+version = "0.8.0"
 edition = "2021"
 license = "Apache-2.0"
 authors = ["Louis Capitanchik <louis@microhacks.co.uk>"]
@@ -13,26 +13,32 @@ exclude = ["assets"]
 [[example]]
 name = "kitchen-sink"
 path = "examples/kitchen_sink.rs"
-required-features = ["mp3"]
+required-features = ["mp3", "ogg"]
 
 [[example]]
 name = "basic"
 path = "examples/basic.rs"
 required-features = ["mp3"]
 
+[[example]]
+name = "from-settings"
+path = "examples/from-settings.rs"
+required-features = ["ogg", "settings"]
+
 [features]
-default = []
+default = ["settings"]
 serde = ["dep:serde"]
 mp3 = ["bevy_kira_audio/mp3"]
 flac = ["bevy_kira_audio/flac"]
 wav = ["bevy_kira_audio/wav"]
 ogg = ["bevy_kira_audio/ogg"]
+settings = ["bevy_kira_audio/settings_loader"]
 
 [dependencies]
-bevy = { version = "0.11.0", default-features = false }
-bevy_kira_audio = { version = "0.16.0", default-features = false }
+bevy = { version = "0.12", default-features = false }
+bevy_kira_audio = { version = "0.18.0", default-features = false }
 serde = { version = "1", optional = true }
 
 [dev_dependencies]
-bevy = "0.11.0"
+bevy = "0.12"
 log = "0.4"

README.md

@@ -140,6 +140,7 @@ The examples in this repository use assets available under the following license
 
 | musicbox version | bevy version | bka version |
 |------------------|--------------|-------------|
+| 0.8              | 0.12         | 0.18        |
 | 0.7              | 0.11         | 0.16        |
 | 0.6              | 0.10         | 0.15        |
 | 0.5              | 0.9          | 0.13        |

assets/The-White-Kitty.ogg.ron

+(
+    file: "The-White-Kitty.ogg",
+    playback_region: Region(start: Seconds(10), end: Custom(Seconds(20))),
+    loop_region: Some(Region(start: Seconds(10), end: Custom(Seconds(20)))),
+)
\ No newline at end of file

examples/from-settings.rs

+use bevy::prelude::*;
+use bevy::window::WindowResolution;
+use micro_musicbox::prelude::*;
+use micro_musicbox::CombinedAudioPlugins;
+
+fn main() {
+	App::new()
+		.add_plugins(DefaultPlugins.set(WindowPlugin {
+			primary_window: Some(Window {
+				resolution: WindowResolution::new(800.0, 600.0),
+				title: String::from("Settings File Example"),
+				..Default::default()
+			}),
+			..Default::default()
+		}))
+		.add_plugins(CombinedAudioPlugins::<AssetServer>::new())
+		.add_systems(Startup, play_audio)
+		.run();
+}
+
+pub fn play_audio(mut music_box: MusicBox<AssetServer>) {
+	music_box.play_music_raw("The-White-Kitty.ogg.ron");
+}

examples/kitchen_sink.rs

@@ -57,7 +57,7 @@ pub fn set_instructions(
 }
 
 pub fn setup_audio(mut commands: Commands, mut musicbox: MusicBox<AssetServer>) {
-	musicbox.play_music("The-White-Kitty.mp3");
+	musicbox.play_music("The-White-Kitty.ogg");
 	commands.insert_resource(MusicState {
 		playing_first: true,
 	});
@@ -76,7 +76,7 @@ pub fn cross_fade_tracks(
 			);
 		} else {
 			music_box.cross_fade_music(
-				"The-White-Kitty.mp3",
+				"The-White-Kitty.ogg",
 				AudioTween::new(Duration::from_millis(500), AudioEasing::InOutPowf(0.6)),
 			);
 		}

examples/utilities/mod.rs

-use bevy::asset::LoadState;
+use bevy::asset::{LoadState, RecursiveDependencyLoadState};
 use bevy::prelude::*;
 use bevy_kira_audio::AudioSource;
 
@@ -18,7 +18,7 @@ pub enum AppState {
 }
 
 pub fn load_resources(mut commands: Commands, assets: Res<AssetServer>) {
-	let white_kitty = assets.load("The-White-Kitty.mp3");
+	let white_kitty = assets.load("The-White-Kitty.ogg");
 	let great_madeja = assets.load("The-Great-Madeja.mp3");
 
 	commands.insert_resource(AudioResources {
@@ -30,23 +30,22 @@ pub fn load_resources(mut commands: Commands, assets: Res<AssetServer>) {
 pub fn check_load_state(
 	assets: Res<AssetServer>,
 	resources: Res<AudioResources>,
-	appstate: Res<State<AppState>>,
 	mut next_state: ResMut<NextState<AppState>>,
 ) {
-	let load_state = assets.get_group_load_state(vec![
-		resources.white_kitty.id(),
-		resources.great_madeja.id(),
-	]);
+	let load_list = vec![resources.white_kitty.id(), resources.great_madeja.id()];
 
-	match load_state {
-		LoadState::Loaded => {
-			log::info!("STATE {:?}", appstate);
-			next_state.set(AppState::Running);
-		}
-		LoadState::Loading => {}
-		_ => {
-			log::error!("The resources are in a bad state! This is a problem");
-		}
+	let loaded = load_list
+		.iter()
+		.map(|a| assets.get_load_states(a.untyped()))
+		.all(|state| match state {
+			None => false,
+			Some((own, _, deps)) => {
+				own == LoadState::Loaded && deps == RecursiveDependencyLoadState::Loaded
+			}
+		});
+
+	if loaded {
+		next_state.set(AppState::Running);
 	}
 }
 
@@ -77,7 +76,7 @@ pub fn create_ui(mut commands: Commands, assets: Res<AssetServer>) {
 					text: Text::from_section(
 						"Loading Audio Tracks",
 						TextStyle {
-							color: Color::BLACK,
+							color: Color::ANTIQUE_WHITE,
 							font_size: 48.0,
 							font: assets.load("KenneyBlocks.ttf"),
 						},
@@ -90,7 +89,7 @@ pub fn create_ui(mut commands: Commands, assets: Res<AssetServer>) {
 					text: Text::from_section(
 						"...",
 						TextStyle {
-							color: Color::BLACK,
+							color: Color::ANTIQUE_WHITE,
 							font_size: 32.0,
 							font: assets.load("KenneyBlocks.ttf"),
 						},

src/music_box.rs

@@ -9,14 +9,11 @@ use crate::{AmbianceAudioChannel, MusicAudioChannel, SfxAudioChannel, UiSfxAudio
 
 /// A wrapper for each of the audio channels created and controlled by MusicBox
 #[derive(SystemParam)]
-pub struct AudioChannels<'w, 's> {
+pub struct AudioChannels<'w> {
 	pub music_channel: Res<'w, AudioChannel<MusicAudioChannel>>,
 	pub ambiance_channel: Res<'w, AudioChannel<AmbianceAudioChannel>>,
 	pub sfx_channel: Res<'w, AudioChannel<SfxAudioChannel>>,
 	pub ui_sfx_channel: Res<'w, AudioChannel<UiSfxAudioChannel>>,
-
-	#[system_param(ignore)]
-	_p: PhantomData<&'s ()>,
 }
 
 /// The service object used to control your game's audio
@@ -26,8 +23,8 @@ pub struct AudioChannels<'w, 's> {
 /// The particular implementation of `SuppliesAudio` will be used to verify that a music track exists,
 /// and then to retrieve the associated `AudioSource`.
 #[derive(SystemParam)]
-pub struct MusicBox<'w, 's, T: SuppliesAudio> {
-	channels: AudioChannels<'w, 's>,
+pub struct MusicBox<'w, T: SuppliesAudio> {
+	channels: AudioChannels<'w>,
 	handles: Res<'w, T>,
 	settings: ResMut<'w, AudioSettings>,
 	state: ResMut<'w, MusicBoxState>,
@@ -46,7 +43,23 @@ pub struct MusicBoxState {
 	pub active_ambiance_name: Option<String>,
 }
 
-impl<'w, 's, T: SuppliesAudio> MusicBox<'w, 's, T> {
+impl<'w, T: SuppliesAudio> MusicBox<'w, T> {
+	/// Get the instance backing the currently active music track, if one is active
+	pub fn get_music_track(&mut self) -> Option<&mut AudioInstance> {
+		self.state
+			.active_music
+			.as_ref()
+			.and_then(|hand| self.audio_instances.get_mut(hand))
+	}
+
+	/// Get the instance backing the currently active ambiance track, if one is active
+	pub fn get_ambiance_track(&mut self) -> Option<&mut AudioInstance> {
+		self.state
+			.active_ambiance
+			.as_ref()
+			.and_then(|hand| self.audio_instances.get_mut(hand))
+	}
+
 	/// Start playing a new audio track on the Music channel. The provided tween will be used
 	/// to fade in the new track, and to fade out the old track
 	///
@@ -102,6 +115,63 @@ impl<'w, 's, T: SuppliesAudio> MusicBox<'w, 's, T> {
 		self.fade_in_music(name, AudioTween::default())
 	}
 
+	/// Start playing a new audio track on the Music channel. No extra configuration will be applied,
+	/// making this method suitable for audio loaded via a settings file
+	///
+	/// # Returns
+	///
+	/// A handle for the newly started audio instance, or `None` if the track was not found
+	pub fn play_music_raw<Name: ToString>(&mut self, name: Name) -> Option<Handle<AudioInstance>> {
+		let name = name.to_string();
+
+		if self.state.active_music_name == Some(name.to_string()) {
+			return self.state.active_music.as_ref().map(|f| f.clone_weak());
+		}
+
+		match self.map_tracks(&name) {
+			TrackType::Single(track) => {
+				self.stop_music();
+				let next = self.channels.music_channel.play(track).handle();
+
+				self.state.active_music_name = Some(name);
+				self.state.active_music = Some(next.clone_weak());
+
+				Some(next)
+			}
+			_ => None,
+		}
+	}
+
+	/// Start playing a new audio track on the Ambiance channel. No extra configuration will be applied,
+	/// making this method suitable for audio loaded via a settings file
+	///
+	/// # Returns
+	///
+	/// A handle for the newly started audio instance, or `None` if the track was not found
+	pub fn play_ambiance_raw<Name: ToString>(
+		&mut self,
+		name: Name,
+	) -> Option<Handle<AudioInstance>> {
+		let name = name.to_string();
+
+		if self.state.active_ambiance_name == Some(name.to_string()) {
+			return self.state.active_ambiance.as_ref().map(|f| f.clone_weak());
+		}
+
+		match self.map_tracks(&name) {
+			TrackType::Single(track) => {
+				self.stop_ambiance();
+				let next = self.channels.ambiance_channel.play(track).handle();
+
+				self.state.active_ambiance_name = Some(name);
+				self.state.active_ambiance = Some(next.clone_weak());
+
+				Some(next)
+			}
+			_ => None,
+		}
+	}
+
 	/// Stop playing music on the Music channel
 	pub fn stop_music(&mut self) {
 		self.fade_out_music(AudioTween::default());