Merge pull request #31 from RuntimeRascal/copilot/rework-f1-help-closing-behavior

Implement F1 help toggle with conditional ESC behavior

Author: RuntimeRascal

CHANGELOG.md

@@ -6,6 +6,24 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## v1.0.12
+
+### Added
+- **F1 Help Toggle Behavior**
+  - `F1` now toggles the keyboard shortcuts help overlay on and off instead of auto-hiding after a timeout
+  - Help overlay stays visible until explicitly closed with `F1` or `ESC`
+  - New tests cover help toggle and ESC behavior to prevent regressions
+
+### Changed
+- **ESC Key Behavior with Help Open**
+  - Pressing `ESC` while help is visible now only closes the help overlay and **does not** exit drawing mode
+  - Pressing `ESC` when help is hidden still performs the normal emergency exit from drawing mode
+  - Centralized ESC handling in `OverlayWindow` so drawing manager respects whether it should actually exit
+- **Docs**
+  - Updated the project README
+  - Added CONTRIBUTING document
+
+
 ## v1.0.11
 
 ### Added

Installer/GhostDraw.Installer.wixproj

@@ -1,6 +1,6 @@
 <Project Sdk="WixToolset.Sdk/4.0.5">
   <PropertyGroup>
-    <Version Condition="'$(Version)' == ''">1.0.11</Version>
+    <Version Condition="'$(Version)' == ''">1.0.12</Version>
     <OutputName>GhostDrawSetup-$(Version)</OutputName>
     <OutputType>Package</OutputType>
     <Platform>x64</Platform>

README.md

