From c4ad1faf7f618e89d615bf735b308e9641122f58 Mon Sep 17 00:00:00 2001 From: RedxzAnomaly Date: Mon, 23 Dec 2024 12:46:50 +0000 Subject: [PATCH 1/3] Update README.md --- README.md | 108 +++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 99 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 0cf80b1..600fb63 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,105 @@ -## CLEVO Keyboard Colour Program (C++) +# CLEVO Keyboard Colour Program (C++) -***C++ version of the "keyboard-colour-program"*** +**A C++ version of the original "keyboard-colour-program" developed in C#.** -A much cleaner and simpler version of the initial program that I created in C# +This is a cleaner, more organized, and efficient version of the initial program. It is designed to provide enhanced features for customizing CLEVO keyboards with **RGB** lighting, supporting both **3-zone** and **1-zone** keyboards. The program also includes a variety of animated effects to enhance your keyboard’s visual experience. -I will be adding more functionality later on, but for now... HERE IT IS! +--- -Feature List: -Supports 3 zone RGB lighting CLEVO laptop keyboards. -Added support for Animation objects. +## 🎨 Current Features -Make sure you run this program **AS ADMINISTRATOR** because, WMI will fail if it cannot get administrator privileges... +- **Support for CLEVO keyboards:** + - **RGB 3-zone keyboards**. + - **RGB 1-zone keyboards**. +- **Predefined Animated Effects:** + - 🌈 **Fading Colors:** Smooth color transitions (predefined themes). + - πŸŽ₯ **Optimized Animations:** Enhanced visual effects using animation objects. -**This currently has already got a pre-made theme that fades colours, I will be working to optimise it later (CAUTION: It take 15% - 20% CPU utilisation at some points)** +⚠️ **Important Note:** Ensure you run this program **as an administrator**, as Windows Management Instrumentation (WMI) requires administrative privileges to function properly. + +⚠️ **Warning:** The predefined fading theme may utilize **15% to 20% of CPU** at certain times. This will be optimized in future updates. + +--- + +## πŸ”§ Functional Commands + +The following commands are supported and can be executed via the **Command Prompt**. + +### πŸ–₯️ General Syntax: +Navigate to the folder containing the executable files (e.g., `CppKeyboardColour/Test/Build/`) and run the commands in **administrator mode**. To execute the `.exe` files, prepend the `.\` before the command. + +```bash +.\KBInsydeColours.exe theme [themeName] +``` + +### 🎨 Supported Themes: +- **Breathing Effect:** + ```bash + .\KBInsydeColours.exe theme breathe + ``` + 🌬️ Enables a breathing effect (smooth pulsing transitions between colors). + +- **Colourshift:** + ```bash + .\KBInsydeColours.exe theme colourshift + ``` + πŸ”„ Alternates colors for **RGB** keyboards (designed for 3-zone keyboards). + +- **New Colour Breathe:** + ```bash + .\KBInsydeColours.exe theme newcolourbreathe + ``` + πŸŒ€ A custom theme designed for **@mehrshad315**, featuring an additional blue tone. + +- **Colour Transform (Rainbow Sweep):** + ```bash + .\KBInsydeColours.exe theme colourtransform + ``` + 🌈 Creates a rainbow sweep effect with smooth transitions. + +- **Blink (Pulsating Blink):** + ```bash + .\KBInsydeColours.exe theme blink + ``` + ✨ Makes the keyboard lights blink in a pulsating pattern. + +--- + +## πŸ› οΈ How to Use + +1. Navigate to the folder containing the executable files: + ``` + CppKeyboardColour/Test/Build/ + ``` + +2. Open a **Command Prompt** in Administrator mode: + - Search for "Command Prompt" in the Windows search bar. + - Right-click and select **Run as Administrator**. + +3. Run the desired command using the syntax: + ``` + .\KBInsydeColours.exe theme [themeName] + ``` + +Example: +To activate the breathing effect, run: +```bash +.\KBInsydeColours.exe theme breathe +``` + +--- + +## πŸ“‹ Requirements + +- **Compatible CLEVO keyboards:** + - **RGB 1-zone** or **3-zone** lighting. +- **Administrator Permissions:** Ensure the program is run as administrator to avoid WMI failures. + +--- + +## πŸ“Œ Final Notes + +- This is an initial version of the program, and more features (including better optimization for 1-zone keyboards) will be added in future updates. +- Feedback, suggestions, and contributions are highly appreciated to help improve the project. + +--- From 879f1339f7038654b3f3defaf0ba690753669a70 Mon Sep 17 00:00:00 2001 From: RedxzAnomaly Date: Mon, 23 Dec 2024 16:47:11 +0000 Subject: [PATCH 2/3] Update README.md --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 600fb63..dd66e69 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,8 @@ This is a cleaner, more organized, and efficient version of the initial program. ⚠️ **Warning:** The predefined fading theme may utilize **15% to 20% of CPU** at certain times. This will be optimized in future updates. +⚠️ **Warning (2):** Ensure that the **InsydeDHCU.dll** file is in the same directory as `KBInsydeColours.exe` if you're using a **Single-Zone** keyboard. + --- ## πŸ”§ Functional Commands @@ -43,7 +45,7 @@ Navigate to the folder containing the executable files (e.g., `CppKeyboardColour ```bash .\KBInsydeColours.exe theme colourshift ``` - πŸ”„ Alternates colors for **RGB** keyboards (designed for 3-zone keyboards). + πŸ”„ Alternates colors for **RGB** keyboards (designed for 3-zone keyboards, but compatible with 1-zone as well). - **New Colour Breathe:** ```bash @@ -76,7 +78,9 @@ Navigate to the folder containing the executable files (e.g., `CppKeyboardColour - Search for "Command Prompt" in the Windows search bar. - Right-click and select **Run as Administrator**. -3. Run the desired command using the syntax: +3. **Ensure that the **InsydeDHCU.dll** file is in the same directory as `KBInsydeColours.exe` if you're using a **Single-Zone** keyboard**. + +4. Run the desired command using the syntax: ``` .\KBInsydeColours.exe theme [themeName] ``` @@ -93,6 +97,7 @@ To activate the breathing effect, run: - **Compatible CLEVO keyboards:** - **RGB 1-zone** or **3-zone** lighting. + - For **1-zone keyboards**, the **InsydeDHCU.dll** file must be in the same directory as `KBInsydeColours.exe`. - **Administrator Permissions:** Ensure the program is run as administrator to avoid WMI failures. --- From 2f0d5e168a734d4035028c3f3950420c8a4c0f91 Mon Sep 17 00:00:00 2001 From: RedxzAnomaly Date: Mon, 23 Dec 2024 16:48:13 +0000 Subject: [PATCH 3/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dd66e69..2acd7e8 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ Navigate to the folder containing the executable files (e.g., `CppKeyboardColour - Search for "Command Prompt" in the Windows search bar. - Right-click and select **Run as Administrator**. -3. **Ensure that the **InsydeDHCU.dll** file is in the same directory as `KBInsydeColours.exe` if you're using a **Single-Zone** keyboard**. +3. **Again, be sure that the **InsydeDHCU.dll** file is in the same directory as `KBInsydeColours.exe` if you're using a **Single-Zone** keyboard**. 4. Run the desired command using the syntax: ```