docs/feature_velocikey.md

   1 # Velocikey
   2
   3 Velocikey is a feature that lets you control the speed of lighting effects (like the Rainbow Swirl effect) with the speed of your typing. The faster you type, the faster the lights will go!
   4
   5 ## Usage
   6 For Velocikey to take effect, there are two steps. First, when compiling your keyboard, you'll need to set `VELOCIKEY_ENABLE=yes` in `rules.mk`, e.g.:
   7
   8 ```
   9 BOOTMAGIC_ENABLE = no
  10 MOUSEKEY_ENABLE = no
  11 STENO_ENABLE = no
  12 EXTRAKEY_ENABLE = yes
  13 VELOCIKEY_ENABLE = yes
  14 ```
  15
  16 Then, while using your keyboard, you need to also turn it on with the VLK_TOG keycode, which toggles the feature on and off.
  17
  18 The following light effects will all be controlled by Velocikey when it is enabled:
  19  - RGB Breathing
  20  - RGB Rainbow Mood
  21  - RGB Rainbow Swirl
  22  - RGB Snake
  23  - RGB Knight
  24
  25 Support for LED breathing effects is planned but not available yet.
  26
  27  As long as Velocikey is enabled, it will control the speed regardless of any other speed setting that your RGB lights are currently on.
  28
  29  ## Configuration
  30  Velocikey doesn't currently support any configuration via keyboard settings. If you want to adjust something like the speed increase or decay rate, you would need to edit `velocikey.c` and adjust the values there to achieve the kinds of speeds that you like.