v1.1

Author: NSTechBytes

KeyCodeInfo/AssemblyInfo.cs

@@ -2,7 +2,7 @@
 using System.Runtime.CompilerServices;
 
 [assembly: AssemblyCopyright("© 2024 - NS Tech Bytes 🇵🇰")]
-[assembly: AssemblyVersion("1.0")]
+[assembly: AssemblyVersion("1.1.0.0")]
 
 // Do not change the entries below!
 #if X64

KeyCodeInfo/KeyCodeInfo.cs

@@ -11,7 +11,7 @@ namespace KeyCodeInfoPlugin
     internal class Measure
     {
         private API _api;
-      
+
         private static IntPtr _hookID = IntPtr.Zero;
         private static LowLevelKeyboardProc _proc = HookCallback;
         private static Measure instance;
@@ -26,6 +26,12 @@ internal class Measure
         private const int WM_SYSKEYDOWN = 0x0104;
         private const int WM_KEYUP = 0x0101;
         private const int WM_SYSKEYUP = 0x0105;
+        private static string lastCombo = "";
+
+        // New field for the OnReleaseKeyAction parameter.
+        private string onReleaseKeyAction = "";
+        // Flag to ensure the release action is triggered only once per key press cycle.
+        private bool releaseActionTriggered = false;
 
         // Parameters:
         // showCodeMode:
@@ -35,30 +41,29 @@ internal class Measure
         //   4 = return key combination (e.g., "Ctrl + Alt + A") in order of press.
         private int showCodeMode;
         // hideForce: for modes 0, 1, and 3, if true the stored key is cleared immediately.
-        // For mode 4 (combination), keys remain until they are released.
+        // For mode 4 (combination), keys remain until released.
         private bool hideForce;
 
         /// <summary>
         /// Reload is called when Rainmeter reloads the skin.
-        /// It reads ShowCode and HideForce options and resets stored key data.
+        /// It reads ShowCode, HideForce, and OnReleaseKeyAction options and resets stored key data.
         /// (Note: the hook and update timer are not started automatically.)
         /// </summary>
         internal void Reload(API api, ref double maxValue)
         {
             _api = api;
-            // Store the instance reference for use in the static hook callback.
             instance = this;
 
-            // Read ShowCode parameter; default is 1 (numeric).
-            // Other supported values: 3 for hex, 0 for friendly names, 4 for combination.
             showCodeMode = api.ReadInt("ShowCode", 1);
-            // Read HideForce parameter; default is 1 (clear immediately).
             hideForce = api.ReadInt("HideForce", 1) == 1;
+            // Read the new OnReleaseKeyAction parameter (default to empty string).
+            onReleaseKeyAction = api.ReadString("OnReleaseKeyAction", "");
 
-            // Reset stored key data.
             lastKeyCode = 0;
             pressedKeyEvents.Clear();
             pressedKeyOrder.Clear();
+            // Reset the release flag
+            releaseActionTriggered = false;
 
             _api.Log(API.LogType.Debug, "KeyCodeInfo.dll: Plugin reloaded in stopped state.");
         }
@@ -85,9 +90,14 @@ internal string GetString()
         {
             if (showCodeMode == 4)
             {
-                // Build combination string using press order.
+                // If no keys are currently pressed, and HideForce is off,
+                // return the last stored combination.
                 if (pressedKeyOrder.Count == 0)
+                {
+                    if (!hideForce && !string.IsNullOrEmpty(lastCombo))
+                        return lastCombo;
                     return "";
+                }
                 List<string> comboNames = new List<string>();
                 foreach (int key in pressedKeyOrder)
                 {
@@ -101,7 +111,8 @@ internal string GetString()
                         comboNames.Add(keyName);
                     }
                 }
-                return string.Join(" + ", comboNames);
+                lastCombo = string.Join(" + ", comboNames);
+                return lastCombo;
             }
             else
             {
@@ -170,13 +181,12 @@ internal void ExecuteCommand(string command)
                 // Start the update timer if not already running.
                 if (updateTimer == null)
                 {
-                    updateTimer = new Timer(50); // Timer interval in milliseconds.
+                    updateTimer = new Timer(100); // Timer interval in milliseconds.
                     updateTimer.Elapsed += (sender, e) =>
                     {
                         _api.Execute($"!UpdateMeasure  \"{measureName}\"");
                         _api.Execute($"!UpdateMeter  *");
                         _api.Execute($"!Redraw");
-                        // _api.Execute($"!Log  \"Updating : {measureName}\"");
                     };
                     updateTimer.AutoReset = true;
                     updateTimer.Start();
@@ -230,6 +240,7 @@ internal void Unload()
                 updateTimer = null;
                 _api.Log(API.LogType.Debug, "KeyCodeInfo.dll: Update timer stopped on Unload.");
             }
+            lastCombo = "";
         }
 
         // Sets up the low-level keyboard hook.
@@ -255,19 +266,20 @@ private static IntPtr HookCallback(int nCode, IntPtr wParam, IntPtr lParam)
                     int key = (int)kbStruct.vkCode;
                     lastKeyCode = key;
                     lastKeyEvent = kbStruct;
-                    // If the active instance is in combination mode, update tracking.
+                    // Reset the release flag for every key press
+                    if (instance != null)
+                        instance.releaseActionTriggered = false;
+                    // For combination mode, update tracking.
                     if (instance != null && instance.showCodeMode == 4)
                     {
                         if (pressedKeyEvents.ContainsKey(key))
                         {
-                            // Remove the key from the order list so it can be re-added at the end.
                             pressedKeyOrder.Remove(key);
                         }
                         pressedKeyEvents[key] = kbStruct;
                         pressedKeyOrder.Add(key);
                     }
                 }
