docs/feature_mouse_keys.md

   1 # Mousekeys
   2
   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.
   5
   6 There are 2 ways to define how the mousekeys behave, using "[auto-accelerating](#configuring-the-behavior-of-mousekeys-with-auto-accelerated-movement)" or "[3-speed constant](#configuring-the-behavior-of-mousekeys-with-3-speed-constant-movement)" behavior.
   7
   8 In either case, you will need to enable mousekeys in your makefile,
   9 and add the relevant [keycodes](#mapping-mouse-actions-to-keyboard-keys) to your keymap.
  10
  11 #### Enable Mousekeys
  12
  13 To enable the mousekey functionality, add the following line to your keymap's `rules.mk`:
  14
  15 ```
  16 MOUSEKEY_ENABLE = yes
  17 ```
  18
  19 #### Mapping Mouse Actions to Keyboard Keys
  20
  21 You can use these keycodes within your keymap to map button presses to mouse actions:
  22
  23 |Key             |Aliases  |Description                        |
  24 |----------------|---------|-----------------------------------|
  25 |`KC_MS_UP`      |`KC_MS_U`|Mouse Cursor Up                    |
  26 |`KC_MS_DOWN`    |`KC_MS_D`|Mouse Cursor Down                  |
  27 |`KC_MS_LEFT`    |`KC_MS_L`|Mouse Cursor Left                  |
  28 |`KC_MS_RIGHT`   |`KC_MS_R`|Mouse Cursor Right                 |
  29 |`KC_MS_BTN1`    |`KC_BTN1`|Mouse Button 1                     |
  30 |`KC_MS_BTN2`    |`KC_BTN2`|Mouse Button 2                     |
  31 |`KC_MS_BTN3`    |`KC_BTN3`|Mouse Button 3                     |
  32 |`KC_MS_BTN4`    |`KC_BTN4`|Mouse Button 4                     |
  33 |`KC_MS_BTN5`    |`KC_BTN5`|Mouse Button 5                     |
  34 |`KC_MS_WH_UP`   |`KC_WH_U`|Mouse Wheel Up                     |
  35 |`KC_MS_WH_DOWN` |`KC_WH_D`|Mouse Wheel Down                   |
  36 |`KC_MS_WH_LEFT` |`KC_WH_L`|Mouse Wheel Left                   |
  37 |`KC_MS_WH_RIGHT`|`KC_WH_R`|Mouse Wheel Right                  |
  38 |`KC_MS_ACCEL0`  |`KC_ACL0`|Set mouse acceleration to 0(slow)  |
  39 |`KC_MS_ACCEL1`  |`KC_ACL1`|Set mouse acceleration to 1(medium)|
  40 |`KC_MS_ACCEL2`  |`KC_ACL2`|Set mouse acceleration to 2(fast)  |
  41
  42
  43 ## Configuring the Behavior of Mousekeys with auto-accelerated movement
  44
  45 This behavior is intended to emulate the X Window System MouseKeysAccel feature. You can read more about it [on Wikipedia](https://en.wikipedia.org/wiki/Mouse_keys).
  46
  47 The default speed for controlling the mouse with the keyboard is intentionally slow. You can adjust these parameters by adding these settings to your keymap's `config.h` file. All times are specified in milliseconds (ms).
  48
  49 ```
  50 #define MOUSEKEY_DELAY             300
  51 #define MOUSEKEY_INTERVAL          50
  52 #define MOUSEKEY_MAX_SPEED         10
  53 #define MOUSEKEY_TIME_TO_MAX       20
  54 #define MOUSEKEY_WHEEL_MAX_SPEED   8
  55 #define MOUSEKEY_WHEEL_TIME_TO_MAX 40
  56 ```
  57
  58 #### `MOUSEKEY_DELAY`
  59
  60 When one of the mouse movement buttons is pressed this setting is used to define the delay between that button press and the mouse cursor moving. Some people find that small movements are impossible if this setting is too low, while settings that are too high feel sluggish.
  61
  62 #### `MOUSEKEY_INTERVAL`
  63
  64 When a movement key is held down this specifies how long to wait between each movement report. Lower settings will translate into an effectively higher mouse speed.
  65
  66 #### `MOUSEKEY_MAX_SPEED`
  67
  68 As a movement key is held down the speed of the mouse cursor will increase until it reaches `MOUSEKEY_MAX_SPEED`.
  69
  70 #### `MOUSEKEY_TIME_TO_MAX`
  71
  72 How long you want to hold down a movement key for until `MOUSEKEY_MAX_SPEED` is reached. This controls how quickly your cursor will accelerate.
  73
  74 #### `MOUSEKEY_WHEEL_MAX_SPEED`
  75
  76 The top speed for scrolling movements.
  77
  78 #### `MOUSEKEY_WHEEL_TIME_TO_MAX`
  79
  80 How long you want to hold down a scroll key for until `MOUSEKEY_WHEEL_MAX_SPEED` is reached. This controls how quickly your scrolling will accelerate.
  81
  82
  83 ## Configuring the Behavior of Mousekeys with 3-speed constant movement
  84
  85 In your keymap's `config.h`, you must add the line:
  86 ```
  87 #define MK_3_SPEED
  88 ```
  89 Then you can precisely define 3 different speeds for both the cursor and the mouse wheel, and also whether speed selection is momentary or tap-to-select.
  90 For each speed, you can specify how many milliseconds you want between reports(interval), and how far you want to it to move per report(offset).
  91
  92 For example:
  93
  94 ```
  95 #define MK_3_SPEED
  96 #define MK_MOMENTARY_ACCEL // comment this out for tap-to-select acceleration
  97 // cursor speeds:
  98 #define MK_C_OFFSET_SLOW     1 // pixels
  99 #define MK_C_INTERVAL_SLOW 100 // milliseconds
 100 #define MK_C_OFFSET_MED      4
 101 #define MK_C_INTERVAL_MED   16
 102 #define MK_C_OFFSET_FAST    12
 103 #define MK_C_INTERVAL_FAST  16
 104 // scroll wheel speeds:
 105 #define MK_W_OFFSET_SLOW     1 // wheel clicks
 106 #define MK_W_INTERVAL_SLOW 400 // milliseconds
 107 #define MK_W_OFFSET_MED      1
 108 #define MK_W_INTERVAL_MED  200
 109 #define MK_W_OFFSET_FAST     1
 110 #define MK_W_INTERVAL_FAST 100
 111 ```
 112
 113 Medium values will be used as the default or unmodified speed.
 114 The speed at which both the cursor and scrolling move can be selected with KC_ACL0, KC_ACL1, KC_ACL2 for slow, medium, and fast. However, if you leave MK_MOMENTARY_ACCEL defined then there is no need to ever send KC_ACL1, since that will be the unmodified speed.