Bloom Options using Database

assets/data/backgrounds.ron

@@ -4,7 +4,7 @@
     star_position_x_range: ( start: -90.0, end: -30.0),
     star_position_z_range: (start: -250.0, end: -150.0),
     planet_translation: (8.0, -8.0, 30.0),
-    star_color_range: (start: 0.0, end: 15.0),
+    star_color_range: (start: 0.0, end: 1.0),
     background_quad_width: 375.0,
     background_quad_height: 375.0,
     background_alpha: 0.06,

crates/thetawave_interface/src/game/mod.rs

@@ -4,3 +4,4 @@
 
 /// Resources/singletons with the within-game/run counts/metrics.
 pub mod historical_metrics;
+pub mod options;

crates/thetawave_interface/src/game/options.rs

@@ -0,0 +1,12 @@
+use bevy_ecs::system::Resource;
+use serde::Deserialize;
+
+pub const DEFAULT_OPTIONS_PROFILE_ID: usize = 0;
+
+/// The 'model' of the Options Sqlite table.
+/// Defaults the least graphically intense options.
+#[derive(Debug, Default, Clone, Deserialize, Resource)]
+pub struct GameOptions {
+    pub bloom_enabled: bool,
+    pub bloom_intensity: f32,
+}

crates/thetawave_storage/src/core.rs

@@ -1,15 +1,17 @@
-use bevy::prelude::info;
+use bevy::log::info;
 use directories::ProjectDirs;
-use rusqlite;
 use rusqlite::Connection;
+use rusqlite::{self, OptionalExtension};
 use std::env::var_os;
 use std::ffi::OsStr;
 use std::path::PathBuf;
+use thetawave_interface::game::options::DEFAULT_OPTIONS_PROFILE_ID;
 use thiserror::Error;
 pub(super) const THETAWAVE_DB_PATH_ENVVAR: &'static str = "THETAWAVE_DB_PATH";
 const THETAWAVE_DB_FILE: &'static str = "thetawave.sqlite";
 pub(super) const USERSTAT: &'static str = "UserStat";
 pub(super) const ENEMY_KILL_HISTORY_TABLE_NAME: &'static str = "EnemiesKilled";
+pub(super) const OPTIONS_TABLE_NAME: &'static str = "Options";
 
 #[derive(Error, Debug, derive_more::From)]
 pub(super) enum OurDBError {
@@ -56,9 +58,26 @@ pub(super) fn setup_db(conn: Connection) -> rusqlite::Result<()> {
         PRIMARY KEY (userId, enemyMobType)
     )"
     );
+
+    let create_options_table_sql = format!(
+        "CREATE TABLE IF NOT EXISTS {OPTIONS_TABLE_NAME} (
+        optionsProfileId INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,
+        bloomEnabled BOOLEAN NOT NULL DEFAULT TRUE,
+        bloomIntensity REAL NOT NULL DEFAULT 1.0
+    )"
+    );
+
     conn.execute(&create_user_stats_sql, []).map(|_| ())?;
     conn.execute(&create_enemies_killed_table_sql, [])
         .map(|_| ())?;
+    conn.execute(&create_options_table_sql, []).map(|_| ())?;
+
+    // insert a default options row if it is not in the db
+    let upsert_default_gameops_sql =
+        format!("INSERT OR REPLACE INTO {OPTIONS_TABLE_NAME} (optionsProfileId) VALUES (?1)");
+    conn.execute(&upsert_default_gameops_sql, [DEFAULT_OPTIONS_PROFILE_ID])
+        .map(|_| ())?;
+
     info!("Created sqlite db");
     Ok(())
 }

crates/thetawave_storage/src/lib.rs

@@ -2,5 +2,6 @@
 /// thetawave releases. There are public functions to read data (exposing as few db implementation details as possible),
 /// while all upserts/mutations/deletions are handled via a Bevy plugin.
 pub mod core;
+pub mod options;
 pub mod plugin;
 pub mod user_stats;

crates/thetawave_storage/src/options.rs

