From 589c2dd79929fd9a26d3e08e2e4d960f9112576f Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Wed, 17 Mar 2021 10:44:20 -0700 Subject: [PATCH] Get the two remaining files out of the plugins directory in docs to make it easier to ignore this dir --- docs/plugins/Kaleidoscope-TriColor.md | 35 ------------------- .../Kaleidoscope-LEDControl/README.md | 2 +- plugins/Kaleidoscope-LEDEffects/README.md | 33 +++++++++++++++++ 3 files changed, 34 insertions(+), 36 deletions(-) delete mode 100644 docs/plugins/Kaleidoscope-TriColor.md rename docs/plugins/Kaleidoscope-LEDControl.md => plugins/Kaleidoscope-LEDControl/README.md (83%) diff --git a/docs/plugins/Kaleidoscope-TriColor.md b/docs/plugins/Kaleidoscope-TriColor.md deleted file mode 100644 index da2437e9..00000000 --- a/docs/plugins/Kaleidoscope-TriColor.md +++ /dev/null @@ -1,35 +0,0 @@ -# TriColor - -The `TriColor` effect extension is a part of -the [`LEDEffects`][plugin:ledeffects] library, not a stand-alone base library of -its own. It is used to implement the effects in that library. - - [plugin:ledeffects]: Kaleidoscope-LEDEffects.md - -It is a class that can be used to create LED effects that all follow a similar -pattern: alphas and similar in one color; modifiers, special keys, and half the -function keys in another, and `Esc` in a third (this latter being optional). If -we have a color scheme that follows this pattern, the `TriColor` extension can -make it a lot easier to implement it. - -## Using the extension - -Because the extension is part of the [`LEDEffects`][plugin:ledeffects] library, -we need to include that header: - -```c++ -#include -``` - -Then, we simply create a new instance of the `TriColor` class, with appropriate -colors set for the constructor: - -```c++ -kaleidoscope::plugin::TriColor BlackAndWhiteEffect (CRGB(0x00, 0x00, 0x00), - CRGB(0xff, 0xff, 0xff), - CRGB(0x80, 0x80, 0x80)); -``` - -The first argument is the base color, the second is for modifiers and special -keys, the last one is for the `Esc` key. If the last one is omitted, the -extension will use the modifier color for it. diff --git a/docs/plugins/Kaleidoscope-LEDControl.md b/plugins/Kaleidoscope-LEDControl/README.md similarity index 83% rename from docs/plugins/Kaleidoscope-LEDControl.md rename to plugins/Kaleidoscope-LEDControl/README.md index 729d7a38..675d2c9a 100644 --- a/docs/plugins/Kaleidoscope-LEDControl.md +++ b/plugins/Kaleidoscope-LEDControl/README.md @@ -1,4 +1,4 @@ -# LEDControl +# Kaleidoscope-LEDControl This is a plugin for [Kaleidoscope][fw], for controlling the LEDs, and LED effects. diff --git a/plugins/Kaleidoscope-LEDEffects/README.md b/plugins/Kaleidoscope-LEDEffects/README.md index 906db7ae..8adea278 100644 --- a/plugins/Kaleidoscope-LEDEffects/README.md +++ b/plugins/Kaleidoscope-LEDEffects/README.md @@ -49,6 +49,39 @@ light green, except for the `Esc` key, which will be in red. An alternative color scheme exists under the `JukeboxAlternateEffect` name, where the light green and red colors are swapped. + +### TriColor + +TriColor is a class that can be used to create LED effects that all follow a similar +pattern: alphas and similar in one color; modifiers, special keys, and half the +function keys in another, and `Esc` in a third (this latter being optional). If +we have a color scheme that follows this pattern, the `TriColor` extension can +make it a lot easier to implement it. + +## Using the extension + +Because the extension is part of the `LEDEffects` library, +we need to include that header: + +```c++ +#include +``` + +Then, we simply create a new instance of the `TriColor` class, with appropriate +colors set for the constructor: + +```c++ +kaleidoscope::plugin::TriColor BlackAndWhiteEffect (CRGB(0x00, 0x00, 0x00), + CRGB(0xff, 0xff, 0xff), + CRGB(0x80, 0x80, 0x80)); +``` + +The first argument is the base color, the second is for modifiers and special +keys, the last one is for the `Esc` key. If the last one is omitted, the +extension will use the modifier color for it. + + + ## Plugin methods The plugin provides a single method on each of the included effect objects: