From cc0853eb9a7a7f6b8c32dc1937baeaf5e43d6664 Mon Sep 17 00:00:00 2001
From: Piturnah <peterhebden6@gmail.com>
Date: Thu, 15 Dec 2022 05:05:00 +0000
Subject: [PATCH 1/7] Initial config file implementation

---
 Cargo.lock    | 35 +++++++++++++++++++++++++++++
 Cargo.toml    |  4 ++++
 src/audio.rs  | 25 +++++++++++++++++----
 src/config.rs | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++
 src/main.rs   |  7 +++++-
 5 files changed, 127 insertions(+), 5 deletions(-)
 create mode 100644 src/config.rs

diff --git a/Cargo.lock b/Cargo.lock
index a2efa83..fa2e44e 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -951,11 +951,15 @@ dependencies = [
  "bevy_ecs_ldtk",
  "bevy_kira_audio",
  "bevy_ninepatch",
+ "directories",
  "itertools",
  "iyes_loopless",
  "leafwing-input-manager",
  "noise",
  "rand 0.8.5",
+ "serde",
+ "serde_derive",
+ "toml",
 ]
 
 [[package]]
@@ -1330,6 +1334,26 @@ dependencies = [
  "syn",
 ]
 
+[[package]]
+name = "directories"
+version = "4.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f51c5d4ddabd36886dd3e1438cb358cdcb0d7c499cb99cb4ac2e38e18b5cb210"
+dependencies = [
+ "dirs-sys",
+]
+
+[[package]]
+name = "dirs-sys"
+version = "0.3.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1b1d1d91c932ef41c0f2663aa8b0ca0342d444d842c06914aa0a7e352d0bada6"
+dependencies = [
+ "libc",
+ "redox_users",
+ "winapi",
+]
+
 [[package]]
 name = "discard"
 version = "1.0.4"
@@ -2785,6 +2809,17 @@ dependencies = [
  "bitflags",
 ]
 
+[[package]]
+name = "redox_users"
+version = "0.4.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b033d837a7cf162d7993aded9304e30a83213c648b6e389db233191f891e5c2b"
+dependencies = [
+ "getrandom 0.2.7",
+ "redox_syscall",
+ "thiserror",
+]
+
 [[package]]
 name = "regex"
 version = "1.6.0"
diff --git a/Cargo.toml b/Cargo.toml
index bfd37c2..f8077a9 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -11,9 +11,13 @@ bevy_ninepatch = "0.9"
 iyes_loopless = "0.9"
 leafwing-input-manager = "0.7"
 
+directories = "4.0"
 itertools = "0.10"
 noise = { git = "https://github.com/bsurmanski/noise-rs", rev = "5abdde1b819eccc47e74969c15e1b56ae5a055d6" }
 rand = { version = "0.8", default_features = false, features = ["std", "small_rng"] }
+serde = "1.0"
+serde_derive = "1.0"
+toml = "0.5"
 
 [dependencies.bevy]
 version = "0.9"
diff --git a/src/audio.rs b/src/audio.rs
index 4e42be4..051e38c 100644
--- a/src/audio.rs
+++ b/src/audio.rs
@@ -3,7 +3,7 @@ use bevy_kira_audio::prelude::*;
 use iyes_loopless::prelude::*;
 use rand::prelude::*;
 
-use crate::{GameRng, GameState};
+use crate::{config::Config, GameRng, GameState};
 
 pub struct AudioPlugin;
 
