diff options
Diffstat (limited to 'docs/feature_mouse_keys.md')
| -rw-r--r-- | docs/feature_mouse_keys.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/feature_mouse_keys.md b/docs/feature_mouse_keys.md index 560bd0470..78c44b3e6 100644 --- a/docs/feature_mouse_keys.md +++ b/docs/feature_mouse_keys.md | |||
| @@ -3,11 +3,11 @@ | |||
| 3 | 3 | ||
| 4 | Mousekeys is a feature that allows you to emulate a mouse using your keyboard. You can move the pointer around, click up to 5 buttons, and even scroll in all 4 directions. QMK uses the same algorithm as the X Window System MouseKeysAccel feature. You can read more about it [on Wikipedia](https://en.wikipedia.org/wiki/Mouse_keys). | 4 | Mousekeys is a feature that allows you to emulate a mouse using your keyboard. You can move the pointer around, click up to 5 buttons, and even scroll in all 4 directions. QMK uses the same algorithm as the X Window System MouseKeysAccel feature. You can read more about it [on Wikipedia](https://en.wikipedia.org/wiki/Mouse_keys). |
| 5 | 5 | ||
| 6 | ## Adding Mousekeys To a Keymap | 6 | ## Adding Mousekeys to a Keymap |
| 7 | 7 | ||
| 8 | There are two steps to adding Mousekeys support to your keyboard. You must enable support in the Makefile and you must map mouse actions to keys on your keyboard. | 8 | There are two steps to adding Mousekeys support to your keyboard. You must enable support in the Makefile and you must map mouse actions to keys on your keyboard. |
| 9 | 9 | ||
| 10 | ### Adding Mousekeys support in the `Makefile` | 10 | ### Adding Mousekeys Support in the `Makefile` |
| 11 | 11 | ||
| 12 | To add support for Mousekeys you simply need to add a single line to your keymap's `Makefile`: | 12 | To add support for Mousekeys you simply need to add a single line to your keymap's `Makefile`: |
| 13 | 13 | ||
| @@ -17,7 +17,7 @@ MOUSEKEY_ENABLE = yes | |||
| 17 | 17 | ||
| 18 | You can see an example here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/keymaps/mouse_keys/Makefile | 18 | You can see an example here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/keymaps/mouse_keys/Makefile |
| 19 | 19 | ||
| 20 | ### Mapping Mouse Actions To Keyboard Keys | 20 | ### Mapping Mouse Actions to Keyboard Keys |
| 21 | 21 | ||
| 22 | You can use these keycodes within your keymap to map button presses to mouse actions: | 22 | You can use these keycodes within your keymap to map button presses to mouse actions: |
| 23 | 23 | ||
| @@ -42,7 +42,7 @@ You can use these keycodes within your keymap to map button presses to mouse act | |||
| 42 | 42 | ||
| 43 | You can see an example in the `_ML` here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/keymaps/mouse_keys/keymap.c#L46 | 43 | You can see an example in the `_ML` here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/keymaps/mouse_keys/keymap.c#L46 |
| 44 | 44 | ||
| 45 | ## Configuring the behavior of Mousekeys | 45 | ## Configuring the Behavior of Mousekeys |
| 46 | 46 | ||
| 47 | The default speed for controlling the mouse with the keyboard is intentionaly slow. You can adjust these parameters by adding these settings to your keymap's `config.h` file. All times are specified in miliseconds (ms). | 47 | The default speed for controlling the mouse with the keyboard is intentionaly slow. You can adjust these parameters by adding these settings to your keymap's `config.h` file. All times are specified in miliseconds (ms). |
| 48 | 48 | ||
| @@ -78,4 +78,4 @@ The top speed for scrolling movements. | |||
| 78 | 78 | ||
| 79 | ### `MOUSEKEY_WHEEL_TIME_TO_MAX` | 79 | ### `MOUSEKEY_WHEEL_TIME_TO_MAX` |
| 80 | 80 | ||
| 81 | How long you want to hold down a scroll key for until `MOUSEKEY_WHEEL_MAX_SPEED` is reached. This controls how quickling your scrolling will accelerate. \ No newline at end of file | 81 | How long you want to hold down a scroll key for until `MOUSEKEY_WHEEL_MAX_SPEED` is reached. This controls how quickling your scrolling will accelerate. |