CD2H gitForager

keyboardio/Kaleidoscope-LED-ActiveModColor

Name: Kaleidoscope-LED-ActiveModColor

Owner: Keyboardio

Description: Highlight active modifiers

Created: 2017-01-21 09:46:44.0

Updated: 2018-05-15 05:14:20.0

Pushed: 2018-05-15 05:14:22.0

Homepage: null

Size: 42

Language: C++

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

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.

lude <Kaleidoscope.h>
lude <Kaleidoscope-LEDControl.h>
lude <Kaleidoscope-LED-ActiveModColor.h>

IDOSCOPE_INIT_PLUGINS(LEDControl,
                      ActiveModColorEffect);

 setup () {
leidoscope.setup ();

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

`.sticky_color`

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