feat: start with Windows tray option

Author: AntoineGS

Cargo.lock

@@ -354,7 +354,7 @@ binding_modes:
 
 **Q: How do I run GlazeWM on startup?**
 
-Create a shortcut for the executable by right-clicking on the GlazeWM executable -> `Create shortcut`. Put the shortcut in your startup folder, which you can get to by entering `shell:startup` in the top bar in File Explorer.
+Right-click the GlazeWM icon in the system tray and select "Start with Windows". 
 
 **Q: How can I create `<insert layout>`?**
 

README.md

@@ -8,6 +8,7 @@ path = "src/lib.rs"
 
 [dependencies]
 anyhow = { workspace = true }
+auto-launch = "0.5.0"
 home = { workspace = true }
 tokio = { workspace = true }
 tracing = { workspace = true }

packages/wm-platform/Cargo.toml

@@ -5,6 +5,7 @@ use std::{
 };
 
 use anyhow::{bail, Context};
+use auto_launch::AutoLaunch;
 use windows::{
   core::{w, PCWSTR},
   Win32::{
@@ -319,6 +320,38 @@ impl Platform {
     Ok(())
   }
 
+  /// Gets the `AutoLaunch` instance for the GlazeWM application.
+  fn get_auto_launch() -> anyhow::Result<AutoLaunch> {
+    let exe_path = std::env::current_exe()?;
+    let quoted_exe_str = format!("\"{}\"", exe_path.to_str().unwrap());
+    Ok(AutoLaunch::new("GlazeWM", &quoted_exe_str, &[] as &[&str]))
+  }
+
+  /// Checks if auto-launch at system startup is enabled.
+  pub fn is_auto_launch_enabled() -> anyhow::Result<bool> {
+    let auto_launch = Self::get_auto_launch()?;
+
+    match auto_launch.is_enabled() {
+      Ok(enabled) => Ok(enabled),
+      Err(e) => {
+        Err(e.into())
+      }
+    }
+  }
+
+  /// Enables or disables auto-launch at system startup.
+  pub fn set_auto_launch_enabled(enable: bool) -> anyhow::Result<()> {
+    let auto_launch = Self::get_auto_launch()?;
+
+    if enable {
+      auto_launch.enable()?;
+    } else {
+      auto_launch.disable()?;
+    }
+
+    Ok(())
+  }
+
   /// Opens File Explorer at the specified path.
   pub fn open_file_explorer(path: &PathBuf) -> anyhow::Result<()> {
     let normalized_path = std::fs::canonicalize(path)?;

packages/wm-platform/src/platform.rs

@@ -42,14 +42,25 @@ impl SystemTray {
         animations_enabled,
         None,
       );
+      
+      let mut start_with_windows_enabled =
+        Platform::is_auto_launch_enabled().unwrap_or(false);
 
+      let start_with_windows_item = CheckMenuItem::new(
+        "Start with Windows",
+        true,
+        start_with_windows_enabled,
+        None,
+      );
+      
       let exit_item = MenuItem::new("Exit", true, None);
 
       let tray_menu = Menu::new();
       tray_menu.append_items(&[
         &reload_config_item,
         &config_dir_item,
         &animations_item,
+        &start_with_windows_item,
         &PredefinedMenuItem::separator(),
         &exit_item,
       ])?;
@@ -76,6 +87,12 @@ impl SystemTray {
               Platform::set_window_animations_enabled(!animations_enabled);
 
             animations_enabled = !animations_enabled;
+          } else if event.id == start_with_windows_item.id() {
+            // Toggle auto-launch on Windows startup.
+            let _ = 
+              Platform::set_auto_launch_enabled(!start_with_windows_enabled);
+            
+            start_with_windows_enabled = !start_with_windows_enabled;
           } else if event.id == exit_item.id() {
             exit_tx.send(())?;
           }

packages/wm/src/sys_tray.rs

@@ -122,5 +122,21 @@
         System="yes"
       />
     </Component>
+
+    <!-- Remove auto-launch registry values on uninstall. -->
+    <Component Id="Custom_RemoveAutoLaunchRegistry" Guid="B1A2C3D4-E5F6-47A8-9B0C-1234567890AB">
+      <RemoveRegistryValue
+        Root="HKCU"
+        Key="SOFTWARE\Microsoft\Windows\CurrentVersion\Run"
+        Name="GlazeWM"
+        Action="remove"
+        On="uninstall" />
+      <RemoveRegistryValue
+        Root="HKCU"
+        Key="SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\StartupApproved\Run"
+        Name="GlazeWM"
+        Action="remove"
+        On="uninstall" />
+    </Component>
   </Package>
 </Wix>