Feature: Discord Rich Presence

.github/workflows/build-macos.yml

@@ -9,7 +9,6 @@ env:
   REPO_NAME: Mrmayman/quantum-launcher
   FINAL_NAME: quantum_launcher
   CARGO_TERM_COLOR: always # Tell cargo to always use colors
-  MACOSX_DEPLOYMENT_TARGET: 10.15
 
 jobs:
   dist:
@@ -66,7 +65,7 @@ jobs:
         shell: bash
         run: |
           mkdir dist
-          APP_DIR="build/quantum-launcher.app"
+          APP_DIR="build/QuantumLauncher.app"
           MACOS_DIR="$APP_DIR/Contents/MacOS"
           RESOURCES_DIR="$APP_DIR/Contents/Resources"
           mkdir -p "$MACOS_DIR" "$RESOURCES_DIR"

.github/workflows/release.yml

@@ -176,7 +176,7 @@ jobs:
           if [[ "${{ matrix.build }}" =~ "windows" ]]; then
             cp "target/${{ matrix.target }}/$PROFILE/${{ env.BIN_NAME }}.exe" "dist/"
           elif [[ "${{ matrix.build }}" =~ "macos" ]]; then
-            APP_DIR="build/quantum-launcher.app"
+            APP_DIR="build/QuantumLauncher.app"
             MACOS_DIR="$APP_DIR/Contents/MacOS"
             RESOURCES_DIR="$APP_DIR/Contents/Resources"
             mkdir -p "$MACOS_DIR" "$RESOURCES_DIR"

changelogs/unreleased.md

@@ -10,6 +10,11 @@
 
 TODO: Add screenshots
 
+# Discord Rich Presence
+
+- Added support for displaying your status in Discord through Rich Presence
+- Customizable, can display any text or info (game version/instance name) of your choice
+
 # UX
 
 - You can now automatically create changelogs after updating mods,

crates/ql_core/src/json/instance_config.rs