@@ -0,0 +1,37 @@
+use crate::core::{get_db, OurDBError, OPTIONS_TABLE_NAME};
+use bevy::log::error;
+use rusqlite::Result;
+
+use thetawave_interface::game::options::GameOptions;
+
+fn _get_game_options(options_profile_id: usize) -> Result<Option<GameOptions>, OurDBError> {
+    let conn = get_db()?;
+    let stmt_raw = format!(
+        "
+    SELECT bloomEnabled, bloomIntensity FROM {OPTIONS_TABLE_NAME}
+    WHERE optionsProfileId=?1
+        "
+    );
+    let mut stmt = conn.prepare(&stmt_raw)?;
+    let mut rows = stmt.query([options_profile_id])?;
+    match rows.next()? {
+        Some(r) => {
+            let bloom_enabled = r.get(0)?;
+            let bloom_intensity = r.get(1)?;
+            Ok(Some(GameOptions {
+                bloom_enabled,
+                bloom_intensity,
+            }))
+        }
+
+        None => Ok(None),
+    }
+}
+
+/// Returns all of the options in the game.
+pub fn get_game_options(options_profile_id: usize) -> Option<GameOptions> {
+    _get_game_options(options_profile_id).unwrap_or_else(|err| {
+        error!("Could not read game options. {}", &err);
+        None
+    })
+}

crates/thetawave_storage/src/plugin.rs

@@ -1,6 +1,8 @@
 /// Exposes a single Plugin that links the game and our persistence layer.
 use bevy::prelude::*;
+use thetawave_interface::game::options::{GameOptions, DEFAULT_OPTIONS_PROFILE_ID};
 
+use crate::options::get_game_options;
 use crate::user_stats::{
     get_mob_killed_counts_for_user, get_user_stats, set_user_stats_for_user_id,
 };
@@ -47,7 +49,11 @@ impl Plugin for DBPlugin {
         app.add_systems(OnEnter(states::AppStates::LoadingAssets), db_setup_system);
         app.add_systems(
             OnExit(states::AppStates::LoadingAssets),
-            (load_user_stats_cache_from_db, load_mob_kills_cache_from_db),
+            (
+                load_user_stats_cache_from_db,
+                load_mob_kills_cache_from_db,
+                load_game_options_from_db,
+            ),
         );
         app.add_systems(
             OnExit(states::AppStates::GameOver),
@@ -58,6 +64,13 @@ impl Plugin for DBPlugin {
         );
     }
 }
+
+fn load_game_options_from_db(mut game_options: ResMut<GameOptions>) {
+    if let Some(db_game_options) = get_game_options(DEFAULT_OPTIONS_PROFILE_ID) {
+        *game_options = db_game_options;
+    }
+}
+
 fn load_user_stats_cache_from_db(
     mut user_stats_cache: ResMut<UserStatsByPlayerForCompletedGamesCache>,
 ) {
@@ -105,6 +118,7 @@ mod test {
         MobKillsByPlayerForCompletedGames, MobsKilledBy1PlayerCacheT, MobsKilledByPlayerCacheT,
         UserStat, UserStatsByPlayerForCompletedGamesCache, DEFAULT_USER_ID,
     };
+    use thetawave_interface::game::options::GameOptions;
     use thetawave_interface::spawnable::EnemyMobType;
     use thetawave_interface::states::AppStates;
 
@@ -202,7 +216,8 @@ mod test {
                 level: Level::DEBUG,
             })
             .insert_resource(MobKillsByPlayerForCompletedGames::default())
-            .insert_resource(UserStatsByPlayerForCompletedGamesCache::default());
+            .insert_resource(UserStatsByPlayerForCompletedGamesCache::default())
+            .insert_resource(GameOptions::default());
         app
     }
     fn _test_can_flush_caches_to_db() {

src/assets/consumable.rs

@@ -29,7 +29,11 @@ impl ConsumableAssets {
     }
 
     #[allow(unused)] // Placeholder for if we put this in the item config files
-    pub fn get_color(&self, consumable_type: &ConsumableType) -> Color {
-        Color::rgb(1.6, 1.6, 1.6)
+    pub fn get_color(&self, consumable_type: &ConsumableType, bloom_intensity: f32) -> Color {
+        Color::rgb(
+            1.0 + 0.6 * bloom_intensity,
+            1.0 + 0.6 * bloom_intensity,
+            1.0 + 0.6 * bloom_intensity,
+        )
     }
 }

src/assets/effect.rs

@@ -47,19 +47,59 @@ impl EffectAssets {
         }
     }
 
