1 /* Copyright 2017 Kenny Hung
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 #include "keymap_uk.h"
18 // Fillers to make layering more clear
19 #define _______ KC_TRNS
22 #define _CM 0 // Colemak
23 #define _NB 1 // Numbers
24 #define _SYL 2 // Symbols left
25 #define _SYR 3 // Symbols right
26 #define _NAV 4 // Navigation
29 #define _Z_SFT SFT_T(UK_Z)
30 #define _SLSH SFT_T(UK_SLSH)
31 #define _X_NB LT(_NB, UK_X)
32 #define _DOT_NB LT(_NB, UK_DOT)
33 #define _C_SY LT(_SYL, UK_C)
34 #define _COM_SY LT(_SYR, UK_COMM)
35 #define _B_NAV LT(_NAV, UK_B)
36 #define _K_NAV LT(_NAV, UK_K)
37 #define _F1_NB LT(_NB, UK_F1)
38 #define _3_NB LT(_NB, UK_3)
41 #define _TERM LCTL(UK_QUOT) // Hotkey for Cmder or iTerm
42 #define _S_TAB S(UK_TAB)
43 #define _C_LEFT LCTL(UK_LEFT)
44 #define _C_RGHT LCTL(UK_RGHT)
45 #define _A_LEFT LALT(UK_LEFT)
46 #define _A_RGHT LALT(UK_RGHT)
48 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
51 * .--------------------------------------------------------------------------------------------------------------------------------------.
52 * | | | | | | | | | | | | | | | |
53 * |--------------------------------------------------------------------------------------------------------------------------------------|
54 * | | Q | W | F | P | G | | | | J | L | U | Y | ; | |
55 * |--------------------------------------------------------------------------------------------------------------------------------------|
56 * | | A | R | S | T | D | | | | H | N | E | I | O | ENT |
57 * |--------------------------------------------------------------------------------------------------------------------------------------|
58 * | | Z | X | C | V | B | | | | K | M | , | . | / | |
59 * | | SHIFT | NUMBER | SYMBOL | | NAV | | | | NAV | | SYMBOL | FUNC | SHIFT | |
60 * |--------------------------------------------------------------------------------------------------------------------------------------|
61 * | LSHIFT | LCTRL | LALT | LGUI | TERM | SPACE | LCTRL | DEL | LALT | BACKSP | RGUI | RGUI | RALT | RCTRL | RSHIFT |
62 * |--------------------------------------------------------------------------------------------------------------------------------------|
65 { _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ },
66 { _______, UK_Q, UK_W, UK_F, UK_P, UK_G, _______, _______, _______, UK_J, UK_L, UK_U, UK_Y, UK_SCLN, _______ },
67 { _______, UK_A, UK_R, UK_S, UK_T, UK_D, _______, _______, _______, UK_H, UK_N, UK_E, UK_I, UK_O, UK_ENT },
68 { _______, _Z_SFT, _X_NB, _C_SY, UK_V, _B_NAV, _______, _______, _______, _K_NAV, UK_M, _COM_SY, _DOT_NB, _SLSH, _______ },
69 { UK_LSFT, UK_LCTL, UK_LALT, UK_LGUI, _TERM, UK_SPC, UK_LCTL, UK_DEL , UK_LALT, UK_BSPC, UK_RGUI, UK_RGUI, UK_RALT, UK_RCTL, UK_RSFT },
73 * .--------------------------------------------------------------------------------------------------------------------------------------.
74 * | | | | | | | | | | | | | | | |
75 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------|
76 * | | | F7 | F8 | F9 | F10 | | | | | 7 | 8 | 9 | | |
77 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
78 * | | | F4 | F5 | F6 | F11 | | | | | 4 | 5 | 6 | | |
79 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------------------------+--------|
80 * | | | F1 | F2 | F3 | F12 | | | | | 1 | 2 | 3 | | |
81 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------+--------+--------|
82 * | | | | | | | | | | | 0 | 0 | . | | |
83 * '--------------------------------------------------------------------------------------------------------------------------------------'
86 { _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ },
87 { _______, _______, UK_F7, UK_F8, UK_F9, UK_F10, _______, _______, _______, _______, UK_7, UK_8, UK_9, _______, _______ },
88 { _______, _______, UK_F4, UK_F5, UK_F6, UK_F11, _______, _______, _______, _______, UK_4, UK_5, UK_6, _______, _______ },
89 { _______, _______, _F1_NB, UK_F2, UK_F3, UK_F12, _______, _______, _______, _______, UK_1, UK_2, _3_NB, _______, _______ },
90 { _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, UK_0, UK_0, UK_DOT, _______, _______ },
93 /* Symbols _SYL and _SYR - For some reason, combining this into the same layer causes problems.
94 * .--------------------------------------------------------------------------------------------------------------------------------------.
95 * | | | | | | | | | | | | | | | |
96 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
97 * | | ! | £ | _ | - | ~ | | | | \ | { | } | / | # | |
98 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
99 * | | $ | % | + | = | | | | | " | ( | ) | ' | @ | |
100 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
101 * | | ^ | & | * | | | | | | | < | [ | ] | > | ` | |
102 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
103 * | | | | | | | | | | | | | | | |
104 * '--------------------------------------------------------------------------------------------------------------------------------------'
107 { _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ },
108 { _______, UK_EXLM, UK_PND, UK_UNDS, UK_MINS, UK_TILD, _______, _______, _______, UK_BSLS, UK_LCBR, UK_RCBR, UK_SLSH, UK_HASH, _______ },
109 { _______, UK_DLR, UK_PERC, UK_PLUS, UK_EQL, _______, _______, _______, _______, UK_DQUO, UK_LPRN, UK_RPRN, UK_QUOT, UK_AT, _______ },
110 { _______, UK_CIRC, UK_AMPR, _C_SY, UK_PIPE, _______, _______, _______, _______, UK_LABK, UK_LBRC, UK_RBRC, UK_RABK, UK_GRV, _______ },
111 { _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ },
114 { _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ },
115 { _______, UK_EXLM, UK_PND, UK_UNDS, UK_MINS, UK_TILD, _______, _______, _______, UK_BSLS, UK_LCBR, UK_RCBR, UK_SLSH, UK_HASH, _______ },
116 { _______, UK_DLR, UK_PERC, UK_PLUS, UK_EQL, _______, _______, _______, _______, UK_DQUO, UK_LPRN, UK_RPRN, UK_QUOT, UK_AT, _______ },
117 { _______, UK_CIRC, UK_AMPR, UK_ASTR, UK_PIPE, _______, _______, _______, _______, UK_LABK, UK_LBRC, _COM_SY, UK_RABK, UK_GRV, _______ },
118 { _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ },
122 * .--------------------------------------------------------------------------------------------------------------------------------------.
123 * | | | | | | | | | | | | | | | |
124 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
125 * | | Esc | Ctrl L | Up | Ctrl R | | | | | | PtSn | ScLk | Pause | | |
126 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
127 * | | Tab | Left | Down | Right | | | | | | Insert | Home | PgUp | | |
128 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
129 * | | ShTab | Alt L | Shift | Alt R | | | | | | ScLk | End | PgDn | | |
130 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
131 * | | | | | | | | | | | | | | | RESET |
132 * '--------------------------------------------------------------------------------------------------------------------------------------'
135 { _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ },
136 { _______, UK_ESC, _C_LEFT, UK_UP , _C_RGHT, _______, _______, _______, _______, _______, UK_PSCR, UK_SLCK, UK_PAUS, _______, _______ },
137 { _______, UK_TAB, UK_LEFT, UK_DOWN, UK_RGHT, _______, _______, _______, _______, _______, UK_INS, UK_HOME, UK_PGUP, _______, _______ },
138 { _______, _S_TAB, _A_LEFT, UK_LSFT, _A_RGHT, _B_NAV, _______, _______, _______, _K_NAV, UK_SLCK, UK_END, UK_PGDN, _______, _______ },
139 { _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RESET },
143 const uint16_t PROGMEM fn_actions[] = {
147 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
149 // MACRODOWN only works in this function
152 if (record->event.pressed) {
153 register_code(KC_RSFT);
154 #ifdef BACKLIGHT_ENABLE
158 unregister_code(KC_RSFT);
165 bool CTRLDOWN = false;
166 bool ALTDOWN = false;
167 bool WINDOWN = false;
168 bool SHIFTDOWN = false;
169 bool TERMINALOPEN = false;
171 void matrix_scan_user(void) {
173 rgblight_effect_rainbow_swirl(128);
174 } else if (SHIFTDOWN) {
175 rgblight_effect_breathing(3);
176 } else if (CTRLDOWN) {
177 rgblight_effect_knight(3);
178 } else if (WINDOWN) {
179 rgblight_effect_snake(3);
181 rgblight_setrgb(0, 0, 0);
185 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
189 WINDOWN = record->event.pressed;
190 TERMINALOPEN = false;
194 CTRLDOWN = record->event.pressed;
198 SHIFTDOWN = record->event.pressed;
202 ALTDOWN = record-> event.pressed;
205 if (record->event.pressed) {
206 TERMINALOPEN = !TERMINALOPEN;