1 // This is the canonical layout file for the Quantum project. If you want to add another keyboard,
2 // this is the style you want to emulate.
5 #include "action_layer.h"
11 extern keymap_config_t keymap_config;
13 // Each layer gets a name for readability, which is then used in the keymap matrix below.
14 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
15 // Layer names don't all need to be of the same length, obviously, and you can also skip them
16 // entirely and just use numbers.
23 #define _TOUCHCURSOR 6
24 #define _MOUSECURSOR 7
28 enum planck_keycodes {
57 // Fillers to make layering more clear
58 #define _______ KC_TRNS
62 #define CTL_ESC CTL_T(KC_ESC) // Tap for Esc, hold for Ctrl
63 #define SFT_ENT SFT_T(KC_ENT) // Tap for Enter, hold for Shift
64 #define HPR_TAB ALL_T(KC_TAB) // Tap for Tab, hold for Hyper
65 #define GUI_SEM GUI_T(KC_SCLN) // Tap for Semicolon, hold for GUI
66 #define ALT_QUO ALT_T(KC_QUOT) // Tap for Quote, hold for Alt
67 // Requires KC_TRNS/_______ for the trigger key in the destination layer
68 #define LT_TC LT(_TOUCHCURSOR, KC_SPC) // L-ayer T-ap T-ouch C-ursor
69 #define LT_MC(kc) LT(_MOUSECURSOR, kc) // L-ayer T-ap M-ouse C-ursor
70 #define ALT_TAB M(KC_ALT_TAB) // Macro for Alt-Tab
71 #define CMD_TAB M(KC_CMD_TAB) // Macro for Cmd-Tab
72 #define CTL_TAB M(KC_CTL_TAB) // Macro for Ctl-Tab
73 #define CMD_SLSH M(KC_CMD_SLSH) // Macro for Cmd-Slash (personal shortcut to toggle iTerm2 visibility)
74 #define AG_FIND M(KC_AG_FIND) // Macros for Cmd-[x] vs Ctrl-[x] based on current AG_NORM or AG_SWAP settings
75 #define AG_AGAIN M(KC_AG_AGAIN)
76 #define AG_UNDO M(KC_AG_UNDO)
77 #define AG_CUT M(KC_AG_CUT)
78 #define AG_COPY M(KC_AG_COPY)
79 #define AG_PASTE M(KC_AG_PASTE)
80 #define AG_D_L M(KC_AG_DESK_L) // For Virtual Desktop Switching: Left, and
81 #define AG_D_R M(KC_AG_DESK_R) // Right
82 #define AG_T_C M(KC_AG_TAB_C) // For Chrome, etc. Tab Close,
83 #define AG_T_N M(KC_AG_TAB_N) // Tab New, and
84 #define AG_T_R M(KC_AG_TAB_R) // Tab Reopen Closed
86 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
89 * ,-----------------------------------------------------------------------------------------.
90 * | Hyper/Tab| Q | W | E | R | T | Y | U | I | O | P | Bksp |
91 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
92 * | Ctrl/Esc | A | S | MC/D | F | G | H | J | K | L |GUI/; | Alt/" |
93 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
94 * | Shift | Z | X | C | V | B | N | M | , | . | / |Sft/Ent |
95 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
96 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
97 * `-----------------------------------------------------------------------------------------'
100 {HPR_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC},
101 {CTL_ESC, KC_A, KC_S, LT_MC(KC_D),KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, GUI_SEM, ALT_QUO},
102 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_ENT},
103 {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER, LT_TC, LT_TC, RAISE, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
107 * ,-----------------------------------------------------------------------------------------.
108 * | Hyper/Tab| Q | W | F | P | G | J | L | U | Y | ; | Bksp |
109 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
110 * | Ctrl/Esc | A | R | MC/S | T | D | H | N | E | I | O | " |
111 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
112 * | Shift | Z | X | C | V | B | K | M | , | . | / |Sft/Ent |
113 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
114 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
115 * `-----------------------------------------------------------------------------------------'
118 {HPR_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC},
119 {CTL_ESC, KC_A, KC_R, LT_MC(KC_S),KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT},
120 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_ENT},
121 {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER, LT_TC, LT_TC, RAISE, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
125 * ,-----------------------------------------------------------------------------------------.
126 * | Hyper/Tab| " | , | . | P | Y | F | G | C | R | L | Bksp |
127 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
128 * | Ctrl/Esc | A | O | MC/E | U | I | D | H | T | N | S | / |
129 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
130 * | Shift | ; | Q | J | K | X | B | M | W | V | Z |Sft/Ent |
131 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
132 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
133 * `-----------------------------------------------------------------------------------------'
136 {HPR_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC},
137 {CTL_ESC, KC_A, KC_O, LT_MC(KC_E),KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH},
138 {KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, SFT_ENT},
139 {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER, LT_TC, LT_TC, RAISE, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
143 * ,-----------------------------------------------------------------------------------.
144 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
145 * |------+------+------+------+------+-------------+------+------+------+------+------|
146 * | [ | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
147 * |------+------+------+------+------+------|------+------+------+------+------+------|
148 * | ] | F7 | F8 | F9 | F10 | F11 | F12 | - | = | [ | ] | \ |
149 * |------+------+------+------+------+------+------+------+------+------+------+------|
150 * |Brite | | | | | | | Prev | Stop | Slct | Mute |
151 * `-----------------------------------------------------------------------------------'
154 {KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
155 {KC_LBRC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
156 {KC_RBRC, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS},
157 {BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPRV, KC_MSTP, KC_MSEL, KC_MUTE}
161 * ,-----------------------------------------------------------------------------------.
162 * | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
163 * |------+------+------+------+------+-------------+------+------+------+------+------|
164 * | $ | 4 | 5 | 6 | . | + | . | 4 | 5 | 6 | * | | |
165 * |------+------+------+------+------+------|------+------+------+------+------+------|
166 * | = | 7 | 8 | 9 | 0 | - | . | 1 | 2 | 3 | / | \ |
167 * |------+------+------+------+------+------+------+------+------+------+------+------|
168 * |Brite | | | | | | | Prev | Stop | Slct | Mute |
169 * `-----------------------------------------------------------------------------------'
172 {KC_0, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
173 {KC_DLR, KC_4, KC_5, KC_6, KC_DOT, KC_PLUS, KC_DOT, KC_4, KC_5, KC_6, KC_ASTR, KC_PIPE},
174 {KC_EQL, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_DOT, KC_1, KC_2, KC_3, KC_SLSH, KC_BSLS},
175 {BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPRV, KC_MSTP, KC_MSEL, KC_MUTE}
178 /* TouchCursor layer (http://martin-stone.github.io/touchcursor/) plus personal customizations
179 * ,-----------------------------------------------------------------------------------.
180 * |AltTab|CmdTab|CtlTab| GUI |Shift | ~ |Insert| Home | Up | End | Bksp | |
181 * |------+------+------+------+------+-------------+------+------+------+------+------|
182 * | | Alt |Space |Tab_C | Find |Again | PgUp | Left | Down |Right |Desk_L|Desk_R|
183 * |------+------+------+------+------+------|------+------+------+------+------+------|
184 * | | Undo | Cut | Copy |Paste | ` | PgDn | Del |Tab_N |Tab_R |iTerm2| |
185 * |------+------+------+------+------+------+------+------+------+------+------+------|
186 * | | | | | | | | | | | |
187 * `-----------------------------------------------------------------------------------'
189 * The KC_UNDO, KC_CUT, KC_COPY, KC_PASTE, KC_FIND, and KC_AGAIN keycodes don't
190 * seem to work on Mac. Presumably they'll work under Windows.
194 {ALT_TAB, CMD_TAB, CTL_TAB, KC_LGUI, KC_LSFT, KC_TILD, KC_INS, KC_HOME, KC_UP, KC_END, KC_BSPC, _______},
195 {_______, KC_LALT, KC_SPC, AG_T_C, AG_FIND,AG_AGAIN, KC_PGUP, KC_LEFT, KC_DOWN, KC_RGHT, AG_D_L, AG_D_R },
196 {_______, AG_UNDO, AG_CUT, AG_COPY, AG_PASTE,KC_GRV, KC_PGDN, KC_DEL, AG_T_N, AG_T_R, CMD_SLSH,_______},
197 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
201 * ,-----------------------------------------------------------------------------------.
202 * | | |ACCL0 | | | | |WHL_L | Up |WHL_R | BTN2 | |
203 * |------+------+------+------+------+-------------+------+------+------+------+------|
204 * | |ACCL2 | BTN2 | | BTN1 |ACCL1 |WHL_Up| Left | Down |Right | BTN4 | BTN5 |
205 * |------+------+------+------+------+------|------+------+------+------+------+------|
206 * | | | | | BTN3 | |WHL_Dn| BTN1 | | | BTN3 | |
207 * |------+------+------+------+------+------+------+------+------+------+------+------|
208 * | | | | | | | | | | | |
209 * `-----------------------------------------------------------------------------------'
213 {_______, _______, KC_ACL0, _______, _______, _______, _______, KC_WH_L, KC_MS_U, KC_WH_R, KC_BTN2, _______},
214 {_______, KC_ACL2, KC_BTN2, _______, KC_BTN1, KC_ACL1, KC_WH_U, KC_MS_L, KC_MS_D, KC_MS_R, KC_BTN4, KC_BTN5},
215 {_______, _______, _______, _______, KC_BTN3, _______, KC_WH_D, KC_BTN1, _______, _______, KC_BTN3, _______},
216 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
219 /* Plover layer (http://opensteno.org)
220 * ,-----------------------------------------------------------------------------------.
221 * | # | # | # | # | # | # | # | # | # | # | # | # |
222 * |------+------+------+------+------+-------------+------+------+------+------+------|
223 * | | S | T | P | H | * | * | F | P | L | T | D |
224 * |------+------+------+------+------+------|------+------+------+------+------+------|
225 * |TogOut| S | K | W | R | * | * | R | B | G | S | Z |
226 * |------+------+------+------+------+------+------+------+------+------+------+------|
227 * | Exit | | | A | O | | E | U | | | |
228 * `-----------------------------------------------------------------------------------'
232 {KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 },
233 {XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC},
234 {XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
235 {EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX}
238 /* Adjust (Lower + Raise)
239 * ,-----------------------------------------------------------------------------------.
240 * | | | | | | | | | | | | Del |
241 * |------+------+------+------+------+-------------+------+------+------+------+------|
242 * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
243 * |------+------+------+------+------+------|------+------+------+------+------+------|
244 * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
245 * |------+------+------+------+------+------+------+------+------+------+------+------|
246 * | | | | | | | | | | |Reset |
247 * `-----------------------------------------------------------------------------------'
250 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
251 {_______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______},
252 {_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______},
253 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RESET}
261 float tone_startup[][2] = SONG(STARTUP_SOUND);
262 float tone_qwerty[][2] = SONG(QWERTY_SOUND);
263 float tone_dvorak[][2] = SONG(DVORAK_SOUND);
264 float tone_colemak[][2] = SONG(COLEMAK_SOUND);
265 float tone_plover[][2] = SONG(PLOVER_SOUND);
266 float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND);
267 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
269 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
273 void persistent_default_layer_set(uint16_t default_layer) {
274 eeconfig_update_default_layer(default_layer);
275 default_layer_set(default_layer);
278 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
281 if (record->event.pressed) {
283 PLAY_SONG(tone_qwerty);
285 default_layer_set(1UL<<_QWERTY);
290 if (record->event.pressed) {
292 PLAY_SONG(tone_colemak);
294 default_layer_set(1UL<<_COLEMAK);
299 if (record->event.pressed) {
301 PLAY_SONG(tone_dvorak);
303 default_layer_set(1UL<<_DVORAK);
308 if (record->event.pressed) {
310 update_tri_layer(_LOWER, _RAISE, _ADJUST);
313 update_tri_layer(_LOWER, _RAISE, _ADJUST);
318 if (record->event.pressed) {
320 update_tri_layer(_LOWER, _RAISE, _ADJUST);
323 update_tri_layer(_LOWER, _RAISE, _ADJUST);
328 if (record->event.pressed) {
329 register_code(KC_RSFT);
330 #ifdef BACKLIGHT_ENABLE
334 unregister_code(KC_RSFT);
339 if (record->event.pressed) {
342 PLAY_SONG(tone_plover);
348 if (!eeconfig_is_enabled()) {
351 keymap_config.raw = eeconfig_read_keymap();
352 keymap_config.nkro = 1;
353 eeconfig_update_keymap(keymap_config.raw);
358 if (record->event.pressed) {
360 PLAY_SONG(tone_plover_gb);
373 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
375 if (!eeconfig_is_enabled()) {
379 bool use_cmd = true; // Use, for example, Cmd-Tab, Cmd-C, Cmd-V, etc.
380 // Compare to MAGIC_SWAP_ALT_GUI and MAGIC_UNSWAP_ALT_GUI configs, set in:
382 if(keymap_config.swap_lalt_lgui == 1 && keymap_config.swap_ralt_rgui == 1) {
383 use_cmd = false; // ... or, Alt-Tab, Ctrl-C, Ctrl-V, etc.
388 if(use_cmd) { return (record->event.pressed ? MACRO( D(LALT), D(TAB), END ) : MACRO( U(TAB), END )); }
389 else { return (record->event.pressed ? MACRO( D(LGUI), D(TAB), END ) : MACRO( U(TAB), END )); }
391 if(use_cmd) { return (record->event.pressed ? MACRO( D(LGUI), D(TAB), END ) : MACRO( U(TAB), END )); }
392 else { return (record->event.pressed ? MACRO( D(LALT), D(TAB), END ) : MACRO( U(TAB), END )); }
395 return (record->event.pressed ? MACRO( D(LCTRL), D(TAB), END ) : MACRO( U(TAB), END ));
397 return (record->event.pressed ? MACRO( D(LGUI), D(SLSH),END ) : MACRO( U(SLSH),END ));
400 return use_cmd ? MACRODOWN( D(LGUI), T(F), END ) : MACRODOWN( D(LCTRL), T(F), END );
402 return use_cmd ? MACRODOWN( D(LGUI), T(G), END ) : MACRODOWN( D(LCTRL), T(G), END );
404 return use_cmd ? MACRODOWN( D(LGUI), T(Z), END ) : MACRODOWN( D(LCTRL), T(Z), END );
406 return use_cmd ? MACRODOWN( D(LGUI), T(X), END ) : MACRODOWN( D(LCTRL), T(X), END );
408 return use_cmd ? MACRODOWN( D(LGUI), T(C), END ) : MACRODOWN( D(LCTRL), T(C), END );
410 return use_cmd ? MACRODOWN( D(LGUI), T(V), END ) : MACRODOWN( D(LCTRL), T(V), END );
413 return use_cmd ? MACRODOWN( D(LGUI), D(LCTRL), T(SCLN), END ) : MACRODOWN( D(LALT), D(LCTRL), T(SCLN), END );
415 return use_cmd ? MACRODOWN( D(LGUI), D(LCTRL), T(QUOT), END ) : MACRODOWN( D(LALT), D(LCTRL), T(QUOT), END );
418 return use_cmd ? MACRODOWN( D(LGUI), T(W), END ) : MACRODOWN( D(LCTRL), T(W), END );
420 return use_cmd ? MACRODOWN( D(LGUI), T(T), END ) : MACRODOWN( D(LCTRL), T(T), END );
422 return use_cmd ? MACRODOWN( D(LGUI), D(LSHIFT), T(T), END ) : MACRODOWN( D(LCTRL), D(LSHIFT), T(T), END );
428 void matrix_init_user(void) {
438 _delay_ms(20); // gets rid of tick
439 PLAY_SONG(tone_startup);
444 PLAY_SONG(tone_goodbye);
449 void music_on_user(void)
454 void music_scale_user(void)
456 PLAY_SONG(music_scale);