@@ -13,8 +13,7 @@
 
 [**Download Latest Release**](https://github.com/RuntimeRascal/ghost-draw/releases) | [**Report Bug**](https://github.com/RuntimeRascal/ghost-draw/issues) | [**Request Feature**](https://github.com/RuntimeRascal/ghost-draw/issues)
 
-![GhostDraw Demo](docs/Demo.gif)
-<!-- TODO: Add animated GIF showing drawing on screen -->
+![GhostDraw Demo](docs/GhostDrawDemo.gif)
 
 </div>
 
@@ -44,12 +43,6 @@
 - **Right-Click Color Cycling** - Quickly switch between your palette colors
 - **Position-Numbered Palette** - Easily organize and reorder your favorite colors
 
-### 🛡️ **Safety & Stability**
-- **Fail-Safe Design** - Won't lock you out of your system if it crashes
-- **Fast Input Processing** - All hooks complete in < 5ms for responsive system
-- **Graceful Error Handling** - Protected critical paths ensure stability
-- **Proper Resource Cleanup** - Memory and hooks always released properly
-
 ---
 
 ## 📸 Screenshots
@@ -59,22 +52,19 @@
 
 Customize every aspect of GhostDraw with the intuitive settings panel:
 - Color palette management with add/remove/reorder
+- ![Color Cycling](docs/ColorPalette.png)
 - Brush thickness range configuration
 - Hotkey customization
 - Drawing mode selection
 - Logging level control
 
-### Active Drawing Mode
-![Drawing Mode](docs/DrawingMode.png)
-<!-- TODO: Add screenshot of drawing overlay in action with colored strokes -->
+### Help (F1)
+![Drawing Mode](docs/Help.png)
+
 
-### Color Palette Cycling
-![Color Cycling](docs/ColorCycling.png)
-<!-- TODO: Add screenshot showing color palette with active color indicator -->
 
 ### System Tray Integration
-![System Tray](docs/SystemTray.png)
-<!-- TODO: Add screenshot of system tray icon and context menu -->
+![System Tray](docs/Tray.png)
 
 ---
 

Src/GhostDraw/App.xaml.cs

@@ -347,11 +347,11 @@ private void OnHelpPressed(object? sender, EventArgs e)
     {
         try
         {
-            // Show help overlay if drawing mode is active
+            // Toggle help overlay if drawing mode is active
             if (_drawingManager?.IsDrawingMode == true)
             {
-                _logger?.LogInformation("F1 pressed - showing help");
-                _drawingManager?.ShowHelp();
+                _logger?.LogInformation("F1 pressed - toggling help");
+                _drawingManager?.ToggleHelp();
             }
         }
         catch (Exception ex)

Src/GhostDraw/GhostDraw.csproj

@@ -8,7 +8,7 @@
     <UseWPF>true</UseWPF>
     <UseWindowsForms>true</UseWindowsForms>
     <ApplicationIcon>Assets\favicon.ico</ApplicationIcon>
-    <Version>1.0.11</Version>
+    <Version>1.0.12</Version>
     <EnableWindowsTargeting>true</EnableWindowsTargeting>
   </PropertyGroup>
 

Src/GhostDraw/Managers/DrawingManager.cs

@@ -148,15 +148,29 @@ public void ForceDisableDrawing()
     {
         try
         {
-            _logger.LogInformation("Force disabling drawing mode (ESC pressed)");
-            _isDrawingLocked = false;
-            _overlayWindow.DisableDrawing();
-            _overlayWindow.Hide();
+            _logger.LogInformation("ESC pressed - checking help visibility");
 
-            // Notify hook that drawing mode is inactive
-            _keyboardHook.SetDrawingModeActive(false);
+            // Check if help is visible and handle accordingly
+            bool shouldExitDrawingMode = _overlayWindow.HandleEscapeKey();
 
-            _logger.LogDebug("Drawing mode force disabled");
+            if (shouldExitDrawingMode)
+            {
+                // Help was not visible, or user wants to exit - force disable drawing mode
+                _logger.LogDebug("Force disabling drawing mode");
+                _isDrawingLocked = false;
+                _overlayWindow.DisableDrawing();
+                _overlayWindow.Hide();
+                
+                // Notify hook that drawing mode is inactive
+                _keyboardHook.SetDrawingModeActive(false);
+                
+                _logger.LogDebug("Drawing mode force disabled");
+            }
+            else
+            {
+                // Help was visible and has been closed - stay in drawing mode
+                _logger.LogDebug("ESC only closed help - remaining in drawing mode");
+            }
         }
         catch (Exception ex)
         {
@@ -348,25 +362,25 @@ public void SetCircleTool()
     }
 
     /// <summary>
-    /// Shows the help popup with keyboard shortcuts
+    /// Toggles the help popup with keyboard shortcuts
     /// </summary>
-    public void ShowHelp()
+    public void ToggleHelp()
     {
         try
         {
             if (_overlayWindow.IsVisible)
             {
-                _overlayWindow.ShowHelp();
-                _logger.LogInformation("Help popup shown");
+                _overlayWindow.ToggleHelp();
+                _logger.LogDebug("Help popup toggled");
             }
             else
             {
-                _logger.LogDebug("ShowHelp ignored - overlay not visible");
+                _logger.LogDebug("ToggleHelp ignored - overlay not visible");
             }
         }
         catch (Exception ex)
         {
-            _logger.LogError(ex, "Failed to show help");
+            _logger.LogError(ex, "Failed to toggle help");
             // Don't re-throw - not critical
         }
     }

Src/GhostDraw/Views/OverlayWindow.xaml

@@ -322,7 +322,7 @@
                     <TextBlock FontFamily="Segoe UI"
                                FontSize="16"
                                Foreground="#B0B0B0"
-                               Text="Exit Draw Mode"/>
+                               Text="Close Help / Exit Draw Mode"/>
                 </StackPanel>
 
                 <StackPanel Orientation="Horizontal" Margin="0,0,0,0">
@@ -336,7 +336,7 @@
                     <TextBlock FontFamily="Segoe UI"
                                FontSize="16"
                                Foreground="#B0B0B0"
-                               Text="Show This Help"/>
+                               Text="Toggle This Help"/>
                 </StackPanel>
             </StackPanel>
         </Border>