@@ -252,8 +252,7 @@ impl InstanceConfigJson {
 
     #[must_use]
     pub fn c_global_settings(&mut self) -> &mut GlobalSettings {
-        self.global_settings
-            .get_or_insert_with(GlobalSettings::default)
+        self.global_settings.get_or_insert_default()
     }
 
     #[must_use]

crates/ql_mod_manager/src/loaders/optifine.rs

@@ -11,9 +11,7 @@ use ql_core::{
     LAUNCHER_DIR, Loader, OptifineUniqueVersion, Progress, RequestError, download,
     file_utils::{self, exists},
     impl_3_errs_jri, info, jarmod,
-    json::{
-        InstanceConfigJson, VersionDetails, instance_config::ModTypeInfo, optifine::JsonOptifine,
-    },
+    json::{InstanceConfigJson, VersionDetails, optifine::JsonOptifine},
     no_window, pt,
 };
 use ql_java_handler::{JAVA, JavaInstallError, JavaVersion, get_java_binary};
@@ -120,10 +118,7 @@ pub async fn install(
             tokio::fs::copy(&path_to_installer, &dest)
                 .await
                 .path(&path_to_installer)?;
-            config
-                .mod_type_info
-                .get_or_insert_with(ModTypeInfo::default)
-                .optifine_jar = Some(filename.to_owned());
+            config.mod_type_info.get_or_insert_default().optifine_jar = Some(filename.to_owned());
             config.save_to_dir(&instance_path).await?;
             return Ok(());
         }

crates/ql_packager/src/multimc.rs

@@ -164,7 +164,7 @@ fn setup_config(ini: &Ini, instance_recipe: &InstanceRecipe, config: &mut Instan
     if let Ok(jvmargs) = general_get(ini, "JvmArgs") {
         config
             .java_args
-            .get_or_insert_with(Vec::new)
+            .get_or_insert_default()
             .extend(jvmargs.split_whitespace().map(str::to_owned));
     }
 

quantum_launcher/Cargo.toml

@@ -59,6 +59,13 @@ tokio.workspace = true
 cfg-if.workspace = true
 semver.workspace = true
 
+constcat = "0.6"
+rand = "0.10"
+chrono.workspace = true # Logging time/date
+paste = "1" # Icon widget macro
+rfd.workspace = true # File picker
+# For Discord Rich Presence management
+filthy-rich = "0.8.3"
 # Launcher Update
 thiserror.workspace = true
 zip.workspace = true
@@ -74,11 +81,6 @@ open = "5.3.2"
 dark-light.git = "https://github.com/rust-dark-light/dark-light" # Less dependencies than the stable one
 dirs.workspace = true
 
-paste = "1" # icon widget macro
-rfd.workspace = true # file picker
-constcat = "0.6"
-rand = "0.10"
-
 [target.'cfg(not(target_os = "macos"))'.dependencies]
 notify-rust = { version = "4", default-features = false, features = ["z-with-tokio"] }
 

quantum_launcher/src/config/discord_rpc.rs

@@ -0,0 +1,64 @@
+use std::collections::HashMap;
+
+use serde::{Deserialize, Serialize};
+
+const BASIC_DETAILS: &str = "Opened Launcher";
+const BASIC_STATE: &str = "";
+const GAMEOPEN_DETAILS: &str = "Minecraft v${version}";
+const GAMEOPEN_STATE: &str = "Instance name: ${instance}";
+const GAMEEXIT_DETAILS: &str = "Just quit game";
+const GAMEEXIT_STATE: &str = "Minecraft v${version}";
+
+#[derive(Serialize, Deserialize, Debug, Clone)]
+pub struct RpcConfig {
+    /// Enable Discord Rich Presence support
+    // Since: TBD
+    pub enable: bool,
+    /// Details for the basic/initial rich presence activity
+    // Since: TBD
+    pub basic: RpcText,
+    /// Whether to change rich presence with instance open/exit events.
+    // Since: TBD
+    pub update_on_game_open: bool,
+    /// Activity on opening the game
+    // Since: TBD
+    pub on_gameopen: RpcText,
+    /// Activity on closing the game
+    // Since: TBD
+    pub on_gameexit: RpcText,
+    #[serde(flatten)]
+    _extra: HashMap<String, serde_json::Value>,
+}
+
+#[derive(Serialize, Deserialize, Debug, Clone)]
+pub struct RpcText {
+    pub top_text: Option<String>,
+    pub bottom_text: String,
+    #[serde(flatten)]
+    _extra: HashMap<String, serde_json::Value>,
+}
+
+impl Default for RpcConfig {
+    fn default() -> Self {
+        Self {
+            enable: false,
+            basic: RpcText {
+                top_text: Some(BASIC_DETAILS.to_owned()),
+                bottom_text: BASIC_STATE.to_owned(),
+                _extra: HashMap::new(),
+            },
+            update_on_game_open: true,
+            on_gameopen: RpcText {
+                top_text: Some(GAMEOPEN_DETAILS.to_owned()),
+                bottom_text: GAMEOPEN_STATE.to_owned(),
+                _extra: HashMap::new(),
+            },
+            on_gameexit: RpcText {
+                top_text: Some(GAMEEXIT_DETAILS.to_owned()),
+                bottom_text: GAMEEXIT_STATE.to_owned(),
+                _extra: HashMap::new(),
+            },
+            _extra: HashMap::new(),
+        }
+    }
+}

quantum_launcher/src/config/mod.rs

@@ -1,3 +1,4 @@
+use crate::config::discord_rpc::RpcConfig;
 use crate::config::sidebar::{SidebarConfig, SidebarNode, SidebarNodeKind};
 use crate::stylesheet::styles::{LauncherTheme, LauncherThemeColor, LauncherThemeLightness};
 use crate::{WINDOW_HEIGHT, WINDOW_WIDTH};
@@ -13,6 +14,7 @@ use std::{
     path::Path,
 };
 
+pub mod discord_rpc;
 pub mod sidebar;
 
 pub const SIDEBAR_WIDTH: f32 = 0.33;
@@ -102,6 +104,8 @@ pub struct LauncherConfig {
     pub persistent: Option<PersistentSettings>,
     // Since: v0.5.1
     pub sidebar: Option<SidebarConfig>,
+    // Since: TBD
+    pub discord_rpc: Option<RpcConfig>,
     /// Time of last auto-update check result, in seconds since the Unix epoch.
     // Since: TBD
     #[cfg(feature = "auto_update")]
@@ -131,6 +135,7 @@ impl Default for LauncherConfig {
             ui: None,
             persistent: None,
             sidebar: None,
+            discord_rpc: None,
             _extra: HashMap::new(),
             #[cfg(feature = "auto_update")]
             last_update_check: None,
@@ -188,6 +193,11 @@ impl LauncherConfig {
         Ok(())
     }
 
+    /// Resets the Discord Rich Presence configuration to default.
+    pub fn reset_presence(&mut self) {
+        self.discord_rpc = Some(RpcConfig::default());
+    }
+
     pub fn update_sidebar(&mut self, instances: &[String], kind: InstanceKind) {
         let sidebar = self.sidebar.get_or_insert_with(SidebarConfig::default);
 
@@ -281,21 +291,19 @@ impl LauncherConfig {
     }
 
     pub fn c_window(&mut self) -> &mut WindowProperties {
-        self.window.get_or_insert_with(WindowProperties::default)
+        self.window.get_or_insert_default()
     }
 
     pub fn c_global(&mut self) -> &mut GlobalSettings {
-        self.global_settings
-            .get_or_insert_with(GlobalSettings::default)
+        self.global_settings.get_or_insert_default()
     }
 
     pub fn c_persistent(&mut self) -> &mut PersistentSettings {
-        self.persistent
-            .get_or_insert_with(PersistentSettings::default)
+        self.persistent.get_or_insert_default()
     }
 
     pub fn c_sidebar(&mut self) -> &mut SidebarConfig {
-        self.sidebar.get_or_insert_with(SidebarConfig::default)
+        self.sidebar.get_or_insert_default()
     }
 
     pub fn c_idle_fps(&self) -> u64 {
@@ -315,6 +323,10 @@ impl LauncherConfig {
         }
     }
 
+    pub fn c_rpc_enabled(&self) -> bool {
+        self.discord_rpc.as_ref().is_some_and(|n| n.enable)
+    }
+
     #[cfg(feature = "auto_update")]
     pub fn should_update_check(&self) -> bool {
         const INTERVAL_SECS: u64 = 60 * 60;
@@ -445,7 +457,7 @@ pub struct UiSettings {
     pub idle_fps: Option<u64>,
     /// When the game is launched, the launcher can either
     /// minimize itself, close itself, or do nothing (default).
-    // Since: v0.5.2
+    // Since: TBD
     #[serde(default)]
     pub after_game_opens: AfterLaunchBehavior,
     #[serde(flatten)]

quantum_launcher/src/main.rs

@@ -125,13 +125,20 @@ impl Launcher {
             Task::none()
         };
 
+        let presence_task = if launcher.config.c_rpc_enabled() {
+            launcher.start_discord_ipc_run()
+        } else {
+            Task::none()
+        };
+
         (
             launcher,
             Task::batch([
                 check_for_updates_command,
                 Task::perform(get_entries(InstanceKind::Client), Message::CoreListLoaded),
                 Task::perform(get_entries(InstanceKind::Server), Message::CoreListLoaded),
                 load_notes_command,
+                presence_task,
                 Task::perform(ql_core::clean::dir("logs"), |n| {
                     Message::CoreCleanComplete(n.strerr())
                 }),

quantum_launcher/src/menu_renderer/launch.rs

@@ -11,8 +11,8 @@ use crate::menu_renderer::{
     view_info_message,
 };
 use crate::state::{
-    GameLogMessage, InstanceNotes, LaunchModal, MainMenuMessage, NotesMessage, ShortcutMessage,
-    SidebarMessage, SidebarScroll, WindowMessage,
+    GameLogMessage, InstanceNotes, LaunchModal, LauncherSettingsTab, MainMenuMessage, NotesMessage,
+    ShortcutMessage, SidebarMessage, SidebarScroll, WindowMessage,
 };
 use crate::{
     icons,
@@ -561,7 +561,7 @@ impl MenuLaunch {
         )
         .padding(0)
         .style(|n, status| n.style_button(status, StyleButton::FlatExtraDark))
-        .on_press(LauncherSettingsMessage::Open.into());
+        .on_press(LauncherSettingsMessage::Open(LauncherSettingsTab::default()).into());
 
         widget::mouse_area(
             widget::container(