mirrors/qmk_firmware
1
0
Fork 1
mirror of https://github.com/qmk/qmk_firmware synced 2024-11-17 17:35:30 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update feature documentation

Browse source
This commit is contained in:
Chris Lewis 2018-09-11 09:21:27 +10:00 committed by GitHub
parent 7d198890e6
commit df111a55b9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/feature_velocikey.md
View file

@ -3,7 +3,17 @@
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! 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!
## Usage ## Usage
For Velocikey to take effect, you need to enable it with the VLK_TOG keycode, which toggles it on and off. 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.:
```
BOOTMAGIC_ENABLE = no
MOUSEKEY_ENABLE = no
STENO_ENABLE = no
EXTRAKEY_ENABLE = yes
VELOCIKEY_ENABLE = yes
```
Then, while using your keyboard, you need to also turn it on with the VLK_TOG keycode, which toggles the feature on and off.
The following light effects will all be controlled by Velocikey when it is enabled: The following light effects will all be controlled by Velocikey when it is enabled:
- RGB Breathing - RGB Breathing