All of the app details now reside in env.json. See env_template.json for an idea on how to make your own config.

Author: CaspianA1

.gitignore

@@ -4,5 +4,5 @@
 Cargo.lock
 scrap_code.txt
 project.log
-assets/api_keys.json
+assets/env.json
 assets/ignored/*

README.md

@@ -54,7 +54,8 @@ Or, with logging enabled:
 RUST_LOG=wbor_studio_dashboard cargo run --release
 ```
 
-You'll also want to create a file in `assets/` named `api_keys.json`. If you don't have an API key yet for any API, you can just put in a dummy value, and the dashboard will launch just fine. Most APIs already use custom proxies that don't require keys anyways, so the keys are there just for when the proxies fail.
+You'll also want to create a file in `assets/` named `env.json` (base it on `env_template.json`).
+If you don't have an API key yet for any API, you can just put in a dummy value, and the dashboard will launch just fine. Most APIs already use custom proxies that don't require keys anyways, so the keys are there just for when the proxies fail.
 
 ---
 
@@ -66,7 +67,7 @@ The current themes are:
 - `barebones`
 - `retro_room`
 
-You can change the theme in `app_config.json`.
+You can change the theme in `env.json`.
 If you want to make a new theme, start off by copying `standard.rs`, and make your changes from there. Make sure that it doesn't differ too much by running `diff standard.rs <YOUR_NEW_THEME.rs> --color=auto`.
 
 ---
@@ -75,7 +76,7 @@ If you want to make a new theme, start off by copying `standard.rs`, and make yo
 
 - To delete recent Twilio messages, use `delete_twilio_msgs.sh`. Change the number of messages to delete in the script, and it'll delete that number of messages one-by-one.
 
-- To run the dashboard on its computer, use `run_dashboard.sh`. Note that this is only made to work in the WBOR studio. If the dashboard ever panics, the script will sleep for a bit, and then try launching it again (while writing all output to a log file `project.log`). Also, if a Discord channel webhook is set up in `api_keys.json`, any crashes will automatically send a message to the channel associated with that webhook.
+- To run the dashboard on its computer, use `run_dashboard.sh`. Note that this is only made to work in the WBOR studio. If the dashboard ever panics, the script will sleep for a bit, and then try launching it again (while writing all output to a log file `project.log`). Also, if a Discord channel webhook is set up in `env.json`, any crashes will automatically send a message to the channel associated with that webhook.
 
 - To communicate with the dashboard, use `communicate_with_dashboard.sh`:
   - To send a surprise (an image that appears for some amount of time, with a certain random chance of appearing during some time of the day), pass these arguments: `surprise assets/<surprise_with_given_path>`. The surprise path must be one previously defined in `src/dashboard_defs/themes/shared_utils.rs`.

assets/api_keys_template.json

@@ -0,0 +1,31 @@
+{
+	"window_config": {
+		"title": "WBOR Studio Dashboard",
+		"theme_name": "barebones",
+		"icon_path": "assets/plane.bmp",
+
+		"background_color": [0, 0, 0],
+		"max_remake_transition_queue_size": 10,
+
+		"hide_cursor": true,
+		"draw_borders": true,
+		"use_linear_filtering": true,
+		"window_always_on_top": false,
+
+		"maybe_pause_subduration_ms_when_window_unfocused": null,
+
+		"o1": {"Windowed": [[1024, 768], false, null]},
+		"o2": "FullscreenDesktop",
+		"screen_option": "Fullscreen"
+	},
+
+	"api_keys": {
+		"spinitron": "SPINITRON API KEY HERE",
+		"twilio_account_sid": "TWILIO ACCOUNT SID HERE",
+		"twilio_auth_token": "TWILIO AUTH TOKEN HERE",
+		"tomorrow_io": "TOMORROW.IO API KEY HERE",
+
+		"streaming_server_now_playing_url": "STREAMING SERVER URL HERE (PROBABLY 'https://azura.wbor.org/api/nowplaying/2' FOR THE NEAR FUTURE)",
+		"dashboard_crash_discord_webhook_url": "OPTIONAL WEBHOOK URL HERE THAT IS CALLED WHEN THE DASHBOARD CRASHES"
+	}
+}

assets/app_config.json

@@ -11,7 +11,6 @@ use crate::{
 
 	utils::{
 		request,
-		file_utils,
 		vec2f::Vec2f,
 		time::Duration,
 		generic_result::*,
@@ -74,7 +73,7 @@ pub async fn make_dashboard(
 	let main_windows_gap_size = 0.01;
 
 	let mut rand_generator = rand::thread_rng();
-	let api_keys: ApiKeys = file_utils::load_json_from_file("assets/api_keys.json").await?;
+	let api_keys = ApiKeys::new().await?;
 
 	let (theme_color_1, theme_border_radius_1) = (ColorSDL::RGB(255, 133, 133), 8);
 	let theme_border_info_1 = Some((theme_color_1, theme_border_radius_1));

assets/env_template.json

@@ -11,7 +11,6 @@ use crate::{
 
 	utils::{
 		request,
-		file_utils,
 		vec2f::Vec2f,
 		time::Duration,
 		generic_result::*,
@@ -75,7 +74,7 @@ pub async fn make_dashboard(
 	let main_windows_gap_size = 0.0;
 
 	let mut rand_generator = rand::thread_rng();
-	let api_keys: ApiKeys = file_utils::load_json_from_file("assets/api_keys.json").await?;
+	let api_keys = ApiKeys::new().await?;
 
 	let theme_color_1 = ColorSDL::RGB(134, 0, 41);
 	let theme_border_info_1 = None;

src/dashboard_defs/themes/barebones.rs

@@ -28,6 +28,18 @@ pub struct ApiKeys {
 	pub streaming_server_now_playing_url: String // Not really an API key, but this is the best place to put it anyways
 }
 
+impl ApiKeys {
+	pub async fn new() -> GenericResult<Self> {
+		#[derive(serde::Deserialize)]
+		struct ApiKeysWrapper {
+			api_keys: ApiKeys
+		}
+
+		let wrapper: ApiKeysWrapper = file_utils::load_json_from_file("assets/env.json").await?;
+		Ok(wrapper.api_keys)
+	}
+}
+
 //////////
 
 lazy_static::lazy_static!(

src/dashboard_defs/themes/retro_room.rs

@@ -11,7 +11,6 @@ use crate::{
 
 	utils::{
 		request,
-		file_utils,
 		vec2f::Vec2f,
 		time::Duration,
 		generic_result::*,
@@ -75,7 +74,7 @@ pub async fn make_dashboard(
 	let main_windows_gap_size = 0.01;
 
 	let mut rand_generator = rand::thread_rng();
-	let api_keys: ApiKeys = file_utils::load_json_from_file("assets/api_keys.json").await?;
+	let api_keys = ApiKeys::new().await?;
 
 	let (theme_color_1, theme_border_radius_1) = (ColorSDL::RGB(249, 236, 210), 8);
 	let theme_border_info_1 = Some((theme_color_1, theme_border_radius_1));

src/dashboard_defs/themes/shared_utils.rs

@@ -46,7 +46,7 @@ enum ScreenOption {
 }
 
 #[derive(serde::Deserialize)]
-struct AppConfig {
+struct WindowConfig {
 	title: String,
 	theme_name: String,
 	icon_path: String,
@@ -64,6 +64,18 @@ struct AppConfig {
 	screen_option: ScreenOption
 }
 
+impl WindowConfig{
+	pub async fn new() -> GenericResult<Self> {
+		#[derive(serde::Deserialize)]
+		struct WindowConfigWrapper {
+			window_config: WindowConfig
+		}
+
+		let wrapper: WindowConfigWrapper = file_utils::load_json_from_file("assets/env.json").await?;
+		Ok(wrapper.window_config)
+	}
+}
+
 //////////
 
 fn get_fps(sdl_timer: &sdl2::TimerSubsystem,
@@ -103,7 +115,7 @@ async fn main() {
 	env_logger::init();
 	log::info!("App launched!");
 
-	let app_config: AppConfig = file_utils::load_json_from_file("assets/app_config.json").await.unwrap();
+	let window_config = WindowConfig::new().await.unwrap();
 
 	////////// Setting up SDL and the initial window
 
@@ -112,9 +124,9 @@ async fn main() {
 	let mut sdl_event_pump = sdl_context.event_pump().unwrap();
 
 	let build_window = |size: PixelAreaSDL, applier: fn(&mut WindowBuilder) -> &mut WindowBuilder|
-		applier(&mut sdl_video_subsystem.window(&app_config.title, size.0, size.1)).allow_highdpi().build();
+		applier(&mut sdl_video_subsystem.window(&window_config.title, size.0, size.1)).allow_highdpi().build();
 
-	let mut sdl_window = match app_config.screen_option {
+	let mut sdl_window = match window_config.screen_option {
 		ScreenOption::Windowed(size, borderless, _) => build_window(
 			size,
 			if borderless {|wb| wb.position_centered().borderless()}
@@ -139,16 +151,16 @@ async fn main() {
 
 	////////// Setting the window always-on-top state, opacity, and icon
 
-	sdl_window.set_always_on_top(app_config.window_always_on_top);
+	sdl_window.set_always_on_top(window_config.window_always_on_top);
 
 	// TODO: why does not setting the opacity result in broken fullscreen screen clearing?
-	if let ScreenOption::Windowed(.., Some(opacity)) = app_config.screen_option {
+	if let ScreenOption::Windowed(.., Some(opacity)) = window_config.screen_option {
 		if let Err(err) = sdl_window.set_opacity(opacity as f32) {
 			log::warn!("Window translucency not supported by your current platform! Official error: '{err}'.");
 		}
 	}
 
-	sdl_window.set_icon(Surface::from_file(app_config.icon_path).unwrap());
+	sdl_window.set_icon(Surface::from_file(window_config.icon_path).unwrap());
 
 	////////// Making a SDL canvas
 
@@ -164,13 +176,13 @@ async fn main() {
 	let using_texture_filtering_option =
 		sdl2::hint::set_with_priority(
 			"SDL_RENDER_SCALE_QUALITY",
-			if app_config.use_linear_filtering {"1"} else {"0"},
+			if window_config.use_linear_filtering {"1"} else {"0"},
 			&sdl2::hint::Hint::Override
 		);
 
 	assert!(using_texture_filtering_option);
 
-	if app_config.hide_cursor {
+	if window_config.hide_cursor {
 		sdl_context.mouse().show_cursor(false);
 	}
 
@@ -187,19 +199,19 @@ async fn main() {
 	let sdl_performance_frequency = sdl_timer.performance_frequency();
 
 	let texture_pool = texture::pool::TexturePool::new(
-		&texture_creator, &sdl_ttf_context, max_texture_size, app_config.max_remake_transition_queue_size
+		&texture_creator, &sdl_ttf_context, max_texture_size, window_config.max_remake_transition_queue_size
 	);
 
 	let mut rendering_params =
 		window_tree::PerFrameConstantRenderingParams {
-			draw_borders: app_config.draw_borders,
+			draw_borders: window_config.draw_borders,
 			sdl_canvas,
 			texture_pool,
 			frame_counter: FrameCounter::new(),
 			shared_window_state: DynamicOptional::NONE
 		};
 
-	let bg = app_config.background_color;
+	let bg = window_config.background_color;
 	let standard_background_color = ColorSDL::RGB(bg.0, bg.1, bg.2);
 
 	log::info!("Canvas size: {:?}. Renderer info: {sdl_renderer_info:?}.", rendering_params.sdl_canvas.output_size().unwrap());
@@ -236,7 +248,7 @@ async fn main() {
 		}
 
 		if pausing_window {
-			if let Some(pause_subduration_ms) = app_config.maybe_pause_subduration_ms_when_window_unfocused {
+			if let Some(pause_subduration_ms) = window_config.maybe_pause_subduration_ms_when_window_unfocused {
 				sdl_timer.delay(pause_subduration_ms);
 				continue;
 			}
@@ -248,7 +260,7 @@ async fn main() {
 			let time_before_making_core_init_info = get_timestamp();
 
 			let core_init_info = build_dashboard_theme!(
-				app_config.theme_name.as_str(), &mut rendering_params.texture_pool,
+				window_config.theme_name.as_str(), &mut rendering_params.texture_pool,
 				UpdateRateCreator::new(fps), [standard, barebones, retro_room]
 			);