aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorprecondition <57645186+precondition@users.noreply.github.com>2021-08-22 07:11:32 +0200
committerGitHub <noreply@github.com>2021-08-21 22:11:32 -0700
commitaedd8cca310ecb45221566edcca34a749117329e (patch)
tree2140afcef9cc706997948809349fa5e10c3625eb
parent78ccd9c201199444bc06161b05ee8d7ba9c31613 (diff)
downloadqmk_firmware-aedd8cca310ecb45221566edcca34a749117329e.tar.gz
qmk_firmware-aedd8cca310ecb45221566edcca34a749117329e.zip
[Keyboard] Kyria default reformat (#14080)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
-rw-r--r--keyboards/splitkb/kyria/keymaps/default/keymap.c297
-rw-r--r--keyboards/splitkb/kyria/keymaps/default/readme.md249
2 files changed, 420 insertions, 126 deletions
diff --git a/keyboards/splitkb/kyria/keymaps/default/keymap.c b/keyboards/splitkb/kyria/keymaps/default/keymap.c
index db545c6a2..66c012d0c 100644
--- a/keyboards/splitkb/kyria/keymaps/default/keymap.c
+++ b/keyboards/splitkb/kyria/keymaps/default/keymap.c
@@ -15,7 +15,16 @@
15 */ 15 */
16#include QMK_KEYBOARD_H 16#include QMK_KEYBOARD_H
17 17
18enum layers { _QWERTY = 0, _DVORAK, _COLEMAK_DH, _NAV, _SYM, _FUNCTION, _ADJUST }; 18enum layers {
19 _QWERTY = 0,
20 _DVORAK,
21 _COLEMAK_DH,
22 _NAV,
23 _SYM,
24 _FUNCTION,
25 _ADJUST,
26};
27
19 28
20// Aliases for readability 29// Aliases for readability
21#define QWERTY DF(_QWERTY) 30#define QWERTY DF(_QWERTY)
@@ -36,137 +45,173 @@ enum layers { _QWERTY = 0, _DVORAK, _COLEMAK_DH, _NAV, _SYM, _FUNCTION, _ADJUST
36// The notation `mod/tap` denotes a key that activates the modifier `mod` when held down, and 45// The notation `mod/tap` denotes a key that activates the modifier `mod` when held down, and
37// produces the key `tap` when tapped (i.e. pressed and released). 46// produces the key `tap` when tapped (i.e. pressed and released).
38 47
48// clang-format off
39const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { 49const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
40 /* 50/*
41 * Base Layer: QWERTY 51 * Base Layer: QWERTY
42 * 52 *
43 * ,-------------------------------------------. ,-------------------------------------------. 53 * ,-------------------------------------------. ,-------------------------------------------.
44 * | Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp | 54 * | Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp |
45 * |--------+------+------+------+------+------| |------+------+------+------+------+--------| 55 * |--------+------+------+------+------+------| |------+------+------+------+------+--------|
46 * |Ctrl/Esc| A | S | D | F | G | | H | J | K | L | ; : |Ctrl/' "| 56 * |Ctrl/Esc| A | S | D | F | G | | H | J | K | L | ; : |Ctrl/' "|
47 * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| 57 * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
48 * | LShift | Z | X | C | V | B | [ { |CapsLk| |F-keys| ] } | N | M | , < | . > | / ? | RShift | 58 * | LShift | Z | X | C | V | B | [ { |CapsLk| |F-keys| ] } | N | M | , < | . > | / ? | RShift |
49 * `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------' 59 * `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
50 * |Adjust| LGUI | LAlt/| Space| Nav | | Sym | Space| AltGr| RGUI | Menu | 60 * |Adjust| LGUI | LAlt/| Space| Nav | | Sym | Space| AltGr| RGUI | Menu |
51 * | | | Enter| | | | | | | | | 61 * | | | Enter| | | | | | | | |
52 * `----------------------------------' `----------------------------------' 62 * `----------------------------------' `----------------------------------'
53 */ 63 */
54 [_QWERTY] = LAYOUT(KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC, CTL_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, CTL_QUOT, KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_LBRC, KC_CAPS, FKEYS, KC_RBRC, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, ADJUST, KC_LGUI, ALT_ENT, KC_SPC, NAV, SYM, KC_SPC, KC_RALT, KC_RGUI, KC_APP), 64 [_QWERTY] = LAYOUT(
65 KC_TAB , KC_Q , KC_W , KC_E , KC_R , KC_T , KC_Y, KC_U , KC_I , KC_O , KC_P , KC_BSPC,
66 CTL_ESC , KC_A , KC_S , KC_D , KC_F , KC_G , KC_H, KC_J , KC_K , KC_L ,KC_SCLN,CTL_QUOT,
67 KC_LSFT , KC_Z , KC_X , KC_C , KC_V , KC_B , KC_LBRC,KC_CAPS, FKEYS , KC_RBRC, KC_N, KC_M ,KC_COMM, KC_DOT ,KC_SLSH, KC_RSFT,
68 ADJUST , KC_LGUI, ALT_ENT, KC_SPC , NAV , SYM , KC_SPC ,KC_RALT, KC_RGUI, KC_APP
69 ),
55 70
56 /* 71/*
57 * Base Layer: Dvorak 72 * Base Layer: Dvorak
58 * 73 *
59 * ,-------------------------------------------. ,-------------------------------------------. 74 * ,-------------------------------------------. ,-------------------------------------------.
60 * | Tab | ' " | , < | . > | P | Y | | F | G | C | R | L | Bksp | 75 * | Tab | ' " | , < | . > | P | Y | | F | G | C | R | L | Bksp |
61 * |--------+------+------+------+------+------| |------+------+------+------+------+--------| 76 * |--------+------+------+------+------+------| |------+------+------+------+------+--------|
62 * |Ctrl/Esc| A | O | E | U | I | | D | H | T | N | S |Ctrl/- _| 77 * |Ctrl/Esc| A | O | E | U | I | | D | H | T | N | S |Ctrl/- _|
63 * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| 78 * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
64 * | LShift | ; : | Q | J | K | X | [ { |CapsLk| |F-keys| ] } | B | M | W | V | Z | RShift | 79 * | LShift | ; : | Q | J | K | X | [ { |CapsLk| |F-keys| ] } | B | M | W | V | Z | RShift |
65 * `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------' 80 * `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
66 * |Adjust| LGUI | LAlt/| Space| Nav | | Sym | Space| AltGr| RGUI | Menu | 81 * |Adjust| LGUI | LAlt/| Space| Nav | | Sym | Space| AltGr| RGUI | Menu |
67 * | | | Enter| | | | | | | | | 82 * | | | Enter| | | | | | | | |
68 * `----------------------------------' `----------------------------------' 83 * `----------------------------------' `----------------------------------'
69 */ 84 */
70 [_DVORAK] = LAYOUT(KC_TAB, KC_QUOTE, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC, CTL_ESC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, CTL_MINS, KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_LBRC, KC_CAPS, FKEYS, KC_RBRC, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_RSFT, ADJUST, KC_LGUI, ALT_ENT, KC_SPC, NAV, SYM, KC_SPC, KC_RALT, KC_RGUI, KC_APP), 85 [_DVORAK] = LAYOUT(
86 KC_TAB ,KC_QUOTE,KC_COMM, KC_DOT, KC_P , KC_Y , KC_F, KC_G , KC_C , KC_R , KC_L , KC_BSPC,
87 CTL_ESC , KC_A , KC_O , KC_E , KC_U , KC_I , KC_D, KC_H , KC_T , KC_N , KC_S , CTL_MINS,
88 KC_LSFT ,KC_SCLN, KC_Q , KC_J , KC_K , KC_X , KC_LBRC,KC_CAPS, FKEYS , KC_RBRC, KC_B, KC_M , KC_W , KC_V , KC_Z , KC_RSFT,
89 ADJUST, KC_LGUI, ALT_ENT, KC_SPC , NAV , SYM , KC_SPC ,KC_RALT, KC_RGUI, KC_APP
90 ),
71 91
72 /* 92/*
73 * Base Layer: Colemak DH 93 * Base Layer: Colemak DH
74 * 94 *
75 * ,-------------------------------------------. ,-------------------------------------------. 95 * ,-------------------------------------------. ,-------------------------------------------.
76 * | Tab | Q | W | F | P | B | | J | L | U | Y | ; : | Bksp | 96 * | Tab | Q | W | F | P | B | | J | L | U | Y | ; : | Bksp |
77 * |--------+------+------+------+------+------| |------+------+------+------+------+--------| 97 * |--------+------+------+------+------+------| |------+------+------+------+------+--------|
78 * |Ctrl/Esc| A | R | S | T | G | | M | N | E | I | O |Ctrl/' "| 98 * |Ctrl/Esc| A | R | S | T | G | | M | N | E | I | O |Ctrl/' "|
79 * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| 99 * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
80 * | LShift | Z | X | C | D | V | [ { |CapsLk| |F-keys| ] } | K | H | , < | . > | / ? | RShift | 100 * | LShift | Z | X | C | D | V | [ { |CapsLk| |F-keys| ] } | K | H | , < | . > | / ? | RShift |
81 * `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------' 101 * `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
82 * |Adjust| LGUI | LAlt/| Space| Nav | | Sym | Space| AltGr| RGUI | Menu | 102 * |Adjust| LGUI | LAlt/| Space| Nav | | Sym | Space| AltGr| RGUI | Menu |
83 * | | | Enter| | | | | | | | | 103 * | | | Enter| | | | | | | | |
84 * `----------------------------------' `----------------------------------' 104 * `----------------------------------' `----------------------------------'
85 */ 105 */
86 [_COLEMAK_DH] = LAYOUT(KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_B, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC, CTL_ESC, KC_A, KC_R, KC_S, KC_T, KC_G, KC_M, KC_N, KC_E, KC_I, KC_O, CTL_QUOT, KC_LSFT, KC_Z, KC_X, KC_C, KC_D, KC_V, KC_LBRC, KC_CAPS, FKEYS, KC_RBRC, KC_K, KC_H, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, ADJUST, KC_LGUI, ALT_ENT, KC_SPC, NAV, SYM, KC_SPC, KC_RALT, KC_RGUI, KC_APP), 106 [_COLEMAK_DH] = LAYOUT(
107 KC_TAB , KC_Q , KC_W , KC_F , KC_P , KC_B , KC_J, KC_L , KC_U , KC_Y ,KC_SCLN, KC_BSPC,
108 CTL_ESC , KC_A , KC_R , KC_S , KC_T , KC_G , KC_M, KC_N , KC_E , KC_I , KC_O , CTL_QUOT,
109 KC_LSFT , KC_Z , KC_X , KC_C , KC_D , KC_V , KC_LBRC,KC_CAPS, FKEYS , KC_RBRC, KC_K, KC_H ,KC_COMM, KC_DOT ,KC_SLSH, KC_RSFT,
110 ADJUST, KC_LGUI, ALT_ENT, KC_SPC , NAV , SYM , KC_SPC ,KC_RALT, KC_RGUI, KC_APP
111 ),
87 112
88 /* 113/*
89 * Nav Layer: Media, navigation 114 * Nav Layer: Media, navigation
90 * 115 *
91 * ,-------------------------------------------. ,-------------------------------------------. 116 * ,-------------------------------------------. ,-------------------------------------------.
92 * | | | | | | | | PgUp | Home | ↑ | End | VolUp| Delete | 117 * | | | | | | | | PgUp | Home | ↑ | End | VolUp| Delete |
93 * |--------+------+------+------+------+------| |------+------+------+------+------+--------| 118 * |--------+------+------+------+------+------| |------+------+------+------+------+--------|
94 * | | GUI | Alt | Ctrl | Shift| | | PgDn | ← | ↓ | → | VolDn| Insert | 119 * | | GUI | Alt | Ctrl | Shift| | | PgDn | ← | ↓ | → | VolDn| Insert |
95 * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| 120 * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
96 * | | | | | | | |ScLck | | | | Pause|M Prev|M Play|M Next|VolMut| PrtSc | 121 * | | | | | | | |ScLck | | | | Pause|M Prev|M Play|M Next|VolMut| PrtSc |
97 * `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------' 122 * `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
98 * | | | | | | | | | | | | 123 * | | | | | | | | | | | |
99 * | | | | | | | | | | | | 124 * | | | | | | | | | | | |
100 * `----------------------------------' `----------------------------------' 125 * `----------------------------------' `----------------------------------'
101 */ 126 */
102 [_NAV] = LAYOUT(_______, _______, _______, _______, _______, _______, KC_PGUP, KC_HOME, KC_UP, KC_END, KC_VOLU, KC_DEL, _______, KC_LGUI, KC_LALT, KC_LCTL, KC_LSFT, _______, KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, KC_VOLD, KC_INS, _______, _______, _______, _______, _______, _______, _______, KC_SLCK, _______, _______, KC_PAUSE, KC_MPRV, KC_MPLY, KC_MNXT, KC_MUTE, KC_PSCR, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______), 127 [_NAV] = LAYOUT(
128 _______, _______, _______, _______, _______, _______, KC_PGUP, KC_HOME, KC_UP, KC_END, KC_VOLU, KC_DEL,
129 _______, KC_LGUI, KC_LALT, KC_LCTL, KC_LSFT, _______, KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, KC_VOLD, KC_INS,
130 _______, _______, _______, _______, _______, _______, _______, KC_SLCK, _______, _______,KC_PAUSE, KC_MPRV, KC_MPLY, KC_MNXT, KC_MUTE, KC_PSCR,
131 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
132 ),
103 133
104 /* 134/*
105 * Sym Layer: Numbers and symbols 135 * Sym Layer: Numbers and symbols
106 * 136 *
107 * ,-------------------------------------------. ,-------------------------------------------. 137 * ,-------------------------------------------. ,-------------------------------------------.
108 * | ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | = | 138 * | ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | = |
109 * |--------+------+------+------+------+------| |------+------+------+------+------+--------| 139 * |--------+------+------+------+------+------| |------+------+------+------+------+--------|
110 * | ~ | ! | @ | # | $ | % | | ^ | & | * | ( | ) | + | 140 * | ~ | ! | @ | # | $ | % | | ^ | & | * | ( | ) | + |
111 * |--------+------+------+------+------+------+-------------. ,------+-------------+------+------+------+------+--------| 141 * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
112 * | | | \ | : | ; | - | \ | | [ { | | | | ] } | # ~ | _ | , | . | / | ? | 142 * | | | \ | : | ; | - | [ | { | | | | } | ] | _ | , | . | / | ? |
113 * `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------' 143 * `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
114 * | | | | | | | | | | | | 144 * | | | | | | | | | | | |
115 * | | | | | | | | | | | | 145 * | | | | | | | | | | | |
116 * `----------------------------------' `----------------------------------' 146 * `----------------------------------' `----------------------------------'
117 */ 147 */
118 [_SYM] = LAYOUT(KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_EQL, KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_PLUS, KC_PIPE, KC_BSLS, KC_COLN, KC_SCLN, KC_MINS, KC_NUBS, KC_LBRC, _______, _______, KC_RBRC, KC_NUHS, KC_UNDS, KC_COMM, KC_DOT, KC_SLSH, KC_QUES, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______), 148 [_SYM] = LAYOUT(
149 KC_GRV , KC_1 , KC_2 , KC_3 , KC_4 , KC_5 , KC_6 , KC_7 , KC_8 , KC_9 , KC_0 , KC_EQL ,
150 KC_TILD , KC_EXLM, KC_AT , KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_PLUS,
151 KC_PIPE , KC_BSLS, KC_COLN, KC_SCLN, KC_MINS, KC_LBRC, KC_LCBR, _______, _______, KC_RCBR, KC_RBRC, KC_UNDS, KC_COMM, KC_DOT, KC_SLSH, KC_QUES,
152 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
153 ),
119 154
120 /* 155/*
121 * Function Layer: Function keys 156 * Function Layer: Function keys
122 * 157 *
123 * ,-------------------------------------------. ,-------------------------------------------. 158 * ,-------------------------------------------. ,-------------------------------------------.
124 * | | F9 | F10 | F11 | F12 | | | | | | | | | 159 * | | F9 | F10 | F11 | F12 | | | | | | | | |
125 * |--------+------+------+------+------+------| |------+------+------+------+------+--------| 160 * |--------+------+------+------+------+------| |------+------+------+------+------+--------|
126 * | | F5 | F6 | F7 | F8 | | | | Shift| Ctrl | Alt | GUI | | 161 * | | F5 | F6 | F7 | F8 | | | | Shift| Ctrl | Alt | GUI | |
127 * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| 162 * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
128 * | | F1 | F2 | F3 | F4 | | | | | | | | | | | | | 163 * | | F1 | F2 | F3 | F4 | | | | | | | | | | | | |
129 * `--------+------+------+--------------------+------+------| |------+------+------+------+------+----------------------' 164 * `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
130 * | | | | | | | | | | | | 165 * | | | | | | | | | | | |
131 * | | | | | | | | | | | | 166 * | | | | | | | | | | | |
132 * `----------------------------------' `----------------------------------' 167 * `----------------------------------' `----------------------------------'
133 */ 168 */
134 [_FUNCTION] = LAYOUT(_______, KC_F9, KC_F10, KC_F11, KC_F12, _______, _______, _______, _______, _______, _______, _______, _______, KC_F5, KC_F6, KC_F7, KC_F8, _______, _______, KC_RSFT, KC_RCTL, KC_LALT, KC_RGUI, _______, _______, KC_F1, KC_F2, KC_F3, KC_F4, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______), 169 [_FUNCTION] = LAYOUT(
170 _______, KC_F9 , KC_F10, KC_F11, KC_F12, _______, _______, _______, _______, _______, _______, _______,
171 _______, KC_F5 , KC_F6 , KC_F7 , KC_F8 , _______, _______, KC_RSFT, KC_RCTL, KC_LALT, KC_RGUI, _______,
172 _______, KC_F1 , KC_F2 , KC_F3 , KC_F4 , _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
173 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
174 ),
135 175
136 /* 176/*
137 * Adjust Layer: Default layer settings, RGB 177 * Adjust Layer: Default layer settings, RGB
138 * 178 *
139 * ,-------------------------------------------. ,-------------------------------------------. 179 * ,-------------------------------------------. ,-------------------------------------------.
140 * | | | |QWERTY| | | | | | | | | | 180 * | | | |QWERTY| | | | | | | | | |
141 * |--------+------+------+------+------+------| |------+------+------+------+------+--------| 181 * |--------+------+------+------+------+------| |------+------+------+------+------+--------|
142 * | | | |Dvorak| | | | TOG | SAI | HUI | VAI | MOD | | 182 * | | | |Dvorak| | | | TOG | SAI | HUI | VAI | MOD | |
143 * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| 183 * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
144 * | | | |Colmak| | | | | | | | | SAD | HUD | VAD | RMOD | | 184 * | | | |Colmak| | | | | | | | | SAD | HUD | VAD | RMOD | |
145 * `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------' 185 * `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
146 * | | | | | | | | | | | | 186 * | | | | | | | | | | | |
147 * | | | | | | | | | | | | 187 * | | | | | | | | | | | |
148 * `----------------------------------' `----------------------------------' 188 * `----------------------------------' `----------------------------------'
149 */ 189 */
150 [_ADJUST] = LAYOUT(_______, _______, _______, QWERTY, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, DVORAK, _______, _______, RGB_TOG, RGB_SAI, RGB_HUI, RGB_VAI, RGB_MOD, _______, _______, _______, _______, COLEMAK, _______, _______, _______, _______, _______, _______, _______, RGB_SAD, RGB_HUD, RGB_VAD, RGB_RMOD, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______), 190 [_ADJUST] = LAYOUT(
191 _______, _______, _______, QWERTY , _______, _______, _______, _______, _______, _______, _______, _______,
192 _______, _______, _______, DVORAK , _______, _______, RGB_TOG, RGB_SAI, RGB_HUI, RGB_VAI, RGB_MOD, _______,
193 _______, _______, _______, COLEMAK, _______, _______,_______, _______, _______, _______, _______, RGB_SAD, RGB_HUD, RGB_VAD, RGB_RMOD, _______,
194 _______, _______, _______,_______, _______, _______, _______, _______, _______, _______
195 ),
151 196
152 // /* 197// /*
153 // * Layer template 198// * Layer template
154 // * 199// *
155 // * ,-------------------------------------------. ,-------------------------------------------. 200// * ,-------------------------------------------. ,-------------------------------------------.
156 // * | | | | | | | | | | | | | | 201// * | | | | | | | | | | | | | |
157 // * |--------+------+------+------+------+------| |------+------+------+------+------+--------| 202// * |--------+------+------+------+------+------| |------+------+------+------+------+--------|
158 // * | | | | | | | | | | | | | | 203// * | | | | | | | | | | | | | |
159 // * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| 204// * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
160 // * | | | | | | | | | | | | | | | | | | 205// * | | | | | | | | | | | | | | | | | |
161 // * `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------' 206// * `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
162 // * | | | | | | | | | | | | 207// * | | | | | | | | | | | |
163 // * | | | | | | | | | | | | 208// * | | | | | | | | | | | |
164 // * `----------------------------------' `----------------------------------' 209// * `----------------------------------' `----------------------------------'
165 // */ 210// */
166 // [_LAYERINDEX] = LAYOUT( 211// [_LAYERINDEX] = LAYOUT(
167 // _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, 212// _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
168 // _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, 213// _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
169 // _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, 214// _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
170 // _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ 215// _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
171 // ), 216// ),
172}; 217};
diff --git a/keyboards/splitkb/kyria/keymaps/default/readme.md b/keyboards/splitkb/kyria/keymaps/default/readme.md
new file mode 100644
index 000000000..7401609f3
--- /dev/null
+++ b/keyboards/splitkb/kyria/keymaps/default/readme.md
@@ -0,0 +1,249 @@
1# Kyria's Default Keymap
2
3![KLE render of the default Kyria keymap with QWERTY as the base layer. Layers are shown in sublegends.](https://i.ibb.co/RQZx2dY/default-kyria2.jpg)
4
5
6The default keymap contains 5 layers which allows it to include all keys found on an ANSI layout TKL keyboard plus media keys.
7Hardware features of the Kyria such as OLEDs, rotary encoders and underglow are also supported.
8
9The five different layers are the following:
101. Base layer (QWERTY, Colemak-DH or Dvorak)
112. Navigation layer
123. Symbols/Numbers layer
134. Function layer
145. Adjust layer
15
16## Base layer(s)
17```
18Base Layer: -
19
20,-------------------------------------------. ,-------------------------------------------.
21| Tab | - | - | - | - | - | | - | - | - | - | - | Bksp |
22|--------+------+------+------+------+------| |------+------+------+------+------+--------|
23|Ctrl/Esc| - | - | - | - | - | | - | - | - | - | - |Ctrl/ - |
24|--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
25| LShift | - | - | - | - | - | [ { |CapsLk| |F-Keys| ] } | - | - | - | - | - | RShift |
26`----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
27 |Adjust| LGUI | LAlt/| Space| Nav | | Sym | Space| AltGr| RGUI | Menu |
28 | | | Enter| | | | | | | | |
29 `----------------------------------' `----------------------------------'
30```
31Three 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).
32
33For 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”.
34
35```
36Base Layer: QWERTY
37
38,-------------------------------------------. ,-------------------------------------------.
39| Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp |
40|--------+------+------+------+------+------| |------+------+------+------+------+--------|
41|Ctrl/Esc| A | S | D | F | G | | H | J | K | L | ; : |Ctrl/' "|
42|--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
43| LShift | Z | X | C | V | B | [ { |CapsLk| |F-keys| ] } | N | M | , < | . > | / ? | RShift |
44`----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
45 |Adjust| LGUI | LAlt/| Space| Nav | | Sym | Space| AltGr| RGUI | Menu |
46 | | | Enter| | | | | | | | |
47 `----------------------------------' `----------------------------------'
48```
49
50Aside from variations in the alpha cluster, the rest of the base keys remain the same and are designed to feel familiar.
51
52![Step-by-step animation of the transformation of an ortholinear TKL to a Kyria](https://i.imgur.com/uVDCOek.gif)
53
54<details>
55After 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:
56
57```
58,-------------------------------------------. ,-------------------------------------------.
59| Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp |
60|--------+------+------+------+------+------| |------+------+------+------+------+--------|
61| Cap Lk | A | S | D | F | G | | H | J | K | L | ; : | ' " |
62|--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
63| LShift | Z | X | C | V | B | | | | | | N | M | , < | . > | / ? | RShift |
64`----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
65 | LCtrl| LGUI | LAlt | Space| | | | Space| AltGr| RGUI | Menu |
66 | | | | | | | | | | | |
67 `----------------------------------' '----------------------------------'
68```
69
70First 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.
71
72The 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.
73
74We 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?
75
76All of this leaves us with three blank keys.
77
78```
79,-------------------------------------------. ,-------------------------------------------.
80| Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp |
81|--------+------+------+------+------+------| |------+------+------+------+------+--------|
82|Ctrl/Esc| A | S | D | F | G | | H | J | K | L | ; : | ' " |
83|--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
84| LShift | Z | X | C | V | B | [ { | | | | ] } | N | M | , < | . > | / ? | RShift |
85`--------+-------------+--------------------+------+------| |------+------+--------------------+------+---------------'
86 | | LGUI | LAlt | Space| Nav | | Sym | Space| AltGr| RGUI | Menu |
87 | | | | | | | | | | | |
88 `----------------------------------' '----------------------------------'
89```
90
91These 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.
92
93```
94,-------------------------------------------. ,-------------------------------------------.
95| Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp |
96|--------+------+------+------+------+------| |------+------+------+------+------+--------|
97|Ctrl/Esc| A | S | D | F | G | | H | J | K | L | ; : | ' " |
98|--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
99| LShift | Z | X | C | V | B | [ { |CapsLk| |F-keys| ] } | N | M | , < | . > | / ? | RShift |
100`----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
101 |Adjust| LGUI | LAlt | Space| Nav | | Sym | Space| AltGr| RGUI | Menu |
102 | | | | | | | | | | | |
103 `----------------------------------' `----------------------------------'
104```
105
106The 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.
107
108Finally, 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.
109
110
111```
112,-------------------------------------------. ,-------------------------------------------.
113| Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp |
114|--------+------+------+------+------+------| |------+------+------+------+------+--------|
115|Ctrl/Esc| A | S | D | F | G | | H | J | K | L | ; : |Ctrl/' "|
116|--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
117| LShift | Z | X | C | V | B | [ { |CapsLk| |F-keys| ] } | N | M | , < | . > | / ? | RShift |
118`----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
119 |Adjust| LGUI | LAlt/| Space| Nav | | Sym | Space| AltGr| RGUI | Menu |
120 | | | Enter| | | | | | | | |
121 `----------------------------------' `----------------------------------'
122```
123
124</details>
125
126## Navigation layer
127
128```
129Nav Layer: Media, navigation
130
131,-------------------------------------------. ,-------------------------------------------.
132| | | | | | | | PgUp | Home | ↑ | End | VolUp| Delete |
133|--------+------+------+------+------+------| |------+------+------+------+------+--------|
134| | GUI | Alt | Ctrl | Shift| | | PgDn | ← | ↓ | → | VolDn| Insert |
135|--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
136| | | | | | | |ScLck | | | | Pause|M Prev|M Play|M Next|VolMut| PrtSc |
137`----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
138 | | | | | | | | | | | |
139 | | | | | | | | | | | |
140 `----------------------------------' `----------------------------------'
141```
142
143This 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.
144
145Useful mnemonics:
146- “GACS” to remember the order of the modifiers on the left-hand home row
147- <kbd>Scroll Lock</kbd> is on the same key as <kbd>Caps Lock</kbd> because they're both locks
148- <kbd>Delete</kbd> is on the same key as <kbd>Backspace</kbd> because they both erase characters
149- <kbd>Home</kbd> is the leftmost position on the current line so it is above <kbd>←</kbd>. Same logic applies for <kbd>End</kbd>.
150- <kbd>Media Previous</kbd> = ⏮, <kbd>Media Next</kbd> = ⏭
151- <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.
152
153## Sym layer
154```
155Sym Layer: Numbers, symbols
156
157,-------------------------------------------. ,-------------------------------------------.
158| ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | = |
159|--------+------+------+------+------+------| |------+------+------+------+------+--------|
160| ~ | ! | @ | # | $ | % | | ^ | & | * | ( | ) | + |
161|--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
162| | | \ | : | ; | - | [ | { | | | | } | ] | _ | , | . | / | ? |
163`----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
164 | | | | | | | | | | | |
165 | | | | | | | | | | | |
166 `----------------------------------' `----------------------------------'
167```
168The 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.
169
170The 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.
171
172The 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 `?`.
173
174Now, 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>.
175
176In 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>.
177
178## Function layer
179```
180Function Layer: Function keys
181
182,-------------------------------------------. ,-------------------------------------------.
183| | F9 | F10 | F11 | F12 | | | | | | | | |
184|--------+------+------+------+------+------| |------+------+------+------+------+--------|
185| | F5 | F6 | F7 | F8 | | | | Shift| Ctrl | Alt | GUI | |
186|--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
187| | F1 | F2 | F3 | F4 | | | | | | | | | | | | |
188`----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
189 | | | | | | | | | | | |
190 | | | | | | | | | | | |
191 `----------------------------------' `----------------------------------'
192```
193In 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.
194
195The <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.
196
197Since there are more than 10 function keys, the cluster of F-keys does not follow the usual 3×3+1 numpad arrangement.
198
199
200## Adjust layer
201```
202Adjust Layer: Default layer settings, RGB
203
204,-------------------------------------------. ,-------------------------------------------.
205| | | |QWERTY| | | | | | | | | |
206|--------+------+------+------+------+------| |------+------+------+------+------+--------|
207| | | |Dvorak| | | | TOG | SAI | HUI | VAI | MOD | |
208|--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
209| | | |Colmak| | | | | | | | | SAD | HUD | VAD | RMOD | |
210`----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
211 | | | | | | | | | | | |
212 | | | | | | | | | | | |
213 `----------------------------------' `----------------------------------'
214```
215
216Default layer settings on the left and various RGB underglow controls on the right.
217
218The 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.
219
220NOTE: 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:
221```c
222enum layers {
223 _DVORAK = 0,
224 _QWERTY,
225 _COLEMAK_DH,
226 _NAV,
227 _SYM,
228 _FUNCTION,
229 _ADJUST
230};
231```
232or 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`.
233
234## Hardware Features
235
236### Rotary Encoder
237The left rotary encoder is programmed to control the volume whereas the right encoder sends <kbd>PgUp</kbd> or <kbd>PgDn</kbd> on every turn.
238
239### OLEDs
240The OLEDs display the current layer at the top of the active layers stack, the Kyria logo and lock status (caps lock, num lock, scroll lock).
241
242### Underglow
243The underglow LEDs should be red.
244
245## Going further…
246
247This 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.
248
249Check out the #keymap-ideas channel on the official SplitKB Discord server for inspiration.