History

Jesse Vincent efeea31589 More library tweaking to comply with arduino requirements		4 years ago
..
src	Migrate Kaleidoscope-LED-ActiveModColor to the plugins directory	4 years ago
README.md	Move most plugin READMEs back into the plugins	4 years ago
library.properties	More library tweaking to comply with arduino requirements	4 years ago

README.md

LED-ActiveModColor

With this plugin, any active modifier on the keyboard will have the LED under it highlighted. No matter how the modifier got activated (a key press, a macro, anything else), the coloring will apply. Layer keys, be them layer toggles, momentary switches, or one-shot layer keys count as modifiers as far as the plugin is concerned.

Using the plugin

To use the plugin, one needs to include the header, and activate the effect. It is also possible to use a custom color instead of the white default.

#include <Kaleidoscope.h>
#include <Kaleidoscope-LEDControl.h>
#include <Kaleidoscope-LED-ActiveModColor.h>

KALEIDOSCOPE_INIT_PLUGINS(LEDControl,
                          ActiveModColorEffect);

void setup () {
  Kaleidoscope.setup ();

  ActiveModColorEffect.highlight_color = CRGB(0x00, 0xff, 0xff);
}

It is recommended to place the activation (the KALEIDOSCOPE_INIT_PLUGINS parameter) of the plugin last, so that it can reliably override any other plugins that may work with the LEDs, and apply the highlight over those.

Plugin properties

The plugin provides the ActiveModColorEffect object, which has the following properties:

`.highlight_color`

The color to use for highlighting the modifiers. Defaults to a white color.

`.sticky_color`

The color to use for highlighting one-shot modifiers when they are sticky. Defaults to a red color.

Plugin methods

The ActiveModColorEffect object provides the following methods:

`.highlightNormalModifiers(bool)`

Can be used to enable or disable the highlighting of normal modifiers. Defaults to true.