Add the game soundtrack

README.md

@@ -31,8 +31,9 @@ This game is developed by a team of 6 students from *Sheridan College* and *Tren
 - [**Emilia Frias**](https://www.instagram.com/demilurii/)
   - Character art
   - Animations
-  - Map assets
+  - Tilesets
 - [**Kori**](https://www.instagram.com/korigama/)
   - Concept art
+  - Tilesets
 
 A special thanks goes out to: [James Nickoli](https://github.com/rsninja722/) for insight on 2D collision detection, as well as [Ray](https://github.com/raysan5) and the members of the [raylib community](https://discord.gg/raylib) on discord for their support with the past two game jam projects.

game/src/lib.rs

@@ -78,19 +78,10 @@ use raylib::prelude::*;
 use tracing::{error, info, warn};
 use utilities::discord::DiscordConfig;
 
-use crate::{
-    context::GameContext,
-    discord_rpc::{maybe_set_discord_presence, try_connect_to_local_discord},
-    progress::ProgressData,
-    scenes::{build_screen_state_machine, Scenes},
-    utilities::{
-        game_config::FinalShaderConfig,
-        shaders::{
+use crate::{context::GameContext, discord_rpc::{maybe_set_discord_presence, try_connect_to_local_discord}, progress::ProgressData, scenes::{build_screen_state_machine, Scenes}, utilities::{audio_player::AudioPlayer, datastore::load_music_from_internal_data, game_config::FinalShaderConfig, shaders::{
             shader::ShaderWrapper,
             util::{dynamic_screen_texture::DynScreenTexture, render_texture::render_to_texture},
-        },
-    },
-};
+        }}};
 
 #[macro_use]
 extern crate thiserror;
@@ -184,6 +175,16 @@ pub async fn game_begin(game_config: &mut GameConfig) -> Result<(), Box<dyn std:
         });
     }
 
+    // Init the audio subsystem
+    let mut audio_system = AudioPlayer::new(RaylibAudio::init_audio_device());
+    audio_system.set_master_volume(0.4);
+
+    // Load the game's main song
+    let mut main_song = load_music_from_internal_data(&mut context.renderer.borrow_mut(), &raylib_thread, "audio/soundtrack.mp3").unwrap();
+
+    // Start the song
+    audio_system.play_music_stream(&mut main_song);
+
     // Get the main state machine
     info!("Setting up the scene management state machine");
     let mut game_state_machine =
@@ -223,6 +224,12 @@ pub async fn game_begin(game_config: &mut GameConfig) -> Result<(), Box<dyn std:
         puffin::profile_scope!("main_loop");
         puffin::GlobalProfiler::lock().new_frame();
 
+        // Update the audio
+        audio_system.update_music_stream(&mut main_song);
+        if !audio_system.is_music_playing(&main_song) {
+            audio_system.play_music_stream(&mut main_song);
+        }
+
         // Update the GPU texture that we draw to. This handles screen resizing and some other stuff
         dynamic_texture
             .update(&mut context.renderer.borrow_mut(), &raylib_thread)

game/src/scenes/main_menu_screen.rs

@@ -265,5 +265,7 @@ impl ScreenSpaceRender for MainMenuScreen {
             );
         };
         self.is_quit_pressed = mouse_pressed && hovering_quit;
+
+        // for
     }
 }

game/src/utilities/audio_player.rs

@@ -0,0 +1,48 @@
+use raylib::audio::RaylibAudio;
+
+/// A thin wrapper around `raylib::core::audio::RaylibAudio` that keeps track of the volume of its audio channels.
+pub struct AudioPlayer {
+    backend: RaylibAudio,
+
+    // Volume
+    pub master_volume: f32,
+}
+
+impl AudioPlayer {
+    /// Construct an AudioPlayer around a RaylibAudio
+    pub fn new(backend: RaylibAudio) -> Self {
+        Self {
+            backend,
+            master_volume: 1.0,
+        }
+    }
+
+    /// Set the master volume for all tracks. `0.0` to `1.0`
+    pub fn set_master_volume(&mut self, volume: f32) {
+        // The volume must be 0-1
+        let volume = volume.clamp(0.0, 1.0);
+
+        // Set the volume
+        self.master_volume = volume;
+        self.backend.set_master_volume(volume);
+    }
+
+    /// Get the master volume
+    pub fn get_master_volume(&self) -> f32 {
+        self.master_volume
+    }
+}
+
+impl std::ops::Deref for AudioPlayer {
+    type Target = RaylibAudio;
+    fn deref(&self) -> &Self::Target {
+        &self.backend
+    }
+}
+
+
+impl std::ops::DerefMut for AudioPlayer {
+    fn deref_mut(&mut self) -> &mut Self::Target {
+        &mut self.backend
+    }
+}

game/src/utilities/datastore.rs

@@ -1,6 +1,6 @@
 use std::{io::Write, path::Path};
 
-use raylib::{texture::Texture2D, RaylibHandle, RaylibThread};
+use raylib::{RaylibHandle, RaylibThread, audio::Music, texture::Texture2D};
 use tempfile::{tempdir, NamedTempFile};
 use tracing::debug;
 
@@ -67,3 +67,39 @@ pub fn load_texture_from_internal_data(
 
     Ok(texture)
 }
+
+
+pub fn load_music_from_internal_data(
+    raylib_handle: &mut RaylibHandle,
+    thread: &RaylibThread,
+    path: &str,
+) -> Result<Music, ResourceLoadError> {
+    // Create a temp file path to work with
+    let temp_dir = tempdir()?;
+    debug!(
+        "Created temporary directory for passing embedded data to Raylib: {}",
+        temp_dir.path().display()
+    );
+    let tmp_path = temp_dir.path().join(Path::new(path).file_name().unwrap());
+
+    // Unpack the raw sound data to a real file on the local filesystem so raylib will read it correctly
+    std::fs::write(
+        &tmp_path,
+        &StaticGameData::get(path)
+            .ok_or(ResourceLoadError::AssetNotFound(path.to_string()))?
+            .data,
+    )?;
+
+    // Call through via FFI to re-load the file
+    let texture = Music::load_music_stream(thread, tmp_path.to_str().unwrap())
+        .map_err(ResourceLoadError::Generic)?;
+
+    // Close the file
+    debug!(
+        "Dropping temporary directory: {}",
+        temp_dir.path().display()
+    );
+    temp_dir.close()?;
+
+    Ok(texture)
+}

game/src/utilities/mod.rs

@@ -8,3 +8,4 @@ pub mod non_ref_raylib;
 pub mod render_layer;
 pub mod shaders;
 pub mod world_paint_texture;
+pub mod audio_player;