Add Windows installer support with Inno Setup and startup registration

Author: TtesseractT

.github/workflows/build.yml

@@ -34,6 +34,20 @@ jobs:
     - name: Publish (self-contained)
       run: dotnet publish ScreenGrid.csproj -c Release -r win-x64 --self-contained -p:PublishSingleFile=true -o ./artifacts/self-contained
 
+    - name: Install Inno Setup
+      run: choco install innosetup -y --no-progress
+
+    - name: Build Installer
+      run: |
+        & "C:\Program Files (x86)\Inno Setup 6\ISCC.exe" installer/ScreenGridSetup.iss
+      shell: pwsh
+
+    - name: Upload installer artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: ScreenGrid-installer
+        path: installer-output/ScreenGridSetup.exe
+
     - name: Upload framework-dependent artifact
       uses: actions/upload-artifact@v4
       with:
@@ -65,10 +79,16 @@ jobs:
         name: ScreenGrid-self-contained
         path: ./self-contained
 
+    - uses: actions/download-artifact@v4
+      with:
+        name: ScreenGrid-installer
+        path: ./installer
+
     - name: Rename artifacts
       run: |
         mv ./framework-dependent/ScreenGrid.exe ./ScreenGrid-small.exe
         mv ./self-contained/ScreenGrid.exe ./ScreenGrid-standalone.exe
+        mv ./installer/ScreenGridSetup.exe ./ScreenGridSetup.exe
 
     - name: Create/Update rolling release
       uses: softprops/action-gh-release@v2
@@ -82,9 +102,11 @@ jobs:
           |------|------|----------------|
           | `ScreenGrid-small.exe` | ~200 KB | Yes (.NET 9) |
           | `ScreenGrid-standalone.exe` | ~70 MB | No |
+          | `ScreenGridSetup.exe` | ~66 MB | No (installer) |
         files: |
           ScreenGrid-small.exe
           ScreenGrid-standalone.exe
+          ScreenGridSetup.exe
         prerelease: true
         make_latest: true
 
@@ -107,6 +129,11 @@ jobs:
         name: ScreenGrid-self-contained
         path: ./self-contained
 
+    - uses: actions/download-artifact@v4
+      with:
+        name: ScreenGrid-installer
+        path: ./installer
+
     - name: Get version from tag
       id: version
       run: echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
@@ -115,6 +142,7 @@ jobs:
       run: |
         mv ./framework-dependent/ScreenGrid.exe ./ScreenGrid-small.exe
         mv ./self-contained/ScreenGrid.exe ./ScreenGrid-standalone.exe
+        mv ./installer/ScreenGridSetup.exe ./ScreenGridSetup.exe
 
     - name: Create versioned release
       uses: softprops/action-gh-release@v2
@@ -128,6 +156,7 @@ jobs:
 
           | File | Size | Requires .NET? |
           |------|------|----------------|
+          | `ScreenGridSetup.exe` | ~66 MB | No (installer, auto-startup) |
           | `ScreenGrid-small.exe` | ~200 KB | Yes (.NET 9 Desktop Runtime) |
           | `ScreenGrid-standalone.exe` | ~70 MB | No |
 
@@ -136,5 +165,6 @@ jobs:
         files: |
           ScreenGrid-small.exe
           ScreenGrid-standalone.exe
+          ScreenGridSetup.exe
         prerelease: ${{ startsWith(github.ref_name, 'Beta') }}
         make_latest: ${{ !startsWith(github.ref_name, 'Beta') }}

.gitignore

@@ -3,6 +3,7 @@ bin/
 obj/
 publish/
 publish-small/
+installer-output/
 
 # IDE
 .vs/

App.xaml.cs

@@ -57,7 +57,34 @@ private void SetupTrayIcon()
             menu.Items.Add(header);
             menu.Items.Add(new ToolStripSeparator());
             menu.Items.Add("Create / Edit Grid", null, (_, _) => ShowGridEditor());