-    pub fn get_color(&self, effect_type: &EffectType) -> Color {
+    pub fn get_color(&self, effect_type: &EffectType, bloom_intensity: f32) -> Color {
         match effect_type {
-            EffectType::BarrierGlow => Color::rgb(1.0, 1.0, 1.4),
-            EffectType::AllyBlastExplosion => Color::rgb(4.0, 4.0, 4.0),
-            EffectType::EnemyBlastExplosion => Color::rgb(4.0, 4.0, 4.0),
-            EffectType::AllyBulletExplosion => Color::rgb(5.0, 5.0, 5.0),
-            EffectType::EnemyBulletExplosion => Color::rgb(5.0, 5.0, 5.0),
-            EffectType::MobExplosion => Color::rgb(6.0, 6.0, 6.0),
-            EffectType::AllyBlastDespawn => Color::rgb(4.0, 4.0, 4.0),
-            EffectType::ConsumableDespawn => Color::rgb(3.0, 3.0, 3.0),
-            EffectType::EnemyBlastDespawn => Color::rgb(4.0, 4.0, 4.0),
-            EffectType::AllyBulletDespawn => Color::rgb(5.0, 5.0, 5.0),
-            EffectType::EnemyBulletDespawn => Color::rgb(5.0, 5.0, 5.0),
+            EffectType::BarrierGlow => Color::rgb(1.0, 1.0, 1.0 + 0.4 * bloom_intensity),
+            EffectType::AllyBlastExplosion => Color::rgb(
+                1.0 + 3.0 * bloom_intensity,
+                1.0 + 3.0 * bloom_intensity,
+                1.0 + 3.0 * bloom_intensity,
+            ),
+            EffectType::EnemyBlastExplosion => Color::rgb(
+                1.0 + 3.0 * bloom_intensity,
+                1.0 + 3.0 * bloom_intensity,
+                1.0 + 3.0 * bloom_intensity,
+            ),
+            EffectType::AllyBulletExplosion => Color::rgb(
+                1.0 + 4.0 * bloom_intensity,
+                1.0 + 4.0 * bloom_intensity,
+                1.0 + 4.0 * bloom_intensity,
+            ),
+            EffectType::EnemyBulletExplosion => Color::rgb(
+                1.0 + 4.0 * bloom_intensity,
+                1.0 + 4.0 * bloom_intensity,
+                1.0 + 4.0 * bloom_intensity,
+            ),
+            EffectType::MobExplosion => Color::rgb(
+                1.0 + 5.0 * bloom_intensity,
+                1.0 + 5.0 * bloom_intensity,
+                1.0 + 5.0 * bloom_intensity,
+            ),
+            EffectType::AllyBlastDespawn => Color::rgb(
+                1.0 + 3.0 * bloom_intensity,
+                1.0 + 3.0 * bloom_intensity,
+                1.0 + 3.0 * bloom_intensity,
+            ),
+            EffectType::ConsumableDespawn => Color::rgb(
+                1.0 + 2.0 * bloom_intensity,
+                1.0 + 2.0 * bloom_intensity,
+                1.0 + 2.0 * bloom_intensity,
+            ),
+            EffectType::EnemyBlastDespawn => Color::rgb(
+                1.0 + 3.0 * bloom_intensity,
+                1.0 + 3.0 * bloom_intensity,
+                1.0 + 3.0 * bloom_intensity,
+            ),
+            EffectType::AllyBulletDespawn => Color::rgb(
+                1.0 + 4.0 * bloom_intensity,
+                1.0 + 4.0 * bloom_intensity,
+                1.0 + 4.0 * bloom_intensity,
+            ),
+            EffectType::EnemyBulletDespawn => Color::rgb(
+                1.0 + 4.0 * bloom_intensity,
+                1.0 + 4.0 * bloom_intensity,
+                1.0 + 4.0 * bloom_intensity,
+            ),
             EffectType::Text(_) => Color::rgb(0.0, 0.0, 0.0),
         }
     }

src/assets/mob.rs

@@ -142,11 +142,23 @@ impl MobAssets {
         }
     }
 
