Skip to content

Latest commit

 

History

History
58 lines (32 loc) · 2.05 KB

README.md

File metadata and controls

58 lines (32 loc) · 2.05 KB
Raw

KeychronRGB

KeychronRGB

A simple TypeScript library which allows you to control the RGB lighting on the Keychron K10 Pro keyboard.

Requirements

Before you can use this library, you need to install its dependencies. This can be done by running the following command:

npm install

Additionally, a custom firmware has to be flashed onto the keyboard's microcontroller which allows LEDs to be adressed individually. The up-to-date list of compatible firmwares can be found on SRGBmods' repository and the flashing instructions are provided by Keychron.

Usage

To use this library, import the Keychron class from the src/keychron.ts file in your TypeScript code:

import * as Keychron from '../src/keychron';

Then, you can create a new Keychron.Keychron object and use its methods to control the RGB lighting on your keyboard.

Examples

This library includes several examples that demonstrate how to use the library. You can run these examples with the following command:

npm run example-[example_name]

Replace [example_name] with the name of the example you want to run. The available examples are:

Sphares

8mb.video-lhy-foFCLcdO.mp4

Snake (Can your gaming keyboard do THAT?)

8mb.video-gln-KSgSRmEf.mp4

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.