-            menu.Items.Add("Load Grid from File…", null, (_, _) => LoadGridFromFile());            menu.Items.Add("Reset Grid to Defaults", null, (_, _) => ResetGridToDefaults());            menu.Items.Add(new ToolStripSeparator());
+            menu.Items.Add("Load Grid from File…", null, (_, _) => LoadGridFromFile());
+            menu.Items.Add("Reset Grid to Defaults", null, (_, _) => ResetGridToDefaults());
+            menu.Items.Add(new ToolStripSeparator());
+
+            var startupItem = new ToolStripMenuItem("Run at Startup")
+            {
+                CheckOnClick = true,
+                Checked = StartupManager.IsRegistered()
+            };
+            startupItem.CheckedChanged += (_, _) =>
+            {
+                try
+                {
+                    if (startupItem.Checked)
+                        StartupManager.Register();
+                    else
+                        StartupManager.Unregister();
+                }
+                catch (Exception ex)
+                {
+                    MessageBox.Show($"Failed to update startup setting:\n{ex.Message}",
+                        "ScreenGrid", MessageBoxButton.OK, MessageBoxImage.Warning);
+                    startupItem.Checked = StartupManager.IsRegistered();
+                }
+            };
+            menu.Items.Add(startupItem);
+
+            menu.Items.Add(new ToolStripSeparator());
             menu.Items.Add("How to use", null, (_, _) => ShowUsageInfo());
             menu.Items.Add(new ToolStripSeparator());
             menu.Items.Add("Exit", null, (_, _) => ExitApp());

README.md

@@ -16,28 +16,31 @@ Built for displays like 5120×1440 where Windows' built-in snap (halves/quarters
 ---
 ## ⬇️ Download
 
