Kaleidoscope/README.md

Kaleidoscope-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-LED-ActiveModColor.h>

void setup () {
  Kaleidoscope.use(&ActiveModColorEffect);

  Kaleidoscope.setup ();

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

It is recommended to place the activation (the Kaleidoscope.use call) 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 property:

.highlight_color

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

.oneshot_only

A flag one can set to tell the plugin that they are using one-shot modifiers and layers only. This allows it to take some shortcuts, and optimize performance, at the cost of not highlighting any non-oneshot keys it otherwise would.

Defaults to false.

Dependencies

• Kaleidoscope-LEDControl
• Kaleidoscope-OneShot

Further reading

Starting from the example is the recommended way of getting started with the plugin.