CLEVO Keyboard Colour Program (C++)

A C++ version of the original "keyboard-colour-program" developed 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 1-zone and 3-zone keyboards. The program also includes a variety of animated effects to enhance your keyboard’s visual experience.

---

🎨 Current Features

• 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.

⚠️ Important Note: This application requests for Administrator privileges. Please ensure you accept the Windows UAC prompt, as Windows Management Instrumentation (WMI) requires this to function correctly.

⚠️ Warning (1): Certain themes may utilize ~15% of CPU at certain times.

⚠️ Warning (2): Please ensure that the InsydeDCHU.dll file is in the same directory as CLEVO_KeyboardColour.exe if you're using a Single-Zone keyboard.

⚠️ Warning (3): Some anti-virus products may incorrectly flag this application as malware and quarantine the program. If this happens, please add the application to the AV exclusion list.

---

🔧 Functional Commands

The following commands are supported and can be executed via the Command Prompt.

🖥️ General Syntax:

Extract the program zip and run the commands as an administrator. To execute the .exe files, prepend the .\ before the command.

.\CLEVO_KeyboardColour.exe theme/inbuilt/backlight [argument]

---

⌨️ Backlight Operations:

• Turn Backlight Off:

  .\CLEVO_KeyboardColour.exe backlight off

  🖤 Turns off the keyboard backlight.

• Default Backlight:

  .\CLEVO_KeyboardColour.exe backlight on

  💙 Enables the default keyboard backlight colour (Solid Blue).

---

🎨 Supported Animations:

• Breathing Effect:

  .\CLEVO_KeyboardColour.exe theme breathe

  🌬️ Enables a breathing effect (smooth inhale/exhale transition pattern between colors).

• Colourshift:

  .\CLEVO_KeyboardColour.exe theme colourshift

  🔄 Alternates colors for RGB keyboards (designed for 3-zone keyboards only!).

• Fresh Breathe:

  .\CLEVO_KeyboardColour.exe theme freshbreathe

  🌀 A custom theme designed by @mehrshad315, featuring an additional blue tone.

• Colour Transform (Rainbow Sweep):

  .\CLEVO_KeyboardColour.exe theme colourtransform

  🌈 Creates a rainbow sweep effect with smooth transitions.

• Blink (Pulsating Blink):

  .\CLEVO_KeyboardColour.exe theme blink

  ✨ Makes the keyboard lights blink in a pulsating pattern.

• Heartbeat (Double Pulsating Blink):

  .\CLEVO_KeyboardColour.exe theme heartbeat

  💖 Makes the keyboard lights pulse red in a heartbeat pattern.

---

⚙️ Inbuilt Themes (3-Zone Keyboards ONLY):

• Breathing Effect:

  .\CLEVO_KeyboardColour.exe inbuilt KB_MODE_BREATHE

  🌬️ Enables a breathing effect (Smooth inhale/exhale pattern on a single colour).

• Wave Effect:

  .\CLEVO_KeyboardColour.exe inbuilt KB_MODE_WAVE

  🌊 Enables a colour wave effect (Various colours transition from Left -> Mid -> Right zone of the keyboard).

• Cycle Effect:

  .\CLEVO_KeyboardColour.exe inbuilt KB_MODE_CYCLE

  🔄 Enables a breathing effect with various colour (Smooth inhale/exhale pattern over various colours).

• Dance Effect:

  .\CLEVO_KeyboardColour.exe inbuilt KB_MODE_DANCE

  🕺 Enables a flashy side-to-side dancing effect with various colours.

• Flash Effect:

  .\CLEVO_KeyboardColour.exe inbuilt KB_MODE_FLASH

  🔦 Makes the entire keyboard blink in various colours.

• Tempo Effect:

  .\CLEVO_KeyboardColour.exe inbuilt KB_MODE_TEMPO

  🎶 Makes the keyboard lights 'dance' to the tempo of the music being played on the system (Keyboard tempo accuracy may vary on your system).

---

🛠️ How to Use

1. Download the release which contains the version of the program that supports your system.

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. Again, be sure that the InsydeDHCU.dll file is in the same directory as CLEVO_KeyboardColour.exe if you're using a Single-Zone keyboard.

4. Run the desired command using the syntax:

   .\CLEVO_KeyboardColour.exe theme/inbuilt/backlight [argument]
   

---

Examples:

To activate the 'breathing' effect, run:

.\CLEVO_KeyboardColour.exe theme breathe

To activate an effect for a single iteration, add the --once argument:

.\CLEVO_KeyboardColour.exe theme breathe --once

NOTE: This will run the theme once, and stop. Use this command line if you want to experiment with the available themes.

To activate the inbuilt 'Wave' effect, run:

.\CLEVO_KeyboardColour.exe inbuilt KB_MODE_WAVE

NOTE: This command does not support the --once argument.

⚠️ Warning (1): This will use the themes that are programmed directly into your system, thus this application has no control over the colours these inbuilt themes use.

⚠️ Warning (2): This is supported on 3-Zone keyboard ONLY.

To turn off the keyboard backlight, run:

.\CLEVO_KeyboardColour.exe backlight off

NOTE: This command does not support the --once argument.

---

📋 Requirements

• 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 CLEVO_KeyboardColour.exe.
• Administrator Permissions: This program requests for administrator privileges. Please ensure you accept the Windows UAC prompt 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.

---