Skip to content

Feedback plugin

Julien Hartmann edited this page Mar 3, 2019 · 5 revisions

Responds to keypresses.
When the keys are pressed or released by the user, they turn on in the specified color, then slowly fade back to transparent.

The animation has a transparent background, so it can be stacked on top of other plugins. If nothing is wanted behind, use the fill plugin with whatever background color you want.

Sample configuration

- effect: feedback
  sustain: 1000
  decay: 2000
  color: ff3f3f

Options

After being pressed, the keys will switch to a color for some time, then slowly go back to normal.

  • sustain: how long the keys remain at color after being pressed, in milliseconds.
  • decay: how long the keys take to fade out to complete transparency, in milliseconds.
  • color: the color of pressed keys at the beginning of the effect. May be translucide. If omitted, defaults to fully opaque white.

Notes

  • Some keys such as fn do not send events. Those keys therefore cannot show feedback.
  • Special keys such as G-keys show up as aliases for other keys and might trigger feedback on the wrong key. This can certainly be solved, but I don't have that kind of hardware to test. If you have such device and are open to helping with this, please open a ticket.