-                // Handle key-up events.
                 else if (wParam == (IntPtr)WM_KEYUP || wParam == (IntPtr)WM_SYSKEYUP)
                 {
                     KBDLLHOOKSTRUCT kbStruct = (KBDLLHOOKSTRUCT)Marshal.PtrToStructure(lParam, typeof(KBDLLHOOKSTRUCT));
@@ -279,6 +291,22 @@ private static IntPtr HookCallback(int nCode, IntPtr wParam, IntPtr lParam)
                             pressedKeyEvents.Remove(key);
                         }
                         pressedKeyOrder.Remove(key);
+                        // In combination mode, trigger the action only when all keys are released.
+                        if (pressedKeyEvents.Count == 0 && !instance.releaseActionTriggered && !string.IsNullOrEmpty(instance.onReleaseKeyAction))
+                        {
+                            instance._api.Execute(instance.onReleaseKeyAction);
+                            instance.releaseActionTriggered = true;
+                        }
+                    }
+                    else if (instance != null)
+                    {
+                        // For non-combination modes, trigger the action on every key-up,
+                        // but only once per key press cycle.
+                        if (!instance.releaseActionTriggered && !string.IsNullOrEmpty(instance.onReleaseKeyAction))
+                        {
+                            instance._api.Execute(instance.onReleaseKeyAction);
+                            instance.releaseActionTriggered = true;
+                        }
                     }
                 }
             }

README.md

@@ -1,7 +1,7 @@
-
 # KeyCodeInfo Plugin
 
 **KeyCodeInfo** is a Rainmeter plugin written in C# that captures keyboard events and displays key information in various formats. It supports multiple output modes such as:
+
 - **Decimal Mode (ShowCode=1):** Displays the key code as a decimal number.
 - **Hexadecimal Mode (ShowCode=3):** Displays the key code in hexadecimal format (e.g., "0x4A").
 - **Friendly Name Mode (ShowCode=0):** Displays a friendly key name (e.g., "Space", "CapsLock", "Shift").
@@ -51,9 +51,10 @@ AccurateText=1
 
 [Metadata]
 Name=KeyCodeInfo - Key Combination Skin
-Author=Your Name
+Author=NS Tech Bytes
 Information=This skin demonstrates the KeyCodeInfo plugin in combination mode with a background.
-Version=1.0
+Version=1.1
+LICENSE=MIT LICENSE
 
 ;-------------------------------------------------
 ; Background
@@ -74,6 +75,7 @@ Plugin=KeyCodeInfo
 ShowCode=4
 ; Set HideForce=0 to retain the combination until keys are released
 HideForce=0
+OnReleaseKeyAction=[!Log "Key Release"]
 
 ;-------------------------------------------------
 ; Display the key combination
@@ -121,34 +123,37 @@ DynamicVariables=1
 ### Bang Commands
 
 - **Start the Plugin:**
+
   ```
   !CommandMeasure MeasureKeyCode "Start"
   ```
-  This command starts the keyboard hook, retrieves the measure name, and starts an update timer that forces the measure, all meters, and a redraw.
 
+  This command starts the keyboard hook, retrieves the measure name, and starts an update timer that forces the measure, all meters, and a redraw.
 - **Stop the Plugin:**
+
   ```
   !CommandMeasure MeasureKeyCode "Stop"
   ```
+
   This command stops the keyboard hook and the update timer.
 
 ### Parameter Options
 
-- **ShowCode Parameter:**  
+- **ShowCode Parameter:**
+
   - `0` - Friendly key names.
   - `1` - Decimal key code.
   - `3` - Hexadecimal key code.
   - `4` - Key combination (displays keys in the order pressed).
+- **HideForce Parameter:**
 
-- **HideForce Parameter:**  
   - `1` (default) - Clears key data immediately after reading (for modes 0, 1, and 3).
   - `0` - Retains the last key until a new key press occurs (useful for combination mode).
 
 ## Troubleshooting
 
-- **Key Not Displaying:**  
-  Ensure that the DLL is placed in the correct plugins folder and that Rainmeter has been refreshed.
-- **Build Issues:**  
+- **Key Not Displaying:**Ensure that the DLL is placed in the correct plugins folder and that Rainmeter has been refreshed.
+- **Build Issues:**
   Verify that you have installed the necessary DllExporter tool and that your project settings match your target platform (x86 or x64).
 
 ## Contributing