-    pub fn get_thruster_color(&self, mob_type: &MobType) -> Color {
+    pub fn get_thruster_color(&self, mob_type: &MobType, bloom_intensity: f32) -> Color {
         match mob_type {
-            MobType::Enemy(_) => Color::rgb(3.8, 2.2, 1.0),
-            MobType::Ally(_) => Color::rgb(3.8, 2.2, 1.0),
-            MobType::Neutral(_) => Color::rgb(3.8, 2.2, 1.0),
+            MobType::Enemy(_) => Color::rgb(
+                1.0 + 2.8 * bloom_intensity,
+                1.0 + 1.2 * bloom_intensity,
+                1.0,
+            ),
+            MobType::Ally(_) => Color::rgb(
+                1.0 + 2.8 * bloom_intensity,
+                1.0 + 1.2 * bloom_intensity,
+                1.0,
+            ),
+            MobType::Neutral(_) => Color::rgb(
+                1.0 + 2.8 * bloom_intensity,
+                1.0 + 1.2 * bloom_intensity,
+                1.0,
+            ),
         }
     }
 }

src/assets/projectile.rs

@@ -31,10 +31,18 @@ impl ProjectileAssets {
             },
         }
     }
-    pub fn get_color(&self, projectile_type: &ProjectileType) -> Color {
+    pub fn get_color(&self, projectile_type: &ProjectileType, bloom_intensity: f32) -> Color {
         match projectile_type {
-            ProjectileType::Blast(_) => Color::rgb(3.0, 3.0, 3.0),
-            ProjectileType::Bullet(_) => Color::rgb(2.0, 2.0, 2.0),
+            ProjectileType::Blast(_) => Color::rgb(
+                1.0 + 2.0 * bloom_intensity,
+                1.0 + 2.0 * bloom_intensity,
+                1.0 + 2.0 * bloom_intensity,
+            ),
+            ProjectileType::Bullet(_) => Color::rgb(
+                1.0 + 1.0 * bloom_intensity,
+                1.0 + 1.0 * bloom_intensity,
+                1.0 + 1.0 * bloom_intensity,
+            ),
         }
     }
 }

src/background/mod.rs

@@ -9,6 +9,7 @@ use ron::de::from_bytes;
 use serde::Deserialize;
 use std::ops::Range;
 use thetawave_interface::{
+    game::options::GameOptions,
     run::{RunDefeatType, RunEndEvent, RunOutcomeType},
     states::{self, GameCleanup},
 };
@@ -159,6 +160,7 @@ pub fn create_background_system(
     mut materials: ResMut<Assets<StandardMaterial>>,
     mut star_explode_res: ResMut<StarExplodeResource>,
     backgrounds_res: Res<BackgroundsResource>,
+    game_options: Res<GameOptions>,
 ) {
     // reset the star explode reource
     *star_explode_res = StarExplodeResource::default();
@@ -280,9 +282,12 @@ pub fn create_background_system(
 
     // Spawn a star with a random color
     let star_color = Color::rgb_linear(
-        rng.gen_range(backgrounds_res.star_color_range.clone()),
-        rng.gen_range(backgrounds_res.star_color_range.clone()),
-        rng.gen_range(backgrounds_res.star_color_range.clone()),
+        rng.gen_range(backgrounds_res.star_color_range.clone())
+            + 10.0 * game_options.bloom_intensity,
+        rng.gen_range(backgrounds_res.star_color_range.clone())
+            + 10.0 * game_options.bloom_intensity,
+        rng.gen_range(backgrounds_res.star_color_range.clone())
+            + 10.0 * game_options.bloom_intensity,
     );
 
     // Emissive colored star material for bloom

src/main.rs

@@ -218,6 +218,7 @@ mod test {
     use bevy::MinimalPlugins;
     use bevy_kira_audio::AudioPlugin;
     use thetawave_interface::audio::{ChangeBackgroundMusicEvent, PlaySoundEffectEvent};
+    use thetawave_interface::game::options::GameOptions;
     use thetawave_interface::states::AppStates;
 
     #[test]
@@ -266,6 +267,8 @@ mod test {
         let mut app = build_app(base_plugins, game_plugins);
         app.add_event::<ChangeBackgroundMusicEvent>()
             .add_event::<PlaySoundEffectEvent>();
+
+        app.insert_resource(GameOptions::default());
         app
     }
 }