@@ -11,11 +11,13 @@ impl Plugin for AudioPlugin {
     fn build(&self, app: &mut App) {
         app.add_event::<PlaySfx>()
             .add_audio_channel::<BgmChannel>()
+            .add_audio_channel::<SfxChannel>()
             .add_startup_system(load_audio)
             .add_enter_system(GameState::MainMenu, start_title_bgm)
             .add_enter_system(GameState::InGame, start_fight_bgm)
             .add_exit_system(GameState::MainMenu, stop_bgm)
             .add_exit_system(GameState::InGame, stop_bgm)
+            .add_system(set_volume)
             .add_system_set(
                 ConditionSet::new()
                     .run_in_state(GameState::InGame)
@@ -25,11 +27,14 @@ impl Plugin for AudioPlugin {
     }
 }
 
-/// Resource for the background music channel. Exists so in future a user may change BGM volume
-/// independently of SFX.
+/// Resource for the background music channel.
 #[derive(Resource)]
 struct BgmChannel;
 
+/// Resource for the sound effects channel.
+#[derive(Resource)]
+struct SfxChannel;
+
 /// Event for SFX.
 #[derive(Debug)]
 pub enum PlaySfx {
@@ -38,6 +43,18 @@ pub enum PlaySfx {
     BombFuse,
 }
 
+/// Update the channel volumes if the config has changed.
+fn set_volume(
+    bgm_channel: Res<AudioChannel<BgmChannel>>,
+    sfx_channel: Res<AudioChannel<SfxChannel>>,
+    config: Res<Config>,
+) {
+    if config.is_changed() {
+        bgm_channel.set_volume(config.bgm_volume);
+        sfx_channel.set_volume(config.sfx_volume);
+    }
+}
+
 fn start_title_bgm(audio: Res<AudioChannel<BgmChannel>>, bgm: Res<Bgm>) {
     audio.play(bgm.title_screen.clone()).looped();
 }
@@ -60,7 +77,7 @@ fn stop_bgm(audio: Res<AudioChannel<BgmChannel>>) {
 }
 
 fn play_sfx(
-    audio: Res<Audio>,
+    audio: Res<AudioChannel<SfxChannel>>,
     sfx: Res<Sfx>,
     mut rng: ResMut<GameRng>,
     mut ev_sfx: EventReader<PlaySfx>,
diff --git a/src/config.rs b/src/config.rs
new file mode 100644
index 0000000..071792c
--- /dev/null
+++ b/src/config.rs
@@ -0,0 +1,61 @@
+//! Load the settings file for the game. This will be under the config folder by OS convention, for
+//! example:
+//!
+//! Linux: `~/.config/bomby/config.toml`
+
+use bevy::prelude::*;
+
+use directories::ProjectDirs;
+use serde_derive::{Deserialize, Serialize};
+
+use std::fs;
+
+/// Config resource containing runtime settings for the game.
+#[derive(Resource, Debug, Serialize, Deserialize)]
+#[serde(default)]
+pub struct Config {
+    pub resizable_window: bool,
+    pub bgm_volume: f64,
+    pub sfx_volume: f64,
+}
+
+impl Default for Config {
+    fn default() -> Self {
+        Self {
+            resizable_window: true,
+            bgm_volume: 1.0,
+            sfx_volume: 1.0,
+        }
+    }
+}
+
+pub struct ConfigPlugin;
+
+impl Plugin for ConfigPlugin {
+    fn build(&self, app: &mut App) {
+        app.add_startup_system(log_config);
+    }
+}
+
+/// System to log the config on startup.
+fn log_config(config: Res<Config>) {
+    info!("{:?}", *config);
+}
+
+/// Load the [`Config`] or generate a new one.
+pub fn load_config() -> Config {
+    let dirs = ProjectDirs::from("com", "Spicy Lobster", "Bomby");
+    dirs.map(|dirs| {
+        let mut path = dirs.config_dir().to_path_buf();
+        path.push("config.toml");
+        let config_str = fs::read_to_string(&path).unwrap_or_else(|_| "".to_string());
+        toml::from_str(&config_str).unwrap_or_else(|e| {
+            warn!("failed to parse config file {path:?}: {e}");
+            Config::default()
+        })
+    })
+    .unwrap_or_else(|| {
+        warn!("failed to get config path");
+        Config::default()
+    })
+}
diff --git a/src/main.rs b/src/main.rs
index 528d408..424c51b 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -6,6 +6,7 @@ use rand::{rngs::SmallRng, SeedableRng};
 mod audio;
 mod bomb;
 mod camera;
+mod config;
 mod debug;
 mod ldtk;
 mod player;
@@ -27,6 +28,8 @@ pub enum GameState {
 pub struct GameRng(SmallRng);
 
 fn main() {
+    let config = config::load_config();
+
     App::new()
         .add_loopless_state(GameState::MainMenu)
         .add_plugins(
@@ -37,7 +40,7 @@ fn main() {
                         width: WINDOW_WIDTH,
                         height: WINDOW_HEIGHT,
                         title: "Bomby!".to_string(),
-                        resizable: false,
+                        resizable: config.resizable_window,
                         ..default()
                     },
                     ..default()
@@ -45,6 +48,7 @@ fn main() {
         )
         .add_plugin(bevy_kira_audio::AudioPlugin)
         .add_plugin(audio::AudioPlugin)
+        .add_plugin(config::ConfigPlugin)
         .add_plugin(debug::DebugPlugin)
         .add_plugin(player::PlayerPlugin)
         .add_plugin(ldtk::BombyLdtkPlugin)
@@ -53,5 +57,6 @@ fn main() {
         .add_plugin(ui::UiPlugin)
         .add_plugin(z_sort::ZSortPlugin)
         .insert_resource(GameRng(SmallRng::from_entropy()))
+        .insert_resource(config)
         .run();
 }

From 48c8caae86ed49e9303469cd21ee840030504770 Mon Sep 17 00:00:00 2001
From: Piturnah <peterhebden6@gmail.com>
Date: Mon, 2 Jan 2023 12:52:24 +0000
Subject: [PATCH 2/7] Log unexpected key and use systems

Uses only ECS systems now to tidy it up. Also will log a warning if
there is an unexpected key in the config file.
---
 Cargo.lock    | 10 +++++++++
 Cargo.toml    |  1 +
 src/config.rs | 60 ++++++++++++++++++++++++++++++++-------------------
 src/main.rs   | 16 ++++++++++----
 4 files changed, 61 insertions(+), 26 deletions(-)

diff --git a/Cargo.lock b/Cargo.lock
index fa2e44e..d69fb51 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -959,6 +959,7 @@ dependencies = [
  "rand 0.8.5",
  "serde",
  "serde_derive",
+ "serde_ignored",
  "toml",
 ]
 
@@ -2943,6 +2944,15 @@ dependencies = [
  "syn",
 ]
 
+[[package]]
+name = "serde_ignored"
+version = "0.1.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "51212eb6171778353d78ef5860fdffe29ac17f03a69375d2dc14fbb5754d54a4"
+dependencies = [
+ "serde",
+]
+
 [[package]]
 name = "serde_json"
 version = "1.0.85"
diff --git a/Cargo.toml b/Cargo.toml
index f8077a9..b9e8ce9 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -17,6 +17,7 @@ noise = { git = "https://github.com/bsurmanski/noise-rs", rev = "5abdde1b819eccc
 rand = { version = "0.8", default_features = false, features = ["std", "small_rng"] }
 serde = "1.0"
 serde_derive = "1.0"
+serde_ignored = "0.1.6"
 toml = "0.5"
 
 [dependencies.bevy]
diff --git a/src/config.rs b/src/config.rs
index 071792c..bee3d4d 100644
--- a/src/config.rs
+++ b/src/config.rs
@@ -14,7 +14,9 @@ use std::fs;
 #[derive(Resource, Debug, Serialize, Deserialize)]
 #[serde(default)]
 pub struct Config {
-    pub resizable_window: bool,
+    pub window_resizable: bool,
+    pub window_width: f32,
+    pub window_height: f32,
     pub bgm_volume: f64,
     pub sfx_volume: f64,
 }
@@ -22,7 +24,9 @@ pub struct Config {
 impl Default for Config {
     fn default() -> Self {
         Self {
-            resizable_window: true,
+            window_resizable: true,
+            window_width: 1600.0,
+            window_height: 900.0,
             bgm_volume: 1.0,
             sfx_volume: 1.0,
         }
@@ -33,29 +37,41 @@ pub struct ConfigPlugin;
 
 impl Plugin for ConfigPlugin {
     fn build(&self, app: &mut App) {
-        app.add_startup_system(log_config);
+        app.add_startup_system(load_config);
     }
 }
 
-/// System to log the config on startup.
-fn log_config(config: Res<Config>) {
-    info!("{:?}", *config);
-}
-
-/// Load the [`Config`] or generate a new one.
-pub fn load_config() -> Config {
+/// Load the [`Config`] or generate a new one and insert it as a resource.
+fn load_config(mut commands: Commands) {
     let dirs = ProjectDirs::from("com", "Spicy Lobster", "Bomby");
-    dirs.map(|dirs| {
-        let mut path = dirs.config_dir().to_path_buf();
-        path.push("config.toml");
-        let config_str = fs::read_to_string(&path).unwrap_or_else(|_| "".to_string());
-        toml::from_str(&config_str).unwrap_or_else(|e| {
-            warn!("failed to parse config file {path:?}: {e}");
-            Config::default()
+    let mut config = dirs
+        .map(|dirs| {
+            let mut path = dirs.config_dir().to_path_buf();
+            path.push("config.toml");
+            let config_str = fs::read_to_string(&path).unwrap_or_else(|_| "".to_string());
+            let mut de = toml::de::Deserializer::new(&config_str);
+            let mut unused_keys = Vec::new();
+            let config =
+                serde_ignored::deserialize(&mut de, |path| unused_keys.push(path.to_string()))
+                    .unwrap_or_else(|e| {
+                        warn!("failed to parse config file {path:?}: {e}");
+                        Config::default()
+                    });
+
+            for key in unused_keys {
+                warn!("unrecognised config setting: {key}");
+            }
+            config
         })
-    })
-    .unwrap_or_else(|| {
-        warn!("failed to get config path");
-        Config::default()
-    })
+        .unwrap_or_else(|| {
+            warn!("failed to get config path");
+            Config::default()
+        });
+
+    // Ensure sensible bounds.
+    config.bgm_volume = config.bgm_volume.clamp(0.0, 1.0);
+    config.sfx_volume = config.sfx_volume.clamp(0.0, 1.0);
+
+    info!("{config:?}");
+    commands.insert_resource(config);
 }
diff --git a/src/main.rs b/src/main.rs
index 424c51b..8b3c05a 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -28,8 +28,6 @@ pub enum GameState {
 pub struct GameRng(SmallRng);
 
 fn main() {
-    let config = config::load_config();
-
     App::new()
         .add_loopless_state(GameState::MainMenu)
         .add_plugins(
@@ -40,7 +38,7 @@ fn main() {
                         width: WINDOW_WIDTH,
                         height: WINDOW_HEIGHT,
                         title: "Bomby!".to_string(),
-                        resizable: config.resizable_window,
+                        resizable: true,
                         ..default()
                     },
                     ..default()
@@ -57,6 +55,16 @@ fn main() {
         .add_plugin(ui::UiPlugin)
         .add_plugin(z_sort::ZSortPlugin)
         .insert_resource(GameRng(SmallRng::from_entropy()))
-        .insert_resource(config)
+        .add_system(set_window_resizable)
         .run();
 }
+
+/// System that detects if the [`Config`](config::Config) was changed and accordingly updates the
+/// window descriptor.
+fn set_window_resizable(config: Res<config::Config>, mut windows: ResMut<Windows>) {
+    if config.is_changed() {
+        let window = windows.primary_mut();
+        window.set_resolution(config.window_width, config.window_height);
+        window.set_resizable(config.window_resizable);
+    }
+}

From 5fd63e0ee924a9a54b3b84a7dedee95c6e69c8be Mon Sep 17 00:00:00 2001
From: Piturnah <peterhebden6@gmail.com>
Date: Mon, 2 Jan 2023 13:19:18 +0000
Subject: [PATCH 3/7] Add clippy lints

Add `semicolon_if_nothing_returned` and `uninlined_format_args` for more
consistent code style
---
 src/bomb.rs   | 15 ++++++++-------
 src/ldtk.rs   |  2 +-
 src/main.rs   |  2 ++
 src/player.rs | 19 ++++++++++---------
 src/ui.rs     |  2 +-
 5 files changed, 22 insertions(+), 18 deletions(-)

diff --git a/src/bomb.rs b/src/bomb.rs
index aaf7b70..16c0d89 100644
--- a/src/bomb.rs
+++ b/src/bomb.rs
@@ -131,12 +131,13 @@ fn update_bombs(
 
             // Destroy bombable tiles within 1 orthogonal tile
             for tile in affected_tiles.iter().filter(|(_, parent, coords)| {
-                if let Ok(ldtk_layer) = ldtk_layer_meta_q.get(***parent) {
-                    ldtk_layer.identifier == "Bombable"
-                } else {
-                    warn!("LDtk tile not child of a layer with coords: {:?}", coords);
-                    false
-                }
+                ldtk_layer_meta_q.get(***parent).map_or_else(
+                    |_| {
+                        warn!("LDtk tile not child of a layer with coords: {coords:?}");
+                        false
+                    },
+                    |ldtk_layer| ldtk_layer.identifier == "Bombable",
+                )
             }) {
                 commands.entity(tile.0).despawn_recursive();
             }
@@ -165,7 +166,7 @@ fn animate_bombs(mut bombs: Query<(&Bomb, &mut Transform)>) {
             + (Vec2::ONE
                 * 0.1
                 * ((16.0 * std::f32::consts::PI / 6.0) * bomb.timer.elapsed_secs()).sin())
-            .extend(1.0)
+            .extend(1.0);
     }
 }
 
diff --git a/src/ldtk.rs b/src/ldtk.rs
index 3c3ce72..097c71e 100644
--- a/src/ldtk.rs
+++ b/src/ldtk.rs
@@ -76,7 +76,7 @@ where
     }
 }
 
-/// Detect if there is a `Spawned` event from bevy_ecs_ldtk, indicating that the level has spawned.
+/// Detect if there is a `Spawned` event from [`bevy_ecs_ldtk`], indicating that the level has spawned.
 /// This means we can rely on entities existing such as the player spawn points.
 pub fn level_spawned(mut level_events: EventReader<LevelEvent>) -> bool {
     level_events
diff --git a/src/main.rs b/src/main.rs
index 8b3c05a..8e872de 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -1,3 +1,5 @@
+#![warn(clippy::semicolon_if_nothing_returned, clippy::uninlined_format_args)]
+
 use bevy::prelude::*;
 use iyes_loopless::prelude::*;
 
diff --git a/src/player.rs b/src/player.rs
index 44fbbd0..f346f45 100644
--- a/src/player.rs
+++ b/src/player.rs
@@ -74,7 +74,7 @@ fn spawn_players(
             .filter(|(_, ldtk_entity)| ldtk_entity.identifier == player_name)
             .map(|(transform, _)| transform.translation.truncate())
             .next()
-            .unwrap_or_else(|| panic!("no spawn point found for player: {}", player_name))
+            .unwrap_or_else(|| panic!("no spawn point found for player: {player_name}"))
             + Vec2::Y * -8.0;
 
         commands.spawn((
@@ -84,7 +84,7 @@ fn spawn_players(
                 texture_atlas: textures
                     .0
                     .get(i)
-                    .unwrap_or_else(|| panic!("no sprite sheet for player: {}", player_name))
+                    .unwrap_or_else(|| panic!("no sprite sheet for player: {player_name}"))
                     .clone(),
                 sprite: TextureAtlasSprite {
                     index: 0,
@@ -137,7 +137,7 @@ fn spawn_players(
                         .insert(GamepadButtonType::East, PlayerAction::Bomb)
                         .set_gamepad(Gamepad { id: 1 })
                         .build(),
-                    _ => panic!("no input map for player: {}", player_name),
+                    _ => panic!("no input map for player: {player_name}"),
                 },
                 ..default()
             },
@@ -216,12 +216,13 @@ fn player_collisions(
         .iter()
         .filter(|(parent, coords)| {
             bomb_tiles.iter().any(|b| b == *coords)
-                || if let Ok(ldtk_layer) = ldtk_layer_meta_q.get(***parent) {
-                    matches!(ldtk_layer.identifier.as_str(), "Maze" | "Bombable")
-                } else {
-                    warn!("LDtk tile not child of a layer with coords: {:?}", coords);
-                    false
-                }
+                || ldtk_layer_meta_q.get(***parent).map_or_else(
+                    |_| {
+                        warn!("LDtk tile not child of a layer with coords: {coords:?}");
+                        false
+                    },
+                    |ldtk_layer| matches!(ldtk_layer.identifier.as_str(), "Maze" | "Bombable"),
+                )
         })
         .map(|(_, coords)| coords)
         .collect::<Vec<_>>();
diff --git a/src/ui.rs b/src/ui.rs
index 3009f74..309d37f 100644
--- a/src/ui.rs
+++ b/src/ui.rs
@@ -140,7 +140,7 @@ fn load_graphics(
     commands.insert_resource(ButtonNinePatch {
         texture: button_ninepatch_texture,
         ninepatch: button_ninepatch_handle,
-    })
+    });
 }
 
 #[derive(Resource)]

From 7a1a48d091365d076fbda7375f122b90233319d4 Mon Sep 17 00:00:00 2001
From: Peter Hebden <peterhebden6@gmail.com>
Date: Wed, 4 Jan 2023 14:15:15 +0000
Subject: [PATCH 4/7] Update README.md

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 919130d..488cde6 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,7 @@ Anyone involved in the Fish Folk community must follow our [code of conduct](htt
 Before committing and opening a PR, please run the following commands and follow their instructions:
 
 ```console
-$ cargo clippy -D warnings
+$ cargo clippy
 $ cargo fmt
 ```
 

From ec78e60338d96fcd92b74b839435a8dfe0851d8d Mon Sep 17 00:00:00 2001
From: Peter Hebden <peterhebden6@gmail.com>
Date: Sat, 9 Sep 2023 23:30:34 +0100
Subject: [PATCH 5/7] Add `shell.nix`

---
 shell.nix | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 shell.nix

diff --git a/shell.nix b/shell.nix
new file mode 100644
index 0000000..943656c
--- /dev/null
+++ b/shell.nix
@@ -0,0 +1,15 @@
+{ pkgs ? import <nixpkgs> { } }:
+
+with pkgs;
+
+mkShell rec {
+  nativeBuildInputs = [
+    pkg-config
+  ];
+  buildInputs = [
+    udev alsa-lib vulkan-loader
+    xorg.libX11 xorg.libXcursor xorg.libXi xorg.libXrandr # To use the x11 feature
+    libxkbcommon wayland # To use the wayland feature
+  ];
+  LD_LIBRARY_PATH = lib.makeLibraryPath buildInputs;
+}

From b189e0329e542470bda265cbc063ce5f0eb9f093 Mon Sep 17 00:00:00 2001
From: Peter Hebden <peterhebden6@gmail.com>
Date: Wed, 8 Jan 2025 00:08:32 +0000
Subject: [PATCH 6/7] Add instructions and feature for wayland

---
 Cargo.lock | 206 ++++++++++++++++++++++++++++++++++++++++++++++-------
 Cargo.toml |   7 +-
 README.md  |  16 +++++
 3 files changed, 201 insertions(+), 28 deletions(-)

diff --git a/Cargo.lock b/Cargo.lock
index d69fb51..454e4c1 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -1007,6 +1007,20 @@ version = "1.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "c1db59621ec70f09c5e9b597b220c7a2b43611f4710dc03ceb8748637775692c"
 
+[[package]]
+name = "calloop"
+version = "0.10.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "52e0d00eb1ea24371a97d2da6201c6747a633dc6dc1988ef503403b4c59504a8"
+dependencies = [
+ "bitflags",
+ "log",
+ "nix 0.25.0",
+ "slotmap",
+ "thiserror",
+ "vec_map",
+]
+
 [[package]]
 name = "cc"
 version = "1.0.73"
@@ -1367,6 +1381,15 @@ version = "0.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "bd0c93bb4b0c6d9b77f4435b0ae98c24d17f1c45b2ff844c6151a07256ca923b"
 
+[[package]]
+name = "dlib"
+version = "0.5.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "330c60081dcc4c72131f8eb70510f1ac07223e5d4163db481a04a0befcffa412"
+dependencies = [
+ "libloading",
+]
+
 [[package]]
 name = "downcast-rs"
 version = "1.2.0"
@@ -2108,6 +2131,15 @@ version = "2.5.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "2dffe52ecf27772e601905b7522cb4ef790d2cc203488bbd0e2fe85fcb74566d"
 
+[[package]]
+name = "memmap2"
+version = "0.5.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "83faa42c0a078c393f6b29d5db232d8be22776a891f8f56e5284faee4a20b327"
+dependencies = [
+ "libc",
+]
+
 [[package]]
 name = "memoffset"
 version = "0.6.5"
@@ -2176,14 +2208,14 @@ dependencies = [
 
 [[package]]
 name = "mio"
-version = "0.8.5"
+version = "0.8.8"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e5d732bc30207a6423068df043e3d02e0735b155ad7ce1a6f76fe2baa5b158de"
+checksum = "927a765cd3fc26206e66b296465fa9d3e5ab003e651c1b3c060e7956d96b19d2"
 dependencies = [
  "libc",
  "log",
  "wasi 0.11.0+wasi-snapshot-preview1",
- "windows-sys 0.42.0",
+ "windows-sys 0.48.0",
 ]
 
 [[package]]
@@ -2324,6 +2356,7 @@ dependencies = [
  "bitflags",
  "cfg-if",
  "libc",
+ "memoffset",
 ]
 
 [[package]]
@@ -2903,6 +2936,12 @@ dependencies = [
  "winapi-util",
 ]
 
+[[package]]
+name = "scoped-tls"
+version = "1.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e1cf6437eb19a8f4a6cc0f7dca544973b0b78843adbfeb3683d1a94a0024a294"
+
 [[package]]
 name = "scopeguard"
 version = "1.1.0"
@@ -3021,6 +3060,25 @@ dependencies = [
  "serde",
 ]
 
+[[package]]
+name = "smithay-client-toolkit"
+version = "0.16.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "870427e30b8f2cbe64bf43ec4b86e88fe39b0a84b3f15efd9c9c2d020bc86eb9"
+dependencies = [
+ "bitflags",
+ "calloop",
+ "dlib",
+ "lazy_static",
+ "log",
+ "memmap2",
+ "nix 0.24.2",
+ "pkg-config",
+ "wayland-client",
+ "wayland-cursor",
+ "wayland-protocols",
+]
+
 [[package]]
 name = "spirv"
 version = "0.2.0+1.5.4"
@@ -3548,6 +3606,78 @@ version = "0.2.83"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "1c38c045535d93ec4f0b4defec448e4291638ee608530863b1e2ba115d4fff7f"
 
+[[package]]
+name = "wayland-client"
+version = "0.29.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3f3b068c05a039c9f755f881dc50f01732214f5685e379829759088967c46715"
+dependencies = [
+ "bitflags",
+ "downcast-rs",
+ "libc",
+ "nix 0.24.2",
+ "scoped-tls",
+ "wayland-commons",
+ "wayland-scanner",
+ "wayland-sys",
+]
+
+[[package]]
+name = "wayland-commons"
+version = "0.29.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8691f134d584a33a6606d9d717b95c4fa20065605f798a3f350d78dced02a902"
+dependencies = [
+ "nix 0.24.2",
+ "once_cell",
+ "smallvec",
+ "wayland-sys",
+]
+
+[[package]]
+name = "wayland-cursor"
+version = "0.29.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6865c6b66f13d6257bef1cd40cbfe8ef2f150fb8ebbdb1e8e873455931377661"
+dependencies = [
+ "nix 0.24.2",
+ "wayland-client",
+ "xcursor",
+]
+
+[[package]]
+name = "wayland-protocols"
+version = "0.29.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b950621f9354b322ee817a23474e479b34be96c2e909c14f7bc0100e9a970bc6"
+dependencies = [
+ "bitflags",
+ "wayland-client",
+ "wayland-commons",
+ "wayland-scanner",
+]
+
+[[package]]
+name = "wayland-scanner"
+version = "0.29.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8f4303d8fa22ab852f789e75a967f0a2cdc430a607751c0499bada3e451cbd53"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "xml-rs",
+]
+
+[[package]]
+name = "wayland-sys"
+version = "0.29.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "be12ce1a3c39ec7dba25594b97b42cb3195d54953ddb9d3d95a7c3902bc6e9d4"
+dependencies = [
+ "dlib",
+ "pkg-config",
+]
+
 [[package]]
 name = "web-sys"
 version = "0.3.60"
@@ -3748,24 +3878,33 @@ dependencies = [
 
 [[package]]
 name = "windows-sys"
-version = "0.42.0"
+version = "0.48.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5a3e1820f08b8513f676f7ab6c1f99ff312fb97b553d30ff4dd86f9f15728aa7"
+checksum = "677d2418bec65e3338edb076e806bc1ec15693c5d0104683f2efe857f61056a9"
+dependencies = [
+ "windows-targets",
+]
+
+[[package]]
+name = "windows-targets"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9a2fa6e2155d7247be68c096456083145c183cbbbc2764150dda45a87197940c"
 dependencies = [
  "windows_aarch64_gnullvm",
- "windows_aarch64_msvc 0.42.0",
- "windows_i686_gnu 0.42.0",
- "windows_i686_msvc 0.42.0",
- "windows_x86_64_gnu 0.42.0",
+ "windows_aarch64_msvc 0.48.5",
+ "windows_i686_gnu 0.48.5",
+ "windows_i686_msvc 0.48.5",
+ "windows_x86_64_gnu 0.48.5",
  "windows_x86_64_gnullvm",
- "windows_x86_64_msvc 0.42.0",
+ "windows_x86_64_msvc 0.48.5",
 ]
 
 [[package]]
 name = "windows_aarch64_gnullvm"
-version = "0.42.0"
+version = "0.48.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "41d2aa71f6f0cbe00ae5167d90ef3cfe66527d6f613ca78ac8024c3ccab9a19e"
+checksum = "2b38e32f0abccf9987a4e3079dfb67dcd799fb61361e53e2882c3cbaf0d905d8"
 
 [[package]]
 name = "windows_aarch64_msvc"
@@ -3781,9 +3920,9 @@ checksum = "2623277cb2d1c216ba3b578c0f3cf9cdebeddb6e66b1b218bb33596ea7769c3a"
 
 [[package]]
 name = "windows_aarch64_msvc"
-version = "0.42.0"
+version = "0.48.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "dd0f252f5a35cac83d6311b2e795981f5ee6e67eb1f9a7f64eb4500fbc4dcdb4"
+checksum = "dc35310971f3b2dbbf3f0690a219f40e2d9afcf64f9ab7cc1be722937c26b4bc"
 
 [[package]]
 name = "windows_i686_gnu"
@@ -3799,9 +3938,9 @@ checksum = "d3925fd0b0b804730d44d4b6278c50f9699703ec49bcd628020f46f4ba07d9e1"
 
 [[package]]
 name = "windows_i686_gnu"
-version = "0.42.0"
+version = "0.48.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "fbeae19f6716841636c28d695375df17562ca208b2b7d0dc47635a50ae6c5de7"
+checksum = "a75915e7def60c94dcef72200b9a8e58e5091744960da64ec734a6c6e9b3743e"
 
 [[package]]
 name = "windows_i686_msvc"
@@ -3817,9 +3956,9 @@ checksum = "ce907ac74fe331b524c1298683efbf598bb031bc84d5e274db2083696d07c57c"
 
 [[package]]
 name = "windows_i686_msvc"
-version = "0.42.0"
+version = "0.48.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "84c12f65daa39dd2babe6e442988fc329d6243fdce47d7d2d155b8d874862246"
+checksum = "8f55c233f70c4b27f66c523580f78f1004e8b5a8b659e05a4eb49d4166cca406"
 
 [[package]]
 name = "windows_x86_64_gnu"
@@ -3835,15 +3974,15 @@ checksum = "2babfba0828f2e6b32457d5341427dcbb577ceef556273229959ac23a10af33d"
 
 [[package]]
 name = "windows_x86_64_gnu"
-version = "0.42.0"
+version = "0.48.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bf7b1b21b5362cbc318f686150e5bcea75ecedc74dd157d874d754a2ca44b0ed"
+checksum = "53d40abd2583d23e4718fddf1ebec84dbff8381c07cae67ff7768bbf19c6718e"
 
 [[package]]
 name = "windows_x86_64_gnullvm"
-version = "0.42.0"
+version = "0.48.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "09d525d2ba30eeb3297665bd434a54297e4170c7f1a44cad4ef58095b4cd2028"
+checksum = "0b7b52767868a23d5bab768e390dc5f5c55825b6d30b86c844ff2dc7414044cc"
 
 [[package]]
 name = "windows_x86_64_msvc"
@@ -3859,9 +3998,9 @@ checksum = "f4dd6dc7df2d84cf7b33822ed5b86318fb1781948e9663bacd047fc9dd52259d"
 
 [[package]]
 name = "windows_x86_64_msvc"
-version = "0.42.0"
+version = "0.48.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f40009d85759725a34da6d89a94e63d7bdc50a862acf0dbc7c8e488f1edcb6f5"
+checksum = "ed94fce61571a4006852b7389a063ab983c02eb1bb37b47f8272ce92d06d9538"
 
 [[package]]
 name = "winit"
@@ -3886,7 +4025,10 @@ dependencies = [
  "percent-encoding",
  "raw-window-handle 0.4.3",
  "raw-window-handle 0.5.0",
+ "smithay-client-toolkit",
  "wasm-bindgen",
+ "wayland-client",
+ "wayland-protocols",
  "web-sys",
  "windows-sys 0.36.1",
  "x11-dl",
@@ -3894,9 +4036,9 @@ dependencies = [
 
 [[package]]
 name = "x11-dl"
-version = "2.20.0"
+version = "2.20.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0c83627bc137605acc00bb399c7b908ef460b621fc37c953db2b09f88c449ea6"
+checksum = "b1536d6965a5d4e573c7ef73a2c15ebcd0b2de3347bdf526c34c297c00ac40f0"
 dependencies = [
  "lazy_static",
  "libc",
@@ -3915,8 +4057,20 @@ dependencies = [
  "winapi-wsapoll",
 ]
 
+[[package]]
+name = "xcursor"
+version = "0.3.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0ef33da6b1660b4ddbfb3aef0ade110c8b8a781a3b6382fa5f2b5b040fd55f61"
+
 [[package]]
 name = "xi-unicode"
 version = "0.3.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "a67300977d3dc3f8034dae89778f502b6ba20b269527b3223ba59c0cf393bb8a"
+
+[[package]]
+name = "xml-rs"
+version = "0.8.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "af4e2e2f7cba5a093896c1e150fbfe177d1883e7448200efb81d40b9d339ef26"
diff --git a/Cargo.toml b/Cargo.toml
index b9e8ce9..30913a3 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -23,10 +23,13 @@ toml = "0.5"
 [dependencies.bevy]
 version = "0.9"
 default_features = false
-features = [ "png", "x11" ]
+features = ["png"]
 
 [features]
+default = ["x11"]
 dev = ["bevy/dynamic"]
- 
+x11 = ["bevy/x11"]
+wayland = ["bevy/wayland"]
+
 [profile.dev.package."*"]
 opt-level = 3
diff --git a/README.md b/README.md
index 488cde6..33a108f 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,22 @@ This game is part of the [Fish Folk](https://spicylobster.itch.io/jumpy/devlog/4
 - [Folly](https://github.com/fishfolks/folly)
 - [Ballsy](https://github.com/fishfolks/ballsy)
 
+## Getting Started
+
+The easiest way to build and run *Bomby* is by using Cargo. The easiest way to set cargo up is by using [rustup](https://rustup.rs/).
+
+Then, you can run the game with
+
+```console
+$ cargo run --release
+```
+
+If you are using wayland, you can use
+
+```console
+$ cargo run --release --no-default-features --features wayland
+```
+
 ## Contributing
 
 Anyone involved in the Fish Folk community must follow our [code of conduct](https://github.com/fishfolks/jumpy/blob/main/CODE_OF_CONDUCT.md).

From 30b665f9dd8d4a43e3755153af7aea51e4980fcf Mon Sep 17 00:00:00 2001
From: Peter Hebden <peterhebden6@gmail.com>
Date: Wed, 8 Jan 2025 17:26:59 +0000
Subject: [PATCH 7/7] Remove config plugin

We don't need to pretend that we can change the config while the game is
running (yet).
---
 src/audio.rs  | 10 ++++------
 src/config.rs | 24 +++++++++++-------------
 src/main.rs   | 26 +++++++-------------------
 3 files changed, 22 insertions(+), 38 deletions(-)

diff --git a/src/audio.rs b/src/audio.rs
index 051e38c..9d1860e 100644
--- a/src/audio.rs
+++ b/src/audio.rs
@@ -13,11 +13,11 @@ impl Plugin for AudioPlugin {
             .add_audio_channel::<BgmChannel>()
             .add_audio_channel::<SfxChannel>()
             .add_startup_system(load_audio)
+            .add_startup_system(set_volume)
             .add_enter_system(GameState::MainMenu, start_title_bgm)
             .add_enter_system(GameState::InGame, start_fight_bgm)
             .add_exit_system(GameState::MainMenu, stop_bgm)
             .add_exit_system(GameState::InGame, stop_bgm)
-            .add_system(set_volume)
             .add_system_set(
                 ConditionSet::new()
                     .run_in_state(GameState::InGame)
@@ -43,16 +43,14 @@ pub enum PlaySfx {
     BombFuse,
 }
 
-/// Update the channel volumes if the config has changed.
+/// Update the channel volumes based on values in the [`Config`] resource.
 fn set_volume(
     bgm_channel: Res<AudioChannel<BgmChannel>>,
     sfx_channel: Res<AudioChannel<SfxChannel>>,
     config: Res<Config>,
 ) {
-    if config.is_changed() {
-        bgm_channel.set_volume(config.bgm_volume);
-        sfx_channel.set_volume(config.sfx_volume);
-    }
+    bgm_channel.set_volume(config.bgm_volume);
+    sfx_channel.set_volume(config.sfx_volume);
 }
 
 fn start_title_bgm(audio: Res<AudioChannel<BgmChannel>>, bgm: Res<Bgm>) {
diff --git a/src/config.rs b/src/config.rs
index bee3d4d..fb3d9f7 100644
--- a/src/config.rs
+++ b/src/config.rs
@@ -2,6 +2,9 @@
 //! example:
 //!
 //! Linux: `~/.config/bomby/config.toml`
+//!
+//! Currently, the config is loaded at startup and cannot be changed from inside the game. So, this
+//! module does not export a bevy plugin (yet).
 
 use bevy::prelude::*;
 
@@ -10,6 +13,10 @@ use serde_derive::{Deserialize, Serialize};
 
 use std::fs;
 
+const DEFAULT_ASPECT_RATIO: f32 = 16.0 / 9.0;
+const DEFAULT_WINDOW_HEIGHT: f32 = 900.0;
+const DEFAULT_WINDOW_WIDTH: f32 = DEFAULT_WINDOW_HEIGHT * DEFAULT_ASPECT_RATIO;
+
 /// Config resource containing runtime settings for the game.
 #[derive(Resource, Debug, Serialize, Deserialize)]
 #[serde(default)]
@@ -25,24 +32,16 @@ impl Default for Config {
     fn default() -> Self {
         Self {
             window_resizable: true,
-            window_width: 1600.0,
-            window_height: 900.0,
+            window_width: DEFAULT_WINDOW_WIDTH,
+            window_height: DEFAULT_WINDOW_HEIGHT,
             bgm_volume: 1.0,
             sfx_volume: 1.0,
         }
     }
 }
 
-pub struct ConfigPlugin;
-
-impl Plugin for ConfigPlugin {
-    fn build(&self, app: &mut App) {
-        app.add_startup_system(load_config);
-    }
-}
-
 /// Load the [`Config`] or generate a new one and insert it as a resource.
-fn load_config(mut commands: Commands) {
+pub fn load_config() -> Config {
     let dirs = ProjectDirs::from("com", "Spicy Lobster", "Bomby");
     let mut config = dirs
         .map(|dirs| {
@@ -72,6 +71,5 @@ fn load_config(mut commands: Commands) {
     config.bgm_volume = config.bgm_volume.clamp(0.0, 1.0);
     config.sfx_volume = config.sfx_volume.clamp(0.0, 1.0);
 
-    info!("{config:?}");
-    commands.insert_resource(config);
+    config
 }
diff --git a/src/main.rs b/src/main.rs
index 8e872de..99921e8 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -15,10 +15,6 @@ mod player;
 mod ui;
 mod z_sort;
 
-const RESOLUTION: f32 = 16.0 / 9.0;
-const WINDOW_HEIGHT: f32 = 900.0;
-const WINDOW_WIDTH: f32 = WINDOW_HEIGHT * RESOLUTION;
-
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 pub enum GameState {
     MainMenu,
@@ -30,6 +26,9 @@ pub enum GameState {
 pub struct GameRng(SmallRng);
 
 fn main() {
+    let config = config::load_config();
+    info!("Initialised config: {config:?}");
+
     App::new()
         .add_loopless_state(GameState::MainMenu)
         .add_plugins(
@@ -37,18 +36,18 @@ fn main() {
                 .set(ImagePlugin::default_nearest())
                 .set(WindowPlugin {
                     window: WindowDescriptor {
-                        width: WINDOW_WIDTH,
-                        height: WINDOW_HEIGHT,
+                        width: config.window_width,
+                        height: config.window_height,
                         title: "Bomby!".to_string(),
-                        resizable: true,
+                        resizable: config.window_resizable,
                         ..default()
                     },
                     ..default()
                 }),
         )
+        .insert_resource(config)
         .add_plugin(bevy_kira_audio::AudioPlugin)
         .add_plugin(audio::AudioPlugin)
-        .add_plugin(config::ConfigPlugin)
         .add_plugin(debug::DebugPlugin)
         .add_plugin(player::PlayerPlugin)
         .add_plugin(ldtk::BombyLdtkPlugin)
@@ -57,16 +56,5 @@ fn main() {
         .add_plugin(ui::UiPlugin)
         .add_plugin(z_sort::ZSortPlugin)
         .insert_resource(GameRng(SmallRng::from_entropy()))
-        .add_system(set_window_resizable)
         .run();
 }
-
-/// System that detects if the [`Config`](config::Config) was changed and accordingly updates the
-/// window descriptor.
-fn set_window_resizable(config: Res<config::Config>, mut windows: ResMut<Windows>) {
-    if config.is_changed() {
-        let window = windows.primary_mut();
-        window.set_resolution(config.window_width, config.window_height);
-        window.set_resizable(config.window_resizable);
-    }
-}