-> **[Download the latest release](https://github.com/TtesseractT/ScreenGrid/releases/latest)** — no build tools needed, just run the `.exe`.
+> **[Download the latest release](https://github.com/TtesseractT/ScreenGrid/releases/latest)** - no build tools needed.
 
-| File | Size | Requires .NET? |
-|------|------|----------------|
-| **ScreenGrid-standalone.exe** | ~70 MB | No — runs anywhere |
-| **ScreenGrid-small.exe** | ~200 KB | Yes — needs [.NET 9 Desktop Runtime](https://dotnet.microsoft.com/download/dotnet/9.0) |
+| File | Size | Description |
+|------|------|-------------|
+| **ScreenGridSetup.exe** | ~66 MB | **Installer** - installs to Program Files, adds to Windows startup, creates Start Menu & optional desktop shortcut. Includes uninstaller. |
+| **ScreenGrid-standalone.exe** | ~70 MB | Portable single-file exe, no .NET required |
+| **ScreenGrid-small.exe** | ~200 KB | Portable single-file exe, needs [.NET 9 Desktop Runtime](https://dotnet.microsoft.com/download/dotnet/9.0) |
 
-Both are single-file executables. Download, run, and it appears in your system tray.
+**Recommended:** Use the installer for an automatic startup experience.
 
 ---
 ## Features
 
-- **Shift + Drag** to activate — zero interference with normal window management
+- **Shift + Drag** to activate - zero interference with normal window management
 - **5 built-in grid rows**: Halves, Thirds, 4:3, Quarters, Fifths
 - **3 × 4:3 variants**: left, center, and right positions
 - **Height splits**: top/bottom halves and height thirds for partial-height zones
-- **Custom grids** — create any ratio (2:1, 3:2:1, 16:9, etc.) via the built-in editor
+- **Custom grids** - create any ratio (2:1, 3:2:1, 16:9, etc.) via the built-in editor
 - **Save / Load** grid layouts as `.screengrid` JSON files
 - **Full-height snap preview** with pixel dimensions shown on hover
-- **DPI-aware** (PerMonitorV2) — works on mixed-DPI multi-monitor setups
-- **Click-through overlay** — never steals focus or interferes with your drag
-- **System tray only** — no visible window, runs silently in the background
+- **DPI-aware** (PerMonitorV2) - works on mixed-DPI multi-monitor setups
+- **Click-through overlay** - never steals focus or interferes with your drag
+- **System tray only** - no visible window, runs silently in the background
+- **Run at Startup** toggle - enable/disable from the tray menu or via the installer
+- **Windows installer** - proper install/uninstall with auto-startup support
 - **~200 KB** framework-dependent exe (or ~70 MB self-contained)
 
 ---
@@ -67,7 +70,7 @@ dotnet run -c Release
 | **Shift + Drag** a window | Grid overlay appears |
 | **Hover** over a zone | Zone highlights, full-height snap preview shown |
 | **Release mouse** on a zone | Window snaps to that column (full height) |
-| **Release Shift** while dragging | Cancel — overlay hides, no snap |
+| **Release Shift** while dragging | Cancel - overlay hides, no snap |
 
 ### System Tray Menu (right-click)
 
@@ -76,6 +79,7 @@ dotnet run -c Release
 | **Create / Edit Grid** | Open the grid editor to add, remove, reorder rows |
 | **Load Grid from File…** | Import a `.screengrid` JSON layout |
 | **Reset Grid to Defaults** | Restore all 5 built-in grid rows |
+| **Run at Startup** | Toggle Windows startup registration (checked = enabled) |
 | **How to use** | Quick usage guide |
 | **Exit** | Close ScreenGrid |
 
@@ -86,8 +90,8 @@ dotnet run -c Release
 Right-click the tray icon → **Create / Edit Grid** to open the editor:
 
 - Use **preset buttons** to quickly add common rows (Halves, Thirds, 4:3, etc.)
-- Click **+ Custom…** to enter any ratio — e.g. `3:2:1` or `16:9`
-- **Reorder** rows with ▲/▼ — top row appears at the top of the overlay
+- Click **+ Custom…** to enter any ratio - e.g. `3:2:1` or `16:9`
+- **Reorder** rows with ▲/▼ - top row appears at the top of the overlay
 - **Rename** rows to anything you like
 - Click **Apply & Close** to activate immediately
 - Click **Save to File…** to export and share your layout
@@ -174,13 +178,32 @@ dotnet publish -c Release -r win-x64 --no-self-contained -p:PublishSingleFile=tr
 dotnet publish -c Release -r win-x64 --self-contained -p:PublishSingleFile=true -o ./publish
 ```
 
+### Installer (~66 MB, includes auto-startup)
+
+Requires [Inno Setup 6](https://jrsoftware.org/isinfo.php):
+
+```powershell
+# First publish the self-contained exe (above), then:
+& "C:\Program Files (x86)\Inno Setup 6\ISCC.exe" installer/ScreenGridSetup.iss
+# Output: installer-output/ScreenGridSetup.exe
+```
+
 ---
 
 ## Run at Windows Startup
 
-1. Build or download the exe
-2. Press `Win+R` → type `shell:startup` → Enter
-3. Create a shortcut to `ScreenGrid.exe` in that folder
+**Option A: Use the installer** (recommended)
+
+Download `ScreenGridSetup.exe` — during installation, the "Run at startup" option is checked by default.
+
+**Option B: Toggle from the app**
+
+Right-click the tray icon → check **Run at Startup**. This writes to `HKCU\...\Run` (current user only, no admin required).
+
+**Option C: Manual shortcut**
+
+1. Press `Win+R` → type `shell:startup` → Enter
+2. Create a shortcut to `ScreenGrid.exe` in that folder
 
 ---
 
@@ -195,17 +218,19 @@ ScreenGrid/
 ├── GridConfig.cs               # Grid layout model, JSON serialization
 ├── GridZone.cs                 # Individual snap zone model
 ├── NativeMethods.cs            # Win32 P/Invoke declarations
+├── StartupManager.cs           # Windows startup registry management
 ├── ScreenGrid.csproj           # .NET 9 WPF project
-└── tests/                      # xUnit test suite (54 tests)
+├── installer/                  # Inno Setup installer script
+└── tests/                      # xUnit test suite
 ```
 
 **Key Win32 APIs:**
-- `SetWinEventHook` — detects window drag start/end system-wide
-- `GetAsyncKeyState` — polls Shift key state at 60 fps
-- `GetCursorPos` — tracks cursor position during drag
-- `MoveWindow` — snaps the window to the target zone
-- `DwmGetWindowAttribute` — compensates for invisible DWM borders
-- `GetMonitorInfo` / `GetDpiForMonitor` — multi-monitor and DPI support
+- `SetWinEventHook` - detects window drag start/end system-wide
+- `GetAsyncKeyState` - polls Shift key state at 60 fps
+- `GetCursorPos` - tracks cursor position during drag
+- `MoveWindow` - snaps the window to the target zone
+- `DwmGetWindowAttribute` - compensates for invisible DWM borders
+- `GetMonitorInfo` / `GetDpiForMonitor` - multi-monitor and DPI support
 
 ---
 
@@ -217,4 +242,4 @@ Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines
 
 ## License
 
-[MIT](LICENSE) — free to use, modify, and distribute.
+[MIT](LICENSE) - free to use, modify, and distribute.

ScreenGrid.csproj

@@ -10,6 +10,7 @@
     <RootNamespace>ScreenGrid</RootNamespace>
     <AssemblyName>ScreenGrid</AssemblyName>
     <Nullable>enable</Nullable>
+    <ApplicationIcon>docs\screengrid.ico</ApplicationIcon>
 
     <!-- Publish optimization -->
     <IncludeNativeLibrariesForSelfExtract>true</IncludeNativeLibrariesForSelfExtract>

StartupManager.cs

@@ -0,0 +1,82 @@
+using System;
+using System.Diagnostics;
+using Microsoft.Win32;
+
+namespace ScreenGrid
+{
+    /// <summary>
+    /// Manages Windows startup registration via the current-user Run registry key.
+    /// </summary>
+    internal static class StartupManager
+    {
+        private const string RunKey = @"SOFTWARE\Microsoft\Windows\CurrentVersion\Run";
+        private const string AppName = "ScreenGrid";
+
+        /// <summary>Returns true if ScreenGrid is registered to run at Windows startup.</summary>
+        public static bool IsRegistered()
+        {
+            try
+            {
+                using var key = Registry.CurrentUser.OpenSubKey(RunKey, false);
+                return key?.GetValue(AppName) is string;
+            }
+            catch (Exception ex)
+            {
+                Debug.WriteLine($"StartupManager.IsRegistered error: {ex.Message}");
+                return false;
+            }
+        }
+
+        /// <summary>Registers the current exe to run at Windows startup.</summary>
+        public static void Register()
+        {
+            try
+            {
+                string exePath = Environment.ProcessPath
+                    ?? Process.GetCurrentProcess().MainModule?.FileName
+                    ?? throw new InvalidOperationException("Cannot determine exe path");
+
+                using var key = Registry.CurrentUser.OpenSubKey(RunKey, true)
+                    ?? throw new InvalidOperationException("Cannot open Run registry key");
+
+                key.SetValue(AppName, $"\"{exePath}\"");
+            }
+            catch (Exception ex)
+            {
+                Debug.WriteLine($"StartupManager.Register error: {ex.Message}");
+                throw;
+            }
+        }
+
+        /// <summary>Removes the startup registration.</summary>
+        public static void Unregister()
+        {
+            try
+            {
+                using var key = Registry.CurrentUser.OpenSubKey(RunKey, true);
+                if (key?.GetValue(AppName) != null)
+                    key.DeleteValue(AppName, false);
+            }
+            catch (Exception ex)
+            {
+                Debug.WriteLine($"StartupManager.Unregister error: {ex.Message}");
+                throw;
+            }
+        }
+
+        /// <summary>Toggles the startup registration and returns the new state.</summary>
+        public static bool Toggle()
+        {
+            if (IsRegistered())
+            {
+                Unregister();
+                return false;
+            }
+            else
+            {
+                Register();
+                return true;
+            }
+        }
+    }
+}