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"
8 #include "musical_notes.h"
11 #include "process_unicode.h"
14 // #define TOLELOT_ENABLE
16 extern keymap_config_t keymap_config;
31 enum planck_keycodes {
51 // Fillers to make layering clearer
53 #define _______ KC_TRNS
59 GRIN, // grinning face 😊
60 TJOY, // tears of joy 😂
61 SMILE, // grining face with smiling eyes 😁
63 EYERT, // smiling face with heart shaped eyes 😍
65 SMEYE, // smiling face with smiling eyes 😊
68 HART2, // two hearts 💕
70 OKHND, // ok hand sign 👌
76 THMDN, // thumb down 👎
79 MUSIC, // musical notes
81 CELEB, // celebration 🙌
82 CRY2, // crying face 😢
83 COOL, // smile with sunglasses 😎
85 NOEVH, // hear no evil
86 NOEVK, // speak no evil
90 BHART, // broken heart
91 SLEEP, // sleeping face
92 SMIL2, // smiling face with open mouth & sweat
95 TONGU, // face with tongue & winking eye
96 DISAP, // disappointed
97 YUMMY, // face savoring delicious food
98 CLAP, // hand clapping
99 FEAR, // face screaming in fear
100 HORNS, // smiling face with horns
101 HALO, // smiling face with halo
161 const uint32_t PROGMEM unicode_map[] = {
265 // #define KC_LSFT MT(MOD_LSFT, KC_MINS)
267 // #define KC_RSFT MT(MOD_LSFT, KC_EQL)
270 // hybrid right-gui & scroll lock (mapped to Compose in OS)
272 #define KC_RALT MT(MOD_RALT, KC_SLCK)
276 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
279 * ,-----------------------------------------------------------------------------------.
280 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
281 * |------+------+------+------+------+-------------+------+------+------+------+------|
282 * | Esc | A | S | D | F | G | H | J | K | L | ; |Enter |
283 * |------+------+------+------+------+------|------+------+------+------+------+------|
284 * | Shift| Z | X | C | V | B | N | M | , | . | / |Shift |
285 * |------+------+------+------+------+------+------+------+------+------+------+------|
286 * | Ctrl | GUI | Alt | Punc | Num | Space | Func |Emoji |Greek |AltGr | Ctrl |
287 * `-----------------------------------------------------------------------------------'
290 {KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC},
291 {KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_QUOT, KC_ENT },
292 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT},
293 {KC_LCTL, KC_LALT, KC_LGUI, PUNC, NUM, KC_SPC, KC_SPC, FUNC, EMOJI, GREEK, KC_RALT, KC_RCTL}
297 * ,-----------------------------------------------------------------------------------.
298 * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
299 * |------+------+------+------+------+-------------+------+------+------+------+------|
300 * | Esc | A | R | S | T | D | H | N | E | I | O |Enter |
301 * |------+------+------+------+------+------|------+------+------+------+------+------|
302 * | Shift| Z | X | C | V | B | K | M | , | . | / |Shift |
303 * |------+------+------+------+------+------+------+------+------+------+------+------|
304 * | Ctrl | GUI | Alt | Punc | Num | Space | Func |Emoji |AltGr | GUI | Ctrl |
305 * `-----------------------------------------------------------------------------------'
308 {_______, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_QUOT, _______},
309 {_______, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, _______},
310 {_______, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, _______},
311 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
315 * ,-----------------------------------------------------------------------------------.
316 * | Tab | Q | D | R | W | B | J | F | U | P | ; | Bksp |
317 * |------+------+------+------+------+-------------+------+------+------+------+------|
318 * | Esc | A | S | H | T | G | Y | N | E | O | I |Enter |
319 * |------+------+------+------+------+------|------+------+------+------+------+------|
320 * | Shift| Z | X | M | C | V | K | K | , | . | / |Shift |
321 * |------+------+------+------+------+------+------+------+------+------+------+------|
322 * | Ctrl | GUI | Alt | Punc | Num | Space | Func |Emoji |AltGr | GUI | Ctrl |
323 * `-----------------------------------------------------------------------------------'
326 {_______, KC_Q, KC_D, KC_R, KC_W, KC_B, KC_J, KC_F, KC_U, KC_P, KC_QUOT, _______},
327 {_______, KC_A, KC_S, KC_H, KC_T, KC_G, KC_Y, KC_N, KC_E, KC_O, KC_I, _______},
328 {_______, KC_Z, KC_X, KC_M, KC_C, KC_V, KC_K, KC_L, KC_COMM, KC_DOT, KC_SLSH, _______},
329 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
333 * ,-----------------------------------------------------------------------------------.
334 * | | | | | | | | | | | | |
335 * |------+------+------+------+------+-------------+------+------+------+------+------|
336 * | | | | | | | | | | | | |
337 * |------+------+------+------+------+------+------+------+------+------+------+------|
338 * | | | | | | | | | | | | |
339 * |------+------+------+------+------+------+------+------+------+------+------+------|
340 * | | | | | | | | | | | | |
341 * `-----------------------------------------------------------------------------------'
344 {_______, _______, _______,X(UEPSI), X(URHO), X(UTAU),X(UUPSI),X(UTHET),X(UIOTA),X(UOMIC), X(UPI), _______},
345 {_______,X(UALPH),X(USIGM),X(UDELT), X(UPHI),X(UGAMM), X(UETA), X(UXI),X(UKAPP),X(ULAMB), _______, _______},
346 {_______,X(UZETA), X(UCHI), X(UPSI),X(UOMEG),X(UBETA), X(UNU), X(UMU), _______, _______, _______, _______},
347 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
351 * ,-----------------------------------------------------------------------------------.
352 * | | | | | | | | | | | | |
353 * |------+------+------+------+------+-------------+------+------+------+------+------|
354 * | | | | | | | | | | | | |
355 * |------+------+------+------+------+------+------+------+------+------+------+------|
356 * | | | | | | | | | | | | |
357 * |------+------+------+------+------+------+------+------+------+------+------+------|
358 * | | | | | | | | | | | | |
359 * `-----------------------------------------------------------------------------------'
362 {_______, _______,X(FSIGM),X(LEPSI), X(LRHO), X(LTAU),X(LUPSI),X(LTHET),X(LIOTA),X(LOMIC), X(LPI), _______},
363 {_______,X(LALPH),X(LSIGM),X(LDELT), X(LPHI),X(LGAMM), X(LETA), X(LXI),X(LKAPP),X(LLAMB), _______, _______},
364 {_______,X(LZETA), X(LCHI), X(LPSI),X(LOMEG),X(LBETA), X(LNU), X(LMU), _______, _______, _______, _______},
365 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
369 * ,-----------------------------------------------------------------------------------.
370 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | ` |
371 * |------+------+------+------+------+-------------+------+------+------+------+------|
372 * | | | \ | - | = | < | > | ( | ) | ' | | |
373 * |------+------+------+------+------+------|------+------+------+------+------+------|
374 * | | | | | _ | + | { | } | [ | ] | " | | |
375 * |------+------+------+------+------+------+------+------+------+------+------+------|
376 * | | | | | | | | | | | |
377 * `-----------------------------------------------------------------------------------'
380 {KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_GRV },
381 {XXXXXXX, XXXXXXX, KC_BSLS, KC_MINS, KC_EQL, KC_LABK, KC_RABK, KC_LPRN, KC_RPRN, KC_QUOT, XXXXXXX, XXXXXXX},
382 {XXXXXXX, XXXXXXX, KC_PIPE, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_LBRC, KC_RBRC, KC_DQUO, XXXXXXX, XXXXXXX},
383 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
387 * ,-----------------------------------------------------------------------------------.
388 * | ^ | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
389 * |------+------+------+------+------+-------------+------+------+------+------+------|
390 * | Esc | @ | A | B | C | ( | ) | 4 | 5 | 6 | : |Enter |
391 * |------+------+------+------+------+------|------+------+------+------+------+------|
392 * | & | # | D | E | F | [ | ] | 1 | 2 | 3 | / | * |
393 * |------+------+------+------+------+------+------+------+------+------+------+------|
394 * | | | | x | | | 0 | , | . | + | - |
395 * `-----------------------------------------------------------------------------------'
398 {KC_CIRC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
399 { KC_ESC, KC_AT, S(KC_A), S(KC_B), S(KC_C), KC_LPRN, KC_RPRN, KC_4, KC_5, KC_6, KC_COLN, KC_ENT},
400 {KC_AMPR, KC_HASH, S(KC_D), S(KC_E), S(KC_F), KC_LBRC, KC_RBRC, KC_1, KC_2, KC_3, KC_SLSH, KC_ASTR},
401 {_______, _______, _______, KC_X, _______, KC_SPC, KC_SPC, KC_0, KC_COMM, KC_DOT, KC_PLUS, KC_MINS}
405 * ,-----------------------------------------------------------------------------------.
406 * | | F1 | F2 | F3 | F4 | | | PgUp | Up | PgDn | PgUp | Del |
407 * |------+------+------+------+------+-------------+------+------+------+------+------|
408 * | | F5 | F6 | F7 | F8 |PrtSc | | Left | Down | Right| PgDn | Ins |
409 * |------+------+------+------+------+------|------+------+------+------+------+------|
410 * | | F9 | F10 | F11 | F12 | | | | Home | End | | |
411 * |------+------+------+------+------+------+------+------+------+------+------+------|
412 * | | | | | | | | | | | |
413 * `-----------------------------------------------------------------------------------'
416 {XXXXXXX, KC_F1, KC_F2, KC_F3, KC_F4, XXXXXXX, XXXXXXX, KC_PGUP, KC_UP, KC_PGDN, KC_PGUP, KC_DEL},
417 {XXXXXXX, KC_F5, KC_F6, KC_F7, KC_F8,KC_PSCREEN,XXXXXXX, KC_LEFT, KC_DOWN, KC_RGHT, KC_PGDN, KC_INS},
418 {_______, KC_F9, KC_F10, KC_F11, KC_F12, XXXXXXX, XXXXXXX, XXXXXXX, KC_HOME, KC_END, XXXXXXX, _______},
419 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
423 * ,-----------------------------------------------------------------------------------.
424 * | | | | | | | | | | | | |
425 * |------+------+------+------+------+-------------+------+------+------+------+------|
426 * | | | | | | | | | | | | |
427 * |------+------+------+------+------+------+------+------+------+------+------+------|
428 * | | | | | | | | | | | | |
429 * |------+------+------+------+------+------+------+------+------+------+------+------|
430 * | | | | | | | | | | | | |
431 * `-----------------------------------------------------------------------------------'
434 {X(HART2), X(CRY2),X(WEARY),X(EYERT),X(SMIRK), X(TJOY),X(RECYC),X(UNAMU),X(MUSIC),X(OKHND),X(PENSV), X(PHEW)},
435 {X(THMUP), X(PRAY),X(SMILE),X(SMIL2),X(FLUSH), X(GRIN),X(HEART), X(BYE), X(KISS),X(CELEB), X(COOL),X(NOEVS)},
436 {X(THMDN),X(SLEEP), X(CLAP), X(CRY), X(VIC),X(BHART), X(SUN),X(SMEYE), X(WINK), X(MOON),X(CONFU),X(NOEVH)},
437 { X(POO), X(EYES),X(HUNRD), _______,X(SKULL),X(HORNS), X(HALO), X(FEAR), _______,X(YUMMY),X(DISAP),X(NOEVK)}
441 * ,-----------------------------------------------------------------------------------.
442 * | | D1 | D2 | D3 | D4 | D5 | D6 | D7 | D8 | D9 | D10 | |
443 * |------+------+------+------+------+-------------+------+------+------+------+------|
444 * |Linux | | Vol- | Mute | Vol+ | | | D- | | D+ | |Qwerty|
445 * |------+------+------+------+------+------+------+------+------+------+------+------|
446 * | Win | | Prev | Play | Next | | | | | | |Colmak|
447 * |------+------+------+------+------+------+------+------+------+------+------+------|
448 * | OSX | | | | | BL- | BL+ | | | | |Workmn|
449 * `-----------------------------------------------------------------------------------'
452 {_______, LGUI(KC_1),LGUI(KC_2),LGUI(KC_3),LGUI(KC_4),LGUI(KC_5),LGUI(KC_6),LGUI(KC_7),LGUI(KC_8),LGUI(KC_9),LGUI(KC_0), _______},
453 { LINUX, _______, KC_VOLD, KC_MUTE, KC_VOLU,_______,_______,KC_WWW_BACK,_______,KC_WWW_FORWARD,_______, QWERTY},
454 { WIN, _______, KC_MPRV, KC_MPLY, KC_MNXT, _______, _______, _______, _______, _______, _______, COLEMAK},
455 { OSX, _______, _______, _______, _______, BL_DEC, BL_INC, _______, _______, _______, _______, WORKMAN}
461 float tone_startup[][2] = SONG(STARTUP_SOUND);
462 float tone_qwerty[][2] = SONG(QWERTY_SOUND);
463 float tone_colemak[][2] = SONG(COLEMAK_SOUND);
464 float tone_workman[][2] = SONG(DVORAK_SOUND);
465 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
466 float tone_linux[][2] = SONG(CAPS_LOCK_ON_SOUND);
467 float tone_windows[][2] = SONG(SCROLL_LOCK_ON_SOUND);
468 float tone_osx[][2] = SONG(NUM_LOCK_ON_SOUND);
469 float tone_click[][2] = SONG(MUSICAL_NOTE(_F3, 2));
470 float tone_release[][2] = SONG(MUSICAL_NOTE(_A3, 2));
471 float tone_tolelot[][2] = SONG(Q__NOTE(_E5), Q__NOTE(_C5), Q__NOTE(_D5));
474 void persistant_default_layer_set(uint16_t default_layer) {
475 eeconfig_update_default_layer(default_layer);
476 default_layer_set(default_layer);
479 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
481 // if (record->event.pressed) PLAY_NOTE_ARRAY(tone_click, false, 0);
483 #ifdef TOLELOT_ENABLE
484 if (record->event.pressed) {
485 PLAY_NOTE_ARRAY(tone_tolelot, false, 0);
488 if (record->event.pressed) {
489 PLAY_NOTE_ARRAY(tone_click, false, 0);
491 PLAY_NOTE_ARRAY(tone_release, false, 0);
496 bool lshifted = keyboard_report->mods & MOD_BIT(KC_LSFT);
497 bool rshifted = keyboard_report->mods & MOD_BIT(KC_RSFT);
500 // Greek layer handling
502 if (record->event.pressed) {
503 if (lshifted || rshifted) {
520 uint8_t layer = biton32(layer_state);
521 if (layer == _GREEKU || layer == _GREEKL) {
522 if (record->event.pressed) {
526 if (lshifted ^ rshifted) { // if only one shift is pressed
535 // QWERTZ style comma and dot: semicolon and colon when shifted
537 if (record->event.pressed) {
538 if (lshifted || rshifted) {
539 if (lshifted) unregister_code(KC_LSFT);
540 if (rshifted) unregister_code(KC_RSFT);
541 register_code(KC_SCLN);
542 unregister_code(KC_SCLN);
543 if (lshifted) register_code(KC_LSFT);
544 if (rshifted) register_code(KC_RSFT);
546 register_code(KC_COMM);
547 unregister_code(KC_COMM);
553 if (record->event.pressed) {
554 if ((keyboard_report->mods & MOD_BIT(KC_LSFT)) || (keyboard_report->mods & MOD_BIT(KC_RSFT))) {
555 register_code(KC_SCLN);
556 unregister_code(KC_SCLN);
558 register_code(KC_DOT);
559 unregister_code(KC_DOT);
567 if (record->event.pressed) {
569 PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
571 persistant_default_layer_set(1UL<<_QWERTY);
576 if (record->event.pressed) {
578 PLAY_NOTE_ARRAY(tone_colemak, false, 0);
580 persistant_default_layer_set(1UL<<_COLEMAK);
585 if (record->event.pressed) {
587 PLAY_NOTE_ARRAY(tone_workman, false, 0);
589 persistant_default_layer_set(1UL<<_WORKMAN);
596 if (record->event.pressed) {
598 update_tri_layer(_PUNC, _EMOJI, _GUI);
601 update_tri_layer(_PUNC, _EMOJI, _GUI);
606 if (record->event.pressed) {
608 update_tri_layer(_PUNC, _EMOJI, _GUI);
611 update_tri_layer(_PUNC, _EMOJI, _GUI);
616 if (record->event.pressed) {
624 if (record->event.pressed) {
634 set_unicode_input_mode(UC_LNX);
636 PLAY_NOTE_ARRAY(tone_linux, false, 0);
641 set_unicode_input_mode(UC_WINC);
643 PLAY_NOTE_ARRAY(tone_windows, false, 0);
648 set_unicode_input_mode(UC_OSX);
650 PLAY_NOTE_ARRAY(tone_osx, false, 0);
658 void matrix_init_user(void) {
662 set_unicode_input_mode(UC_LNX);
669 _delay_ms(20); // gets rid of tick
670 PLAY_NOTE_ARRAY(tone_startup, false, 0);
675 PLAY_NOTE_ARRAY(tone_goodbye, false, 0);