keyboards/kinesis/keymaps/tuesdayjohn/readme.md

   1 # TuesdayJohn's Kinesis Keymap
   2
   3 These layouts are derived from what I was using on my Kinesis Contoured keyboards with Hasu's USB-USB TMK converters.  With the move to QMK via Stapelberg replacement controller, I've cleaned up the layouts a bit while adding more functions and layers.
   4
   5 There are minor changes in the base keywell layout of non-alpha keys (e.g., CapsLock is ESC/Ctl, arrow clusters on one side), while the thumb clusters deviate more from the default layout.
   6
   7 Changes to the thumb clusters include:
   8 * The navigations keys moved to function layers.
   9 * The function of 2u keys have been reversed - I've always used space with my left thumb, and I find it more helpful to have quick and easy access to Space and Enter while using my mouse/trackball.
  10 * Backspace have been duplicated on both clusters.  As with Space and Backspace, I find it helpful to have quick and easy access to Backspace while using my mouse/trackball.
  11 * The 2u keys serve dual function as momentary layer switchers.
  12
  13 I've largely left the function keys untouched, with the intension of not using them often.  They are neither easy to use nor reach due to their locations and size, and Kinesis used not-so-great rubber dome switches for them (Advantage model and earlier).  Kinesis have since replaced the keys with Cherry ML switches on Advantage2, but did not resolve the issues of size or location.  Additionally, leaving the function keys unused here makes it easier for me to adapt the keymaps to my other keyboards, most of which do not have physical function keys.
  14
  15 I use Colemak as my default layout.  I've included QWERTY here as well.
  16
  17 Additionally, there is a gaming layer on toggle.  This layer is turned top of either Colemak or QWERTY and have limited access to the Function or Numbers/Symbols layers.  Additionally, NKRO is turned on when the layer is turned on.
  18
  19 Persistent default layer has been enabled for Colemak and QWERTY.  The gaming/vanilla Colemak and QWERTY can be set as default layer, but will not be persistent.
  20
  21 ## Future plans
  22
  23 * Add status LEDs to the Stapelberg PCB (usually used for Caps Lock, Num Lock, and Scroll Lock) to use as layer indicators.
  24 * Add a speaker now that QMK supports additional pins for audio use.
  25 * Utilize the leftover spots on the key matrix, as well as unused pins on Teensy++ 2.0 to run macropad and/or foot pedals.
  26
  27
  28 ## Layers
  29
  30 ### Function Keys on all layers
  31 - 'Numpd' toggles the Numpad layer
  32 - 'Adjst' is a momentary layer key to access the Adjust layer
  33
  34 ```
  35 ,-----------------------------------------------------. ,----------------------------------------------------.
  36 | ESC |  F1 |  F2 |  F3 |  F4 |  F5 |  F6 |  F7 |  F8 | | F9 | F10 | F11 | F12 | PScr| SLck| Paus|Numpd|Adjst|
  37 `-----------------------------------------------------' `----------------------------------------------------'
  38 ```
  39
  40 ### Colemak
  41 - Default layer
  42 - Keys separated by "/" tap for first, hold for second
  43 - Uses [Space Cadet Shifts](https://beta.docs.qmk.fm/features/feature_space_cadet)
  44
  45 ```
  46 ,------------------------------------------------. ,------------------------------------------------.
  47 |    =   |   1   |   2   |   3   |   4   |   5   | |   6   |   7   |   8   |   9   |   0   |    -   |
  48 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
  49 |   Tab  |   Q   |   W   |   F   |   P   |   G   | |   J   |   L   |   U   |   Y   |   ;   |    \   |
  50 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
  51 |ESC/Ctrl|   A   |   R   |   S   |   T   |   D   | |   H   |   N   |   E   |   I   |   O   |    '   |
  52 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
  53 |SC Shift|   Z   |   X   |   C   |   V   |   B   | |   K   |   M   |   ,   |   .   |   /   |SC Shift|
  54 `--------+-------+-------+-------+-------+-------' `-------+-------+-------+-------+-------+--------'
  55          |  Ins  |   `   |   [   |   ]   |                 |  Left |  Down |   Up  | Right |
  56          `-------------------------------'                 `-------------------------------'
  57                                  ,---------------. ,---------------.
  58                                  |ESC/Ctl| Hyper | |  RAlt |  RCtl |
  59                          ,-------+-------+-------| |-------+-------+-------.
  60                          | Space | Enter |App/Alt| |  RGUI | Delete|  Bspc |
  61                          |   /   |   /   |-------| |-------|   /   |   /   |
  62                          |  Fn   | Number|  Bspc | | Enter |Number2|  Fn2  |
  63                          `-----------------------' `-----------------------'
  64 ```
  65
  66 ### QWERTY
  67 - Keys separated by "/" tap for first, hold for second
  68 - Uses [Space Cadet Shifts](https://beta.docs.qmk.fm/features/feature_space_cadet)
  69
  70 ```
  71 ,------------------------------------------------. ,------------------------------------------------.
  72 |    =   |   1   |   2   |   3   |   4   |   5   | |   6   |   7   |   8   |   9   |   0   |    -   |
  73 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
  74 |   Tab  |   Q   |   W   |   E   |   R   |   T   | |   Y   |   U   |   I   |   O   |   P   |    \   |
  75 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
  76 |ESC/Ctrl|   A   |   S   |   D   |   F   |   G   | |   H   |   J   |   K   |   L   |   ;   |    '   |
  77 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
  78 |SC Shift|   Z   |   X   |   C   |   V   |   B   | |   N   |   M   |   ,   |   .   |   /   |SC Shift|
  79 `--------+-------+-------+-------+-------+-------' `-------+-------+-------+-------+-------+--------'
  80          |  Ins  |   `   |   [   |   ]   |                 |  Left |  Down |   Up  | Right |
  81          `-------------------------------'                 `-------------------------------'
  82                                  ,---------------. ,---------------.
  83                                  |ESC/Ctl| Hyper | |  RAlt |  RCtl |
  84                          ,-------+-------+-------| |-------+-------+-------.
  85                          | Space | Enter |App/Alt| |  RGUI | Delete|  Bspc |
  86                          |   /   |   /   |-------| |-------|   /   |   /   |
  87                          |  Fn   | Number|  Bspc | | Enter |Number2|  Fn2  |
  88                          `-----------------------' `-----------------------'
  89 ```
  90
  91 ### Numbers & Symbols layer
  92 - Momentary layer
  93 - Multiple characters: Single-tap for first, double-tap for second
  94
  95 ```
  96 ,------------------------------------------------. ,------------------------------------------------.
  97 |   F12  |   F1  |   F2  |   F3  |   F4  |   F5  | |   F6  |   F7  |   F8  |   F9  |  F10  |   F11  |
  98 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
  99 |        |   6   |   7   |   8   |   9   |   0   | |   ^   |   &   |   *   |   (   |   )   |        |
 100 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
 101 |        |   1   |   2   |   3   |   4   |   5   | |   !   |   @   |   #   |   $   |   %   |        |
 102 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
 103 |        |       |   .   |  / *  |  - _  |  + =  | |  ` ~  |  [ {  |  ] }  |       |       |        |
 104 `--------+-------+-------+-------+-------+-------' `-------+-------+-------+-------+-------+--------'
 105          |   (   |   )   |  [ {  |  ] }  |                 |       |       |       |       |
 106          `-------------------------------'                 `-------------------------------'
 107                                  ,---------------. ,---------------.
 108                                  |       |       | |       |       |
 109                          ,-------+-------+-------| |-------+-------+-------.
 110                          |       |       |       | |       |       |       |
 111                          |       |       |-------| |-------|       |       |
 112                          |       |       |       | |       |       |       |
 113                          `-----------------------' `-----------------------'
 114 ```
 115
 116 ### Function layer
 117 - Momentary layer
 118
 119 ```
 120 ,------------------------------------------------. ,------------------------------------------------.
 121 |   F12  |   F1  |   F2  |   F3  |   F4  |   F5  | |   F6  |   F7  |   F8  |   F9  |  F10  |   F11  |
 122 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
 123 |        |       |       |   Up  |       |       | |       |       |   Up  | Ctrl+Y|       |        |
 124 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
 125 |        | Ctrl+A|  Left |  Down | Right | C+A+Tb| |  PgUp |  Left |  Down | Right |  Home |        |
 126 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
 127 |        | Ctrl+Z| Ctrl+X| Ctrl+C| Ctrl+V|  Bspc | |  PgDn |  Mute |  Vol- |  Vol+ |   End |        |
 128 `--------+-------+-------+-------+-------+-------' `-------+-------+-------+-------+-------+--------'
 129          |       |       |       |       |                 |  Prev |  Play |  Next |  Stop |
 130          `-------------------------------'                 `-------------------------------'
 131                                  ,---------------. ,---------------.
 132                                  |       |       | |       |       |
 133                          ,-------+-------+-------| |-------+-------+-------.
 134                          |       |       |       | |       |       |       |
 135                          |       |       |-------| |-------|       |       |
 136                          |       |       |       | |       |       |       |
 137                          `-----------------------' `-----------------------'
 138 ```
 139
 140 ### Numpad layer
 141 - Toggle layer
 142 - Left side duplicates layout from the Numbers layer, just with numpad output
 143 - Right side layout close to PC numpad layout
 144 - Multiple characters: Single-tap for first, double-tap for second
 145
 146 ```
 147 ,------------------------------------------------. ,------------------------------------------------.
 148 |        | NumLk |       |       |       |       | |  Tab  | NumLk |  KP / |  KP * |  KP - |        |
 149 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
 150 |        |  KP 6 |  KP 7 |  KP 8 |  KP 9 |  KP 0 | |       |  KP 7 |  KP 8 |  KP 9 |  KP + |        |
 151 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
 152 |        |  KP 1 |  KP 2 |  KP 3 |  KP 4 |  KP 5 | |       |  KP 4 |  KP 5 |  KP 6 |   =   |        |
 153 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
 154 |        |       |  KP . | KP/KP*| KP- _ | KP+ = | |       |  KP 1 |  KP 2 |  KP 3 | KP Ent|        |
 155 `--------+-------+-------+-------+-------+-------' `-------+-------+-------+-------+-------+--------'
 156          |   (   |   )   |  [ {  |  ] }  |                 |  KP 0 |   ,   |  KP . | KP Ent|
 157          `-------------------------------'                 `-------------------------------'
 158                                  ,---------------. ,---------------.
 159                                  |       |       | |       |       |
 160                          ,-------+-------+-------| |-------+-------+-------.
 161                          |       |       |       | |       |       |       |
 162                          |       |       |-------| |-------|       |       |
 163                          |       |       |       | |       |       |       |
 164                          `-----------------------' `-----------------------'
 165 ```
 166
 167 ### Gaming
 168 - Toggle layer with limited access to Function or Numbers layers
 169 - Mainly used for gaming
 170 - NKRO turned on by default
 171 - Press and hold Ent/NS + Delete/Numbers2 to access Adjust layer
 172
 173 ```
 174 ,------------------------------------------------. ,------------------------------------------------.
 175 |        |       |       |       |       |       | |       |       |       |       |       |        |
 176 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
 177 |        |       |       |       |       |       | |       |       |       |       |       |        |
 178 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
 179 |  LCtrl |       |       |       |       |       | |       |       |       |       |       |        |
 180 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
 181 |  Shift |       |       |       |       |       | |       |       |       |       |       |  Shift |
 182 `--------+-------+-------+-------+-------+-------' `-------+-------+-------+-------+-------+--------'
 183          |       |       |       |       |                 |       |       |       |       |
 184          `-------------------------------'                 `-------------------------------'
 185                                  ,---------------. ,---------------.
 186                                  |  ESC  |xxxxxxx| |  RAlt |  RCtl |
 187                          ,-------+-------+-------| |-------+-------+-------.
 188                          |       |       |  LAlt | |  RGUI | Delete|  Bspc |
 189                          | Space | Enter |-------| |-------|   /   |   /   |
 190                          |       |       |  Bspc | | Ent/NS|Number2|  Fn2  |
 191                          `-----------------------' `-----------------------'
 192 ```
 193
 194 ### Adjust layer
 195 - Momentary layer
 196 - Press and hold Adjust key on the function row or Enter/Number + Delete/Number2 to access
 197 - Gaming, Numpad, and NKRO are on toggle
 198
 199 ```
 200 ,------------------------------------------------. ,------------------------------------------------.
 201 |        |Colemak| QWERTY|       | Gaming|       | | Numpad|       |       |       |       |  RESET |
 202 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
 203 |        |       |       |       |       |       | |       |       |       |       |       |        |
 204 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
 205 |        |       |       |       |       |       | |       |  NKRO |       |       |       |        |
 206 |--------+-------+-------+-------+-------+-------| |-------+-------+-------+-------+-------+--------|
 207 |        |       |       |       |       |       | |       |       |       |       |       |        |
 208 `--------+-------+-------+-------+-------+-------' `-------+-------+-------+-------+-------+--------'
 209          |       |       |       |       |                 |       |       |       |       |
 210          `-------------------------------'                 `-------------------------------'
 211                                  ,---------------. ,---------------.
 212                                  |       |       | |       |       |
 213                          ,-------+-------+-------| |-------+-------+-------.
 214                          |       |       |       | |       |       |       |
 215                          |       |       |-------| |-------|       |       |
 216                          |       |       |       | |       |       |       |
 217                          `-----------------------' `-----------------------'
 218  ```
 219