summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2023-09-25 17:48:10 +0100
committerGitHub <noreply@github.com>2023-09-25 17:48:10 +0100
commit339bff63393cda8bd6e8358e09d04b50ff9ac010 (patch)
tree8a60fa247a3e4c87bad50bec32725e27f66c0bd7 /docs
parent1052c03a5b15b09e0925c918812452cdd0c6d413 (diff)
Move velocikey to within rgblight (#22123)
Diffstat (limited to 'docs')
-rw-r--r--docs/_summary.md1
-rw-r--r--docs/feature_rgblight.md30
-rw-r--r--docs/feature_velocikey.md29
-rw-r--r--docs/ja/_summary.md1
-rw-r--r--docs/ja/feature_velocikey.md34
-rw-r--r--docs/zh-cn/_summary.md1
6 files changed, 30 insertions, 66 deletions
diff --git a/docs/_summary.md b/docs/_summary.md
index 28460f5ba9..722c5f9c5d 100644
--- a/docs/_summary.md
+++ b/docs/_summary.md
@@ -126,7 +126,6 @@
* [PS/2 Mouse](feature_ps2_mouse.md)
* [Split Keyboard](feature_split_keyboard.md)
* [Stenography](feature_stenography.md)
- * [Velocikey](feature_velocikey.md)
* Keyboard Building
* [Easy Maker for One Offs](easy_maker.md)
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index 2bdfe6a7cf..f5c8d56e4e 100644
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@@ -552,3 +552,33 @@ In addition to setting the Clipping Range, you can use `RGBLIGHT_LED_MAP` togeth
## Hardware Modification
If your keyboard lacks onboard underglow LEDs, you may often be able to solder on an RGB LED strip yourself. You will need to find an unused pin to wire to the data pin of your LED strip. Some keyboards may break out unused pins from the MCU to make soldering easier. The other two pins, VCC and GND, must also be connected to the appropriate power pins.
+
+## Velocikey
+
+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
+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.:
+
+```
+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 `VK_TOGG` keycode, which toggles the feature on and off.
+
+The following light effects will all be controlled by Velocikey when it is enabled:
+ - RGB Breathing
+ - RGB Rainbow Mood
+ - RGB Rainbow Swirl
+ - RGB Snake
+ - RGB Knight
+
+Support for LED breathing effects is planned but not available yet.
+
+ As long as Velocikey is enabled, it will control the speed regardless of any other speed setting that your RGB lights are currently on.
+
+ ### Configuration
+ 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.
diff --git a/docs/feature_velocikey.md b/docs/feature_velocikey.md
deleted file mode 100644
index aeb1865e8a..0000000000
--- a/docs/feature_velocikey.md
+++ /dev/null
@@ -1,29 +0,0 @@
-# Velocikey
-
-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
-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.:
-
-```
-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 `VK_TOGG` keycode, which toggles the feature on and off.
-
-The following light effects will all be controlled by Velocikey when it is enabled:
- - RGB Breathing
- - RGB Rainbow Mood
- - RGB Rainbow Swirl
- - RGB Snake
- - RGB Knight
-
-Support for LED breathing effects is planned but not available yet.
-
- As long as Velocikey is enabled, it will control the speed regardless of any other speed setting that your RGB lights are currently on.
-
- ## Configuration
- 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.
diff --git a/docs/ja/_summary.md b/docs/ja/_summary.md
index 4d6f2348d5..f26665e614 100644
--- a/docs/ja/_summary.md
+++ b/docs/ja/_summary.md
@@ -112,7 +112,6 @@
* [分割キーボード](ja/feature_split_keyboard.md)
* [速記](ja/feature_stenography.md)
* [感熱式プリンタ](ja/feature_thermal_printer.md)
- * [Velocikey](ja/feature_velocikey.md)
* QMK の開発
* [PR チェックリスト](ja/pr_checklist.md)
diff --git a/docs/ja/feature_velocikey.md b/docs/ja/feature_velocikey.md
deleted file mode 100644
index b13969a195..0000000000
--- a/docs/ja/feature_velocikey.md
+++ /dev/null
@@ -1,34 +0,0 @@
-# Velocikey
-
-<!---
- original document: 0.8.147:docs/feature_velocikey.md
- git diff 0.8.147 HEAD -- docs/feature_velocikey.md | cat
--->
-
-Velocikey は入力の速度を使って(レインボー渦巻効果のような)ライト効果の速度を制御できる機能です。速く入力すればするほどライトが速くなります!
-
-## 使用法
-Velocikey を使うためには、2つのステップがあります。最初に、キーボードをコンパイルする時に、`rules.mk` に `VELOCIKEY_ENABLE=yes` を設定する必要があります。例えば:
-
-```
-MOUSEKEY_ENABLE = no
-STENO_ENABLE = no
-EXTRAKEY_ENABLE = yes
-VELOCIKEY_ENABLE = yes
-```
-
-次に、キーボードの使用中に、VLK_TOG キーコードを使って Velocikey を有効にする必要もあります。これは機能をオンおよびオフにします。
-
-以下の全てのライト効果が、Velocikey を有効にすることで制御されます:
-- RGB 明滅動作
-- RGB レインボームード
-- RGB レインボー渦巻
-- RGB スネーク
-- RGB ナイト
-
-LED 明滅動作の効果のサポートは計画されていますがまだ利用できません。
-
-Velocikey が有効になっている限り、現在オンになっている RGB ライトの他の全ての速度設定に関係なく、速度が制御されます。
-
-## 設定
-Velocikey は現在のところキーボード設定を介したどのような設定もサポートしません。速度の増加あるいは減少率などを調整したい場合は、`velocikey.c` を編集し、そこで値を調整して、好みの速度を実現する必要があります。
diff --git a/docs/zh-cn/_summary.md b/docs/zh-cn/_summary.md
index 0fc92e33d3..a076f1a8c6 100644
--- a/docs/zh-cn/_summary.md
+++ b/docs/zh-cn/_summary.md
@@ -121,7 +121,6 @@
* [分体式键盘](zh-cn/feature_split_keyboard.md)
* [速记](zh-cn/feature_stenography.md)
* [热敏打印机](zh-cn/feature_thermal_printer.md)
- * [Velocikey](zh-cn/feature_velocikey.md)
* QMK开发
* [PR Checklist](zh-cn/pr_checklist.md)