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.
4 #pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
6 #include "action_layer.h"
11 #include "keymap_colemak.h"
13 extern keymap_config_t keymap_config;
15 // Each layer gets a name for readability, which is then used in the keymap matrix below.
16 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
17 // Layer names don't all need to be of the same length, obviously, and you can also skip them
18 // entirely and just use numbers.
32 enum planck_keycodes {
43 SDTOGG, // Toggle SuperDuper
47 M_GUI_UNDS, // Simulate GUI_T(KC_UNDS)
48 M_SFT_PO, // SFT_T(KC_LPRN)
51 // Timer for custom mod tap
52 static uint16_t m_gui_unds_timer;
53 static uint16_t m_sft_po_timer;
55 // Fillers to make layering more clear
56 #define _______ KC_TRNS
59 // Narze : Custom Macros
60 #define HPR_ESC ALL_T(KC_ESC)
61 #define SFT_ENT SFT_T(KC_ENT)
62 #define SFT_PO F(M_SFT_PO)
63 #define GUI_MINS GUI_T(KC_MINS)
64 #define GUI_UNDS F(M_GUI_UNDS)
66 // Combo : SuperDuper layer from S+D (R+S in Colemak)
67 #define SUPERDUPER_COMBO_COUNT 3
68 #define EECONFIG_SUPERDUPER_INDEX (uint8_t *) 19
70 enum process_combo_event {
74 const uint16_t PROGMEM superduper_combos[SUPERDUPER_COMBO_COUNT][3] = {
75 [_QWERTY] = {KC_S, KC_D, COMBO_END},
76 [_COLEMAK] = {KC_R, KC_S, COMBO_END},
77 [_QWOC] = {CM_S, CM_D, COMBO_END},
80 combo_t key_combos[COMBO_COUNT] = {
81 [CB_SUPERDUPER] = COMBO_ACTION(superduper_combos[_QWERTY]),
84 volatile bool superduper_enabled = true;
86 const uint16_t empty_combo[] = {COMBO_END};
88 void set_superduper_key_combos(void);
89 void clear_superduper_key_combos(void);
91 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
94 * ,-----------------------------------------------------------------------------------.
95 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
96 * |------+------+------+------+------+-------------+------+------+------+------+------|
97 * | Hp/Ec| A | S | D | F | G | H | J | K | L | ; | ' |
98 * |------+------+------+------+------+------|------+------+------+------+------+------|
99 * | Sft/(| Z/Mo | X | C | V | B | N | M | , | . | SD-/ |Sft/Ent|
100 * |------+------+------+------+------+------+------+------+------+------+------+------|
101 * | Rse/[| Ctrl | Alt | GUI/_|Lower | Space |Raise | GUI/-| Alt | Ctrl | Low/]|
102 * `-----------------------------------------------------------------------------------'
105 {KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC},
106 {HPR_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
107 {SFT_PO, LT(_MOUSE, KC_Z), KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, LT(_SUPERDUPER, KC_SLSH), SFT_ENT},
108 {LT(_RAISE, KC_LBRC), KC_LCTL, KC_LALT, GUI_UNDS, LOWER, KC_SPC, KC_SPC, RAISE, GUI_MINS, KC_RALT, KC_RCTL, LT(_LOWER, KC_RBRC)}
112 * ,-----------------------------------------------------------------------------------.
113 * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
114 * |------+------+------+------+------+-------------+------+------+------+------+------|
115 * | Hp/Ec| A | R | S | T | D | H | N | E | I | O | ' |
116 * |------+------+------+------+------+------|------+------+------+------+------+------|
117 * | Sft/(| Z/Mo | X | C | V | B | K | M | , | . | SD-/ |Sft/Ent|
118 * |------+------+------+------+------+------+------+------+------+------+------+------|
119 * | Brite| Ctrl | Alt | GUI/_|Lower | Space |Raise | GUI/-| Alt | Ctrl | Low/]|
120 * `-----------------------------------------------------------------------------------'
123 {KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC},
124 {HPR_ESC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT},
125 {SFT_PO, LT(_MOUSE, KC_Z), KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, LT(_SUPERDUPER, KC_SLSH), SFT_ENT},
126 {LT(_RAISE, KC_LBRC), KC_LCTL, KC_LALT, GUI_UNDS, LOWER, KC_SPC, KC_SPC, RAISE, GUI_MINS, KC_RALT, KC_RCTL, LT(_LOWER, KC_RBRC)}
129 /* Qwerty on software Colemak : Useful for gaming with qwerty keymaps! */
131 {KC_TAB, CM_Q, CM_W, CM_E, CM_R, CM_T, CM_Y, CM_U, CM_I, CM_O, CM_P, KC_BSPC},
132 {HPR_ESC, CM_A, CM_S, CM_D, CM_F, CM_G, CM_H, CM_J, CM_K, CM_L, CM_SCLN, KC_QUOT},
133 {SFT_PO, LT(_MOUSE, CM_Z), CM_X, CM_C, CM_V, CM_B, CM_N, CM_M, CM_COMM, CM_DOT, LT(_SUPERDUPER, CM_SLSH), SFT_ENT},
134 {LT(_RAISE, KC_LBRC), KC_LCTL, KC_LALT, GUI_UNDS, LOWER, KC_SPC, KC_SPC, RAISE, GUI_MINS, KC_RALT, KC_RCTL, LT(_LOWER, KC_RBRC)}
138 * ,-----------------------------------------------------------------------------------.
139 * | ` | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
140 * |------+------+------+------+------+-------------+------+------+------+------+------|
141 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
142 * |------+------+------+------+------+------|------+------+------+------+------+------|
143 * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | | |Sft/Ent|
144 * |------+------+------+------+------+------+------+------+------+------+------+------|
145 * | | | | | | | | Next | Vol- | Vol+ | Play |
146 * `-----------------------------------------------------------------------------------'
149 {KC_GRV, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
150 {KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
151 {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,S(KC_NUHS),S(KC_NUBS),_______, _______, _______},
152 {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
156 * ,-----------------------------------------------------------------------------------.
157 * | ~ | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
158 * |------+------+------+------+------+-------------+------+------+------+------+------|
159 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ |
160 * |------+------+------+------+------+------|------+------+------+------+------+------|
161 * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO # |ISO / | | |Sft/Ent|
162 * |------+------+------+------+------+------+------+------+------+------+------+------|
163 * | | | | | | | | Next | Vol- | Vol+ | Play |
164 * `-----------------------------------------------------------------------------------'
167 {KC_TILD, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
168 {KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS},
169 {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUBS, _______, _______, _______},
170 {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
173 /* Plover layer (http://opensteno.org)
174 * ,-----------------------------------------------------------------------------------.
175 * | # | # | # | # | # | # | # | # | # | # | # | # |
176 * |------+------+------+------+------+-------------+------+------+------+------+------|
177 * | | S | T | P | H | * | * | F | P | L | T | D |
178 * |------+------+------+------+------+------|------+------+------+------+------+------|
179 * |TogOut| S | K | W | R | * | * | R | B | G | S | Z |
180 * |------+------+------+------+------+------+------+------+------+------+------+------|
181 * | Exit | | | A | O | | E | U | | | |
182 * `-----------------------------------------------------------------------------------'
186 {KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 },
187 {XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC},
188 {XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
189 {EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX}
192 /* SuperDuper : https://gist.github.com/narze/861e2167784842d38771
193 * /-----------------------------------------------------------------------------------\
194 * | | | | | | | | | T← | T→ | | |
195 * |------+------+------+------+------+-------------+------+------+------+------+------|
196 * | | Alt | [SuperDuper]| Bksp | Gui | ← | ↓ | ↑ | → | Del | |
197 * |------+------+------+------+------+------|------+------+------+------+------+------|
198 * | | | | | | | | | | | | |
199 * |------+------+------+------+------+-------------+------+------+------+------+------|
200 * | | | | | | Shift | | | | | |
201 * \-----------------------------------------------------------------------------------/
204 {_______, _______, _______, _______, _______, _______, _______, _______, S(LGUI(KC_LBRC)), S(LGUI(KC_RBRC)), _______, _______},
205 {_______, KC_LALT, _______, _______, KC_BSPC, KC_LGUI, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_DEL, _______},
206 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
207 {_______, _______, _______, _______, _______, KC_LSFT, KC_LSFT, _______, _______, _______, _______, _______}
211 * /-----------------------------------------------------------------------------------\
212 * | | | S↑ | M↑ | S↓ | | | | S↑ | S↓ | | |
213 * |------+------+------+------+------+-------------+------+------+------+------+------|
214 * | | | M← | M↓ | M→ | | M← | M↓ | M↑ | M→ | | |
215 * |------+------+------+------+------+------|------+------+------+------+------+------|
216 * | |[Mouse| | | | M3 | M3 | | | | | |
217 * |------+------+------+------+------+-------------+------+------+------+------+------|
218 * | | | | | M2 | LeftClick | M2 | | | | |
219 * \-----------------------------------------------------------------------------------/
222 {_______, _______, KC_WH_U, KC_MS_U, KC_WH_D, _______, _______, _______, KC_WH_U, KC_WH_D, _______, _______},
223 {_______, _______, KC_MS_L, KC_MS_D, KC_MS_R, _______, KC_MS_L, KC_MS_D, KC_MS_U, KC_MS_R, _______, _______},
224 {_______, _______, _______, _______, _______, KC_BTN3, KC_BTN3, _______, _______, _______, _______, _______},
225 {_______, _______, _______, _______, KC_BTN2, KC_BTN1, KC_BTN1, KC_BTN2, _______, _______, _______, _______}
228 /* Adjust (Lower + Raise)
229 * ,-----------------------------------------------------------------------------------.
230 * | | Reset| | | | | | | | | | Del |
231 * |------+------+------+------+------+-------------+------+------+------+------+------|
232 * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|QwOnCo|Plover| |
233 * |------+------+------+------+------+------|------+------+------+------+------+------|
234 * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|SDtogg| | | | |
235 * |------+------+------+------+------+------+------+------+------+------+------+------|
236 * | | | | | | | | | | | |
237 * `-----------------------------------------------------------------------------------'
240 {_______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
241 {_______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, QWOC, PLOVER, _______},
242 {_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, SDTOGG, _______, _______, _______, _______},
243 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
249 float tone_startup[][2] = SONG(STARTUP_SOUND);
250 float tone_qwerty[][2] = SONG(QWERTY_SOUND);
251 float tone_qwoc[][2] = SONG(DVORAK_SOUND);
252 float tone_colemak[][2] = SONG(COLEMAK_SOUND);
253 float tone_plover[][2] = SONG(PLOVER_SOUND);
254 float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND);
255 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
256 float tone_coin[][2] = SONG(COIN_SOUND);
257 float tone_sonic_ring[][2] = SONG(SONIC_RING);
259 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
260 float tone_superduper[][2] = SONG(SUPER_DUPER_SOUND);
263 void persistant_default_layer_set(uint16_t default_layer) {
264 eeconfig_update_default_layer(default_layer);
265 default_layer_set(default_layer);
268 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
271 if (record->event.pressed) {
273 PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
275 persistant_default_layer_set(1UL<<_QWERTY);
277 key_combos[CB_SUPERDUPER].keys = superduper_combos[_QWERTY];
278 eeprom_update_byte(EECONFIG_SUPERDUPER_INDEX, _QWERTY);
283 if (record->event.pressed) {
285 PLAY_NOTE_ARRAY(tone_colemak, false, 0);
287 persistant_default_layer_set(1UL<<_COLEMAK);
289 key_combos[CB_SUPERDUPER].keys = superduper_combos[_COLEMAK];
290 eeprom_update_byte(EECONFIG_SUPERDUPER_INDEX, _COLEMAK);
295 if (record->event.pressed) {
297 PLAY_NOTE_ARRAY(tone_qwoc, false, 0);
299 persistant_default_layer_set(1UL<<_QWOC);
301 key_combos[CB_SUPERDUPER].keys = superduper_combos[_QWOC];
302 eeprom_update_byte(EECONFIG_SUPERDUPER_INDEX, _QWOC);
307 if (record->event.pressed) {
309 update_tri_layer(_LOWER, _RAISE, _ADJUST);
312 update_tri_layer(_LOWER, _RAISE, _ADJUST);
317 if (record->event.pressed) {
319 update_tri_layer(_LOWER, _RAISE, _ADJUST);
322 update_tri_layer(_LOWER, _RAISE, _ADJUST);
327 if (record->event.pressed) {
328 register_code(KC_RSFT);
329 #ifdef BACKLIGHT_ENABLE
333 unregister_code(KC_RSFT);
338 if (record->event.pressed) {
341 PLAY_NOTE_ARRAY(tone_plover, false, 0);
347 if (!eeconfig_is_enabled()) {
350 keymap_config.raw = eeconfig_read_keymap();
351 keymap_config.nkro = 1;
352 eeconfig_update_keymap(keymap_config.raw);
357 if (record->event.pressed) {
359 PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
366 if (record->event.pressed) {
367 superduper_enabled = !superduper_enabled;
369 if (superduper_enabled) {
370 set_superduper_key_combos();
373 PLAY_NOTE_ARRAY(tone_sonic_ring, false, 0);
376 clear_superduper_key_combos();
379 PLAY_NOTE_ARRAY(tone_coin, false, 0);
389 void matrix_init_user(void) {
395 void matrix_setup(void) {
396 set_superduper_key_combos();
399 void set_superduper_key_combos(void) {
400 uint8_t layer = eeprom_read_byte(EECONFIG_SUPERDUPER_INDEX);
406 key_combos[CB_SUPERDUPER].keys = superduper_combos[layer];
411 void clear_superduper_key_combos(void) {
412 key_combos[CB_SUPERDUPER].keys = empty_combo;
415 void matrix_scan_user(void) {
422 _delay_ms(20); // gets rid of tick
423 PLAY_NOTE_ARRAY(tone_startup, false, 0);
428 PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
433 void music_on_user(void)
438 void music_scale_user(void)
440 PLAY_NOTE_ARRAY(music_scale, false, 0);
447 void process_combo_event(uint8_t combo_index, bool pressed) {
449 switch(combo_index) {
451 layer_on(_SUPERDUPER);
454 PLAY_NOTE_ARRAY(tone_superduper, false, 0);
459 layer_off(_SUPERDUPER);
460 unregister_mods(MOD_BIT(KC_LGUI) | MOD_BIT(KC_LCTL) | MOD_BIT(KC_LALT)); // Sometimes mods are held, unregister them
466 const uint16_t PROGMEM fn_actions[] = {
467 [M_GUI_UNDS] = ACTION_MACRO_TAP(M_GUI_UNDS),
468 [M_SFT_PO] = ACTION_MACRO_TAP(M_SFT_PO),
471 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
473 bool tap_not_interrupted = record->tap.count > 0 && !record->tap.interrupted;
476 // Hold for LGUI, tap for Underscore
478 if (record->event.pressed) {
479 m_gui_unds_timer = timer_read();
481 if (!tap_not_interrupted) {
482 register_mods(MOD_BIT(KC_LGUI));
485 if (tap_not_interrupted && timer_elapsed(m_gui_unds_timer) < TAPPING_TERM) {
487 PLAY_NOTE_ARRAY(tone_superduper, false, 0);
490 add_weak_mods(MOD_BIT(KC_LSFT));
491 send_keyboard_report();
492 register_code(KC_MINS);
493 unregister_code(KC_MINS);
494 del_weak_mods(MOD_BIT(KC_LSFT));
495 send_keyboard_report();
496 record->tap.count = 0; // ad hoc: cancel tap
498 unregister_mods(MOD_BIT(KC_LGUI));
502 // Hold for LSHIFT, tap for Parens open
504 if (record->event.pressed) {
505 m_sft_po_timer = timer_read();
507 if (!tap_not_interrupted) {
508 register_mods(MOD_BIT(KC_LSFT));
511 if (tap_not_interrupted && timer_elapsed(m_sft_po_timer) < TAPPING_TERM) {
513 PLAY_NOTE_ARRAY(tone_superduper, false, 0);
516 record->tap.count = 0;
517 return MACRO(D(RSFT), T(9), U(RSFT), END);
519 unregister_mods(MOD_BIT(KC_LSFT));