Kaleidoscope-LED-Fire

The FireEffect plugin makes flames that roar from the bottom of your keyboard and every keypress.

Using the plugin

To use the plugin, one needs to include the header and select the effect.

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

KALEIDOSCOPE_INIT_PLUGINS(
  LEDControl,
  LEDOff,
  FireEffect
);

void setup () {
  Kaleidoscope.setup();

  //FireEffect.highlight_wasd = false;      // default; set true to make WASD keys brighter
  FireEffect.activate();
}

void loop() {
  Kaleidoscope.loop();
}

Configuration

The plugin provides one configuration field, highlight_wasd (default: false), which makes the WASD keys of the standard QWERTY layout brighter, even when the fire effect is almost completely dimmed. Like so:

The backstory is that, unlike a lot of Keyboardio users, it seems, I mostly use my Model 01 for gaming, and I mostly game at night with the room lights down. Glancing down in the middle of a madcap Overwatch match to reset my fingers, at the exact moment the LEDs were almost entirely out, was no fun. Hence, this configuration option.

Dependencies

• Kaleidoscope-LEDControl

Further reading

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

Acknowledgments

The FireEffect plugin is based on Selene Scriven's excellent WavePoolEffect plugin, without which I likely would never have succeeded.

It implements a simplified version of the classic demoscene fire effect as documented by Lode.

Oldsters like me may recall Javier "Jare" Arévalo's classic firedemo from 1993 (which he recently ported to HTML5). Hans Wennborg has written a nice walkthrough of it.