From 2caa8ad4ff38fa01d8f9bacfef574cb45699a6ef Mon Sep 17 00:00:00 2001 From: Chris Lewis Date: Thu, 23 Aug 2018 21:52:46 +1000 Subject: [PATCH] Added documentation --- docs/feature_momentum.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 docs/feature_momentum.md diff --git a/docs/feature_momentum.md b/docs/feature_momentum.md new file mode 100644 index 0000000000..00ce4bb70f --- /dev/null +++ b/docs/feature_momentum.md @@ -0,0 +1,18 @@ +# Momentum + +Momentum 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 +For Momentum to take effect, you need to enable it with the MOM_TOG keycode, which toggles it on and off. + +The following light effects will all be controlled by Momentum when it is enabled: + - RGB Breathing + - RGB Rainbow Mood + - RGB Rainbow Swirl + - RGB Snake + - RGB Knight + + As long as Momentum is enabled, it will control the speed regardless of any other speed setting that your RGB lights are currently on. + + ## Configuration + Momentum 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 `momentum.c` and adjust the values there to achieve the kinds of speeds that you like. \ No newline at end of file