readme.md (22658B)
1 # Halcyon Kyria's Default Keymap 2 3  4 5 6 The default keymap contains 5 layers which allows it to include all keys found on an ANSI layout TKL keyboard plus media keys. 7 8 The five different layers are the following: 9 1. Base layer (QWERTY, Colemak-DH or Dvorak) 10 2. Navigation layer 11 3. Symbols/Numbers layer 12 4. Function layer 13 5. Adjust layer 14 15 ## Base layer(s) 16 ``` 17 Base Layer: - 18 19 ,-------------------------------------------. ,-------------------------------------------. 20 | Tab | - | - | - | - | - | | - | - | - | - | - | Bksp | 21 |--------+------+------+------+------+------| |------+------+------+------+------+--------| 22 |Ctrl/Esc| - | - | - | - | - | | - | - | - | - | - |Ctrl/ - | 23 |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| 24 | LShift | - | - | - | - | - | [ { |CapsLk| |F-Keys| ] } | - | - | - | - | - | RShift | 25 `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------' 26 |Adjust| LGUI | LAlt/| Space| Nav | | Sym | Space| AltGr| RGUI | Menu | 27 | | | Enter| | | | | | | | | 28 `----------------------------------' `----------------------------------' 29 ``` 30 Three different well-known keyboard layouts are provided to fill in the placeholder `-` keys: QWERTY, Colemak-DH, and Dvorak. The default layer can be changed at runtime, more info on that in the section on the [adjust layer](#adjust-layer). 31 32 For the rest of this write-up, the base layer will be assumed to be QWERTY and will be used as a reference to describe physical keys, e.g. “<kbd>B</kbd> key” vs, the much more verbose, “lower inner index key”. 33 34 ``` 35 Base Layer: QWERTY 36 37 ,-------------------------------------------. ,-------------------------------------------. 38 | Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp | 39 |--------+------+------+------+------+------| |------+------+------+------+------+--------| 40 |Ctrl/Esc| A | S | D | F | G | | H | J | K | L | ; : |Ctrl/' "| 41 |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| 42 | LShift | Z | X | C | V | B | [ { |CapsLk| |F-keys| ] } | N | M | , < | . > | / ? | RShift | 43 `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------' 44 |Adjust| LGUI | LAlt/| Space| Nav | | Sym | Space| AltGr| RGUI | Menu | 45 | | | Enter| | | | | | | | | 46 `----------------------------------' `----------------------------------' 47 ``` 48 49 Aside from variations in the alpha cluster, the rest of the base keys remain the same and are designed to feel familiar. 50 51  52 53 <details> 54 After making transformations to the classic ANSI US QWERTY TKL 60% to arrive to the layout of the Kyria, as illustrated in the animation above, the result looks like this: 55 56 ``` 57 ,-------------------------------------------. ,-------------------------------------------. 58 | Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp | 59 |--------+------+------+------+------+------| |------+------+------+------+------+--------| 60 | Cap Lk | A | S | D | F | G | | H | J | K | L | ; : | ' " | 61 |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| 62 | LShift | Z | X | C | V | B | | | | | | N | M | , < | . > | / ? | RShift | 63 `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------' 64 | LCtrl| LGUI | LAlt | Space| | | | Space| AltGr| RGUI | Menu | 65 | | | | | | | | | | | | 66 `----------------------------------' '----------------------------------' 67 ``` 68 69 First thing to notice is the presence of blank keys. To fill in the blank keys above the <kbd>Space</kbd> keys, we can take inspiration from other split keyboards featuring an extra inner index column on each half. A common mapping for those kind of keys are the bracket keys that got removed in the fourth step of the animated transformation. The thumb keys besides <kbd>Space</kbd>s is prime real estate for dedicated layer-switching keys. It doesn't matter on which side is assigned the sym-layer-switch key but it helps to keep the nav-layer-switch on the left in order to keep the arrow keys on the right side like on a classic keyboard, so we'll put nav on the left and sym on the right. We'll address the remaining blank thumb keys later. 70 71 The base layer is starting to form but there remains some flaws. One glaring issue is the position of Control. Control is a very commonly used function but the key on which it sits right now is way too tucked in under the hand to be able to press it comfortably with either the thumb or the pinky from resting position. In fact, installing a rotary encoder there is a common move among Kyria users and I guarantee you that activating Control by holding down a rotary encoder does not spark joy. Instead, let's employ a popular trick that involves remapping the current Caps Lock key, which is positioned at a comfortable position on the keyboard, to Control. 72 73 We can go further though; a variant of this trick makes the Control key produce Escape when tapped. This is called a “modtap”. There is no use to tapping Control by itself without chording it with another key and there is no use to holding down the Esc key so why not combine the two into a single key? 74 75 All of this leaves us with three blank keys. 76 77 ``` 78 ,-------------------------------------------. ,-------------------------------------------. 79 | Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp | 80 |--------+------+------+------+------+------| |------+------+------+------+------+--------| 81 |Ctrl/Esc| A | S | D | F | G | | H | J | K | L | ; : | ' " | 82 |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| 83 | LShift | Z | X | C | V | B | [ { | | | | ] } | N | M | , < | . > | / ? | RShift | 84 `--------+-------------+--------------------+------+------| |------+------+--------------------+------+---------------' 85 | | LGUI | LAlt | Space| Nav | | Sym | Space| AltGr| RGUI | Menu | 86 | | | | | | | | | | | | 87 `----------------------------------' '----------------------------------' 88 ``` 89 90 These keys are not easily reachable while touch typing (that is, not reachable without picking up your hand) and should thus be associated with functions that you are not likely to be typed within a stream of text. The idea is that if you have to pick up your hand to hit a key, you want it to be at a time when you are likely to be pausing your interaction with the machine, rather than in the midst of a flurry of typing. They're thus well suited for accessing the adjust layer and the function layer. We can also toss in Caps Lock even though it is an editing-type function that gets used within a stream of text because shouting in ALL-CAPS should be a deliberate action. 91 92 ``` 93 ,-------------------------------------------. ,-------------------------------------------. 94 | Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp | 95 |--------+------+------+------+------+------| |------+------+------+------+------+--------| 96 |Ctrl/Esc| A | S | D | F | G | | H | J | K | L | ; : | ' " | 97 |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| 98 | LShift | Z | X | C | V | B | [ { |CapsLk| |F-keys| ] } | N | M | , < | . > | / ? | RShift | 99 `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------' 100 |Adjust| LGUI | LAlt | Space| Nav | | Sym | Space| AltGr| RGUI | Menu | 101 | | | | | | | | | | | | 102 `----------------------------------' `----------------------------------' 103 ``` 104 105 The next glaring issue is the absence of an Enter key on the current base layer this far. Enter is a very frequently used key so it deserves to be placed at a good spot in the keymap. The best way to insert it in the keymap with minimal changes to the current layout is to use modtaps. A tempting solution is to turn the <kbd>RShift</kbd> key into a <kbd>RShift/Enter</kbd> modtap but that can result in chat messages sent too frustratingly early when you're not used to it. Using GUI is also sub-optimal because tapping the GUI modifier actually has a use as opposed to taps of the Control or the Shift key. Pressing and releasing the GUI key by itself opens the App menu in many desktop environments. The natural choice is thus <kbd>LAlt/Enter</kbd>. That way, Enter is 1u away from resting thumb position and is unlikely to get accidentally activated because Alt is very rarely used in the midst of prose. 106 107 Finally, we're one Quality-Of-Life update away from the actual base layer. <kbd>Ctrl/' "</kbd> not only preserves symmetry in the keymap with <kbd>Ctrl/Esc</kbd> but also helps balance the load between your pinkies and invites you to use both hands instead of contortions. Perhaps more importantly, it also frees you from the necessity of picking up your hand, breaking touch typing position and pressing a pinky key with your ring finger in order to execute Ctrl+A or Ctrl+Z. That becomes even more important on a board with such an aggressive pinky columnar stagger like the Kyria. 108 109 110 ``` 111 ,-------------------------------------------. ,-------------------------------------------. 112 | Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp | 113 |--------+------+------+------+------+------| |------+------+------+------+------+--------| 114 |Ctrl/Esc| A | S | D | F | G | | H | J | K | L | ; : |Ctrl/' "| 115 |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| 116 | LShift | Z | X | C | V | B | [ { |CapsLk| |F-keys| ] } | N | M | , < | . > | / ? | RShift | 117 `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------' 118 |Adjust| LGUI | LAlt/| Space| Nav | | Sym | Space| AltGr| RGUI | Menu | 119 | | | Enter| | | | | | | | | 120 `----------------------------------' `----------------------------------' 121 ``` 122 123 </details> 124 125 ## Navigation layer 126 127 ``` 128 Nav Layer: Media, navigation 129 130 ,-------------------------------------------. ,-------------------------------------------. 131 | | | | | | | | PgUp | Home | ↑ | End | VolUp| Delete | 132 |--------+------+------+------+------+------| |------+------+------+------+------+--------| 133 | | GUI | Alt | Ctrl | Shift| | | PgDn | ← | ↓ | → | VolDn| Insert | 134 |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| 135 | | | | | | | |ScLck | | | | Pause|M Prev|M Play|M Next|VolMut| PrtSc | 136 `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------' 137 | | | | | | | | | | | | 138 | | | | | | | | | | | | 139 `----------------------------------' `----------------------------------' 140 ``` 141 142 This is where you'll find all the keys that are generally between the main block of a classic keyboard and the numpad in addition to media controls and modifiers on easy access on the home row for fast and comfortable chording with navigation keys. 143 144 Useful mnemonics: 145 - “GACS” to remember the order of the modifiers on the left-hand home row 146 - <kbd>Scroll Lock</kbd> is on the same key as <kbd>Caps Lock</kbd> because they're both locks 147 - <kbd>Delete</kbd> is on the same key as <kbd>Backspace</kbd> because they both erase characters 148 - <kbd>Home</kbd> is the leftmost position on the current line so it is above <kbd>←</kbd>. Same logic applies for <kbd>End</kbd>. 149 - <kbd>Media Previous</kbd> = ⏮, <kbd>Media Next</kbd> = ⏭ 150 - <kbd>Page Up</kbd>, <kbd>Page Down</kbd> and <kbd>Volume Up</kbd>, <kbd>Volume Down</kbd> are positioned like the main <kbd>Up</kbd> and <kbd>Down</kbd> keys. 151 152 ## Sym layer 153 ``` 154 Sym Layer: Numbers, symbols 155 156 ,-------------------------------------------. ,-------------------------------------------. 157 | ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | = | 158 |--------+------+------+------+------+------| |------+------+------+------+------+--------| 159 | ~ | ! | @ | # | $ | % | | ^ | & | * | ( | ) | + | 160 |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| 161 | | | \ | : | ; | - | [ | { | | | | } | ] | _ | , | . | / | ? | 162 `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------' 163 | | | | | | | | | | | | 164 | | | | | | | | | | | | 165 `----------------------------------' `----------------------------------' 166 ``` 167 The top row is the unshifted num row, the home row of the layer is the shifted num row and the bottom row contains the hyphen `-` and the underscore `_` on the best lower row spot because of how frequent they are as well as redundant symbols that are already present on the base layer but are reproduced here to avoid juggling back and forth between base, shift, and sym when typing a string of symbols. 168 169 The layout of the first two rows needs no introduction, you're already used to them but it's worth looking into the structure of the bottom row. 170 171 The two halves are mirrored in a sense. On the right, you can find <kbd>,</kbd> <kbd>.</kbd> <kbd>/</kbd> at their usual spots with the addition of <kbd>Shift</kbd>+<kbd>/</kbd>=<kbd>?</kbd> to the right of the <kbd>/</kbd> key to remove the need to press simultaneously <kbd>Sym</kbd> and a <kbd>Shift</kbd> key to access `?`. 172 173 Now, if you look at the left side, you'll notice that the mirror of <kbd>,</kbd> is <kbd>;</kbd>, the mirror of <kbd>.</kbd> is <kbd>:</kbd> and the mirror of <kbd>/</kbd> is <kbd>\\</kbd>. The same logic used for <kbd>Shift</kbd>+<kbd>/</kbd>=<kbd>?</kbd> also applies to <kbd>Shift</kbd>+<kbd>\\</kbd>=<kbd>|</kbd>. 174 175 In case you wish to combine <kbd>Shift</kbd> with a symbol key anyways, you can hold down <kbd>Shift</kbd> on the base layer with your pinky, activate <kbd>Sym</kbd> with your right thumb and while still holding down the <kbd>Shift</kbd> key, tap your desired symbol key. Same thing if you need <kbd>Ctrl</kbd>+<kbd>Digit</kbd>. 176 177 ## Function layer 178 ``` 179 Function Layer: Function keys 180 181 ,-------------------------------------------. ,-------------------------------------------. 182 | | F9 | F10 | F11 | F12 | | | | | | | | | 183 |--------+------+------+------+------+------| |------+------+------+------+------+--------| 184 | | F5 | F6 | F7 | F8 | | | | Shift| Ctrl | Alt | GUI | | 185 |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| 186 | | F1 | F2 | F3 | F4 | | | | | | | | | | | | | 187 `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------' 188 | | | | | | | | | | | | 189 | | | | | | | | | | | | 190 `----------------------------------' `----------------------------------' 191 ``` 192 In a similar fashion to the nav layer, pressing down `FKEYS` with the right thumb enables a numpad of function keys on the opposite hand and modifiers on the right-hand home row. Once again, mirror symmetry is leveraged in this keymap for the order of the right-hand modifiers. 193 194 The <kbd>Alt</kbd> modifier, despite being situated on the right half of the keyboard is *not* `KC_RALT`, it is `KC_LALT`. `KC_RALT` is actually the <kbd>AltGr</kbd> key which generally acts very differently to the left <kbd>Alt</kbd> key. Keyboard shortcuts involving <kbd>AltGr</kbd>+<kbd>F#</kbd> are rare and infrequent as opposed to the much more common <kbd>Alt</kbd>+<kbd>F#</kbd> shortcuts. Consequently, `KC_LALT` was chosen for the function layer. 195 196 Since there are more than 10 function keys, the cluster of F-keys does not follow the usual 3×3+1 numpad arrangement. 197 198 199 ## Adjust layer 200 ``` 201 Adjust Layer: Default layer settings, RGB 202 203 ,-------------------------------------------. ,-------------------------------------------. 204 | | | |QWERTY| | | | | | | | | | 205 |--------+------+------+------+------+------| |------+------+------+------+------+--------| 206 | | | |Dvorak| | | | TOG | SAI | HUI | VAI | MOD | | 207 |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| 208 | | | |Colmak| | | | | | | | | SAD | HUD | VAD | RMOD | | 209 `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------' 210 | | | | | | | | | | | | 211 | | | | | | | | | | | | 212 `----------------------------------' `----------------------------------' 213 ``` 214 215 Default layer settings on the left and various RGB underglow controls on the right. 216 217 The default layer settings are lined up on the middle finger column because the home middle finger key is <kbd>D</kbd> on QWERTY (like the “D” in “Dvorak”) and the lower middle finger key is <kbd>C</kbd> on QWERTY (like the “C” in “Colemak”). I can hear you say that “QWERTY” doesn't start with “E” but Dvorak and Colemak were already aligned in a column so the QWERTY may as well join the formation. 218 219 NOTE: The default layer settings set by those keys are *NOT* stored in EEPROM and thus do not persist through boots. If you wish to change the default layer in a non-volatile manner, either change the order of the layers in the firmware, for example like so if you want to set Dvorak as the new default: 220 ```c 221 enum layers { 222 _DVORAK = 0, 223 _QWERTY, 224 _COLEMAK_DH, 225 _NAV, 226 _SYM, 227 _FUNCTION, 228 _ADJUST 229 }; 230 ``` 231 or re-define the `QWERTY`, `COLEMAK` and `DVORAK` keys to point to custom keycodes starting on `SAFE_RANGE` and calling the `set_single_persistent_default_layer` function inside of `process_record_user`. 232 233 ## Hardware Features 234 235 ### Rotary Encoder 236 The left rotary encoder is programmed to control the volume whereas the right encoder sends <kbd>PgUp</kbd> or <kbd>PgDn</kbd> on every turn. 237 238 ## Going further… 239 240 This default keymap can be used as is, unchanged, as a daily driver for your Kyria but you're invited to treat your keymap like a bonsai. At the beginning, it's just like the default keymap but from time to time, you can tweak it a little. Cut a little key here, let another combo grow there. Slowly but surely it will be a unique keymap that will fit you like a glove. 241 242 Check out the #keymap-ideas channel on the official SplitKB Discord server for inspiration.