aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_mouse_keys.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/feature_mouse_keys.md')
-rw-r--r--docs/feature_mouse_keys.md22
1 files changed, 21 insertions, 1 deletions
diff --git a/docs/feature_mouse_keys.md b/docs/feature_mouse_keys.md
index 88a2c7c05..a6b46bc15 100644
--- a/docs/feature_mouse_keys.md
+++ b/docs/feature_mouse_keys.md
@@ -39,10 +39,11 @@ In your keymap you can use the following keycodes to map key presses to mouse ac
39 39
40## Configuring mouse keys 40## Configuring mouse keys
41 41
42Mouse keys supports two different modes to move the cursor: 42Mouse keys supports three different modes to move the cursor:
43 43
44* **Accelerated (default):** Holding movement keys accelerates the cursor until it reaches its maximum speed. 44* **Accelerated (default):** Holding movement keys accelerates the cursor until it reaches its maximum speed.
45* **Constant:** Holding movement keys moves the cursor at constant speeds. 45* **Constant:** Holding movement keys moves the cursor at constant speeds.
46* **Combined:** Holding movement keys accelerates the cursor until it reaches its maximum speed, but holding acceleration and movement keys simultaneously moves the cursor at constant speeds.
46 47
47The same principle applies to scrolling. 48The same principle applies to scrolling.
48 49
@@ -120,3 +121,22 @@ Use the following settings if you want to adjust cursor movement or scrolling:
120|`MK_W_INTERVAL_1` |120 |Time between scroll steps (`KC_ACL1`) | 121|`MK_W_INTERVAL_1` |120 |Time between scroll steps (`KC_ACL1`) |
121|`MK_W_OFFSET_2` |1 |Scroll steps per scroll action (`KC_ACL2`) | 122|`MK_W_OFFSET_2` |1 |Scroll steps per scroll action (`KC_ACL2`) |
122|`MK_W_INTERVAL_2` |20 |Time between scroll steps (`KC_ACL2`) | 123|`MK_W_INTERVAL_2` |20 |Time between scroll steps (`KC_ACL2`) |
124
125### Combined mode
126
127This mode functions like **Accelerated** mode, however, you can hold `KC_ACL0`, `KC_ACL1` and `KC_ACL2`
128to momentarily (while held) set the cursor and scroll speeds to constant speeds. When no acceleration
129keys are held, this mode is identical to **Accelerated** mode, and can be modified using all of the
130relevant settings.
131
132* **KC_ACL0:** This acceleration sets your cursor to the slowest possible speed. This is useful for very
133small and detailed movements of the cursor.
134* **KC_ACL1:** This acceleration sets your cursor to half the maximum (user defined) speed.
135* **KC_ACL2:** This acceleration sets your cursor to the maximum (computer defined) speed. This is
136useful for moving the cursor large distances without much accuracy.
137
138To use constant speed mode, you must at least define `MK_COMBINED` in your keymap’s `config.h` file:
139
140```c
141#define MK_COMBINED
142```