A command-line RGB Keyboard backlight control program for CLEVO & Tongfang based laptops.
This is a cleaner, more organized, and efficient version of the initial program. It is designed to provide enhanced features for customizing CLEVO & Tongfang based laptop keyboards with RGB lighting, supporting devices with 1-zone, 3-zone keyboards and devices with RGB Lightbars. The program also includes a variety of animated effects to enhance your keyboard’s visual experience.
- Support for CLEVO & Tongfang based systems with the following RGB components:
- RGB 3-zone keyboards.
- RGB 1-zone keyboards.
- RGB Lightbars.
- Predefined Animated Effects:
- 🌈 Fading Colors: Smooth color transitions (predefined themes).
- 🎥 Optimized Animations: Enhanced visual effects using animation objects.
- ⏱️ Custom Speed: Change the speed to make an animation faster or slower.
CLEVO_KeyboardColour.exe if you're using a Single-Zone keyboard.
How do I request for support? - Please report it here.
What systems are supported? - This program is built for laptops based off of the CLEVO / Tongfang ODM design - For a list of supported CLEVO Models, please take a look at the releases
How do I get more themes? - Please create an issue and request for it here
Does this program have a GUI? - No. The intention of this program is to be a lightweight app to enable keyboard themes on your system without the need for the bloatware included with the Control Center. This program does not intend to be a complete replacement of the software shipped with your system.
How long does it take to add support for my system? - Depends on your device. In most cases (If GitHub notifications worked properly), I can add support for certain models of laptop and create a new release within an hour. On certain occassions (depending on the device) it can take 24-hours or more, but I will ensure this is communicated with you when that is the case.
NOTE: Please bear in mind, I am the sole developer for this project, and although on occassion there maybe a single code contribution, the majority of the time, it is only me adding support and servicing requests for this project. Therefore some requests may take longer than expected, if I am not available. Thank you for your understanding!
The following commands are supported and can be executed via Command Prompt or PowerShell.
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 [theme] --speed [speed] [--dmm] [--hide]
.\CLEVO_KeyboardColour.exe inbuilt [theme] [--dmm] [--hide] (3-Zone keyboards only)
.\CLEVO_KeyboardColour.exe backlight [on/off] [--dmm] [--hide]
.\CLEVO_KeyboardColour.exe colour [hexColour] [--dmm] [--hide]
.\CLEVO_KeyboardColour.exe colours [hexColour] [hexColour] [hexColour] [--dmm] [--hide] (3-Zone keyboards only)
.\CLEVO_KeyboardColour.exe lightbar [hexColour] [--dmm] [--hide]-
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).
-
Set backlight colour to Red:
.\CLEVO_KeyboardColour.exe colour 0xff0000❤️ Turns the keyboard backlight Red.
-
Set backlight colour to Green:
.\CLEVO_KeyboardColour.exe colour 0x00ff00💚 Turns the keyboard backlight Green.
-
Set backlight colour to Blue:
.\CLEVO_KeyboardColour.exe colour 0x0000ff💙 Turns the keyboard backlight Blue.
-
Set backlight colour to custom "Sakura Pink":
.\CLEVO_KeyboardColour.exe colour 0xff6ea8🩷 Turns the keyboard backlight "Sakura Pink".
-
Set RGB colour to individual zones (3-Zone keyboards ONLY):
.\CLEVO_KeyboardColour.exe colours 0xff0000 0x00ff00 0x0000ff🌈 Sets the Left zone to Red, the middle zone to Green and right zone to Blue on the keyboard (3-Zone keyboards ONLY)
-
Set lightbar colour to Red:
.\CLEVO_KeyboardColour.exe lightbar 0xff0000❤️ Turns the lightbar Red.
-
Set lightbar colour to Green:
.\CLEVO_KeyboardColour.exe lightbar 0x00ff00💚 Turns the lightbar Green.
-
Set lightbar colour to Blue:
.\CLEVO_KeyboardColour.exe lightbar 0x0000ff💙 Turns the lightbar Blue.
This command works in the same way as the colour command - For more info, please read the 'Custom Colour Operations' section.
-
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.
-
Sakura Transform (Pink & Violet colour sweep):
.\CLEVO_KeyboardColour.exe theme sakuratransform🩷 💙 Makes the keyboard lights sweep through various shades of Pink & Violet.
-
Sakura Sunset (Pink colour sweep):
.\CLEVO_KeyboardColour.exe theme sakurasunset🩷 Makes the keyboard lights transition through Sakura Pink & Sunset Pink colours.
-
Sunset Breathe:
.\CLEVO_KeyboardColour.exe theme sunsetbreathe🌅 Enables a Sunset Pink breathing effect (smooth inhale/exhale transition pattern).
-
Pink Breathe:
.\CLEVO_KeyboardColour.exe theme pinkbreathe🫁 Enables a Pink breathing effect (smooth inhale/exhale transition pattern).
-
Colour Wave:
.\CLEVO_KeyboardColour.exe theme colourwave🏄 Enables an RGB colour wave effect over the 3 keyboard zones (designed for 3-zone keyboards only!).
-
Awesome:
.\CLEVO_KeyboardColour.exe theme awesome😎 Cycles through all of the supported animations for the device.
-
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).
-
Slower
.\CLEVO_KeyboardColour.exe theme colourtransform --speed 50🌈 Creates a slow rainbow sweep effect with smooth transitions at 50% speed.
-
Faster
.\CLEVO_KeyboardColour.exe theme colourtransform --speed 200🌈 Creates a fast rainbow sweep effect with smooth transitions at 200% speed.
This is an optional argument, and it will default to the standard speed if not provided.
Device Monitor mode is a feature for power users and developers to display extended console output of the in-flight data that is sent to the device when performing keyboard operations.
.\CLEVO_KeyboardColour.exe theme colourtransform --dmmPlays the requested 'colourtransform' theme, while the console outputs the in-flight data being processed by the device.
.\CLEVO_KeyboardColour.exe theme colourtransform --speed 150 --dmmPlays the requested 'colourtransform' theme at 150% speed, while the console outputs the in-flight data being processed by the device.
.\CLEVO_KeyboardColour.exe backlight on --dmmTurns off the backlight for all detected devices on the system, and outputs the in-flight data being processed by the device.
This is an optional argument, and will not display the extended console output if the argument is not provided.
If you wish to run this program on (in the background), there are multiple approaches that can be used to hide the CLI Window.
On Startup (as a background application)
-
Adjust the command line in "Scripts\StartClevoKB.cmd" to play your favourite theme.
-
Please run the "Scripts\RegisterClevoKbOnBoot.cmd" script AS ADMINISTRATOR and follow it's instructions. (Please use Scripts\UnregisterClevoKbOnBoot.cmd to deregister it from startup.)
For hidden mode
- Append the "--hide" argument to your requested theme command-line before launching.
NOTE: Please use Task Manager to locate close the application to play other themes.
-
Download the release which contains the version of the program that supports your system.
-
Open a Command Prompt in Administrator mode:
- Search for "Command Prompt" in the Windows search bar.
- Right-click and select Run as Administrator.
-
Again, be sure that the InsydeDCHU.dll file is in the same directory as
CLEVO_KeyboardColour.exeif you're using a Single-Zone keyboard. -
Run the desired command using the syntax:
.\CLEVO_KeyboardColour.exe theme/inbuilt/backlight/lightbar/colour(s) [argument] [--speed <speed>] [--dmm] [--hide]
To activate the 'breathing' effect, run:
.\CLEVO_KeyboardColour.exe theme breatheTo activate an effect for a single iteration, add the --once argument:
.\CLEVO_KeyboardColour.exe theme breathe --onceNOTE: This will run the theme once, and stop. Use this command line if you want to experiment with the available themes.
To enable 'Device Monitor Mode' for the 'breathing' effect, run:
.\CLEVO_KeyboardColour.exe theme breathe --dmmNOTE: This argument will have a performance impact when provided and is therefore only recommended for debugging purposes.
To activate the inbuilt 'Wave' effect, run:
.\CLEVO_KeyboardColour.exe inbuilt KB_MODE_WAVENOTE: This command does not support the --once argument.
To activate an effect to run in the background, add the --hide argument:
.\CLEVO_KeyboardColour.exe theme breathe --hideNOTE: This will run the 'breathe' theme, and hide the command-line window. Please use Task Manager to locate and close the application to play other themes.
To turn off the keyboard backlight, run:
.\CLEVO_KeyboardColour.exe backlight offNOTE: This command does not support the --once argument.
- Compatible CLEVO & Tongfang based devices:
- RGB 1-zone or 3-zone lighting.
- RGB Lightbar lighting.
- For 1-zone keyboards, the InsydeDCHU.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.
This is an unofficial, non-commercial project. CLEVO, Tongfang, Insyde and related names or binaries (except CLEVO_KeyboardColour.exe), are property of CLEVO. This project is not affiliated with, endorsed by, or sponsored by CLEVO, Tongfang or Insyde.
- Feedback, suggestions, and contributions are highly appreciated to help improve the project.
- Found an issue or a bug? Please report it here.