3 extern keymap_config_t keymap_config;
6 * Each layer gets a name for readability, which is then used in the keymap matrix below.
7 * The underscores don't mean anything - you can have a layer called STUFF or any other name.
8 * Layer names don't all need to be of the same length, obviously, and you can also skip them
9 * entirely and just use numbers.
14 #define _MOUSECURSOR 7
18 // TODO: (bdietz) - make a symbols layer for fun emoji and ascii art
19 // TODO: (bdietz) - make a symbol layer for greek symbols
22 enum planck_keycodes {
46 // Fillers to make layering more clear
47 #define _______ KC_TRNS
51 * This section of macros is for tap or hold functionality. Keys will fire off the second symbol in the name if tapped
52 * or fire the first symbol in the name if held. For example
55 * - will fire z if tapped
56 * - will fire cmd/super/win if held
58 #define ALT_DOT ALT_T(KC_DOT)
59 #define ALT_X ALT_T(KC_X)
60 #define CTL_SLSH CTL_T(KC_SLSH)
61 #define CTL_Z CTL_T(KC_Z)
62 #define GUI_C GUI_T(KC_C)
63 #define GUI_COMM GUI_T(KC_COMM)
64 #define HPR_ESC ALL_T(KC_ESC)
65 #define HPR_QUO ALL_T(KC_QUOT)
67 // Toggle to VIM when left space button is held, emit space keycode when left space is tapped
68 #define TGL_VIM LT(_VIM, KC_SPC)
69 // Toggle to the mouse layer when the right space button is held and emit enter when right space is tapped
70 #define TGL_MOUSE LT(_MOUSECURSOR, KC_ENT)
72 // TODO: (bdietz) - need to audit these keycodes to see what sort of cool things the default layout was doing.
73 #define ALT_TAB M(KC_ALT_TAB) // Macro for Alt-Tab
74 #define CMD_TAB M(KC_CMD_TAB) // Macro for Cmd-Tab
75 #define CTL_TAB M(KC_CTL_TAB) // Macro for Ctl-Tab
76 #define CMD_SLSH M(KC_CMD_SLSH) // Macro for Cmd-Slash (personal shortcut to toggle iTerm2 visibility)
77 #define AG_FIND M(KC_AG_FIND) // Macros for Cmd-[x] vs Ctrl-[x] based on current AG_NORM or AG_SWAP settings
78 #define AG_AGAIN M(KC_AG_AGAIN)
79 #define AG_UNDO M(KC_AG_UNDO)
80 #define AG_CUT M(KC_AG_CUT)
81 #define AG_COPY M(KC_AG_COPY)
82 #define AG_PASTE M(KC_AG_PASTE)
83 #define AG_D_L M(KC_AG_DESK_L) // For Virtual Desktop Switching: Left, and
84 #define AG_D_R M(KC_AG_DESK_R) // Right
85 #define AG_T_C M(KC_AG_TAB_C) // For Chrome, etc. Tab Close,
86 #define AG_T_N M(KC_AG_TAB_N) // Tab New, and
87 #define AG_T_R M(KC_AG_TAB_R) // Tab Reopen Closed
91 * ,---------+------+------+------+------+------+------+------+------+------+------+------+------.
92 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp | |
93 * |---------`------`------`------`------`------`------`------`------`------`------`------`------|
94 * |Hyper/Esc| A | S | D | F | G | H | J | K | L |MEDIA/;| Hyper/" |
95 * |----------`------`------`------`------`------`------`------`------`------`------`------------|
96 * | Shift |CTL/Zl|ALT/X |GUI/C | V | B | N | M |GUI/, | ALT/.|CTL// | Shift |
97 * |-----------`------`------`------`------`-----'-------`------`------`------`------`-----------|
98 * | | | | Lower | VIM/Space| MOUSE/Ent| Raise | | | |
99 * `-------+-------+-------+-------+---^^^----+---^^^----+---------+--------+--------+----------'
101 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
102 [_QWERTY] = KEYMAP_JD45(
103 /*,--------+-------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------.*/
104 KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC, ALL_T(KC_NO),
105 /*|--------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`--------`--------|*/
106 HPR_ESC , KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, LT(_MEDIA, KC_SCLN), HPR_QUO,
107 /*|---------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`----------------|*/
108 KC_LSFT, CTL_Z, ALT_X, GUI_C, KC_V, KC_B, KC_N, KC_M,GUI_COMM, ALT_DOT, CTL_SLSH, KC_RSFT ,
109 /*|----------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`---------------|*/
110 _______ , _______ , _______ , LOWER , TGL_VIM , TGL_MOUSE , RAISE , _______ , _______ , _______),
111 /*`----------+-----------+-----------+-----------+----^^^----+----^^^----+-----------+-----------+-----------+--------'*/
113 // TODO: (bdietz) - update the keymap documentation to include the modifier keys on the third row
115 * ,---------+------+------+------+------+------+------+------+------+------+------+------+------.
116 * | ` | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp | Bksp |
117 * |---------`------`------`------`------`------`------`------`------`------`------`------`------|
118 * | [ | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | "|" |
119 * |----------`------`------`------`------`------`------`------`------`------`------`------------|
120 * | ] | F7 | F8 | F9 | F10 | F11 | F12 | - | = | [ | ] | \ |
121 * |-----------`------`------`------`------`-----'-------`------`------`------`------`-----------|
122 * | | | | | | | | Prev | Next | Mute |
123 * `-------+-------+-------+-------+---^^^----+---^^^----+---------+--------+--------+----------'
125 [_LOWER] = KEYMAP_JD45(
126 /*,--------+-------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------.*/
127 KC_GRV,KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC, KC_BSPC,
128 /*|--------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`--------`--------|*/
129 KC_LBRC , KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE ,
130 /*|---------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`----------------|*/
131 KC_RBRC , CTL_T(KC_F7), ALT_T(KC_F8),GUI_T(KC_F9), KC_F10, KC_F11, KC_F12, KC_MINS, GUI_T(KC_EQL) , ALT_T(KC_LBRC), CTL_T(KC_RBRC), KC_BSLS ,
132 /*|----------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`---------------|*/
133 _______ , _______, _______, _______, _______ , _______ , _______, KC_MPRV, KC_MNXT, KC_MUTE),
134 /*`----------+-----------+-----------+-----------+----^^^----+----^^^----+-----------+-----------+-----------+--------'*/
137 * ,---------+------+------+------+------+------+------+------+------+------+------+------+------.
138 * | ~ | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp | Bksp |
139 * |---------`------`------`------`------`------`------`------`------`------`------`------`------|
140 * | $ | 4 | 5 | 6 | . | + | . | 4 | 5 | 6 | * | "|" |
141 * |----------`------`------`------`------`------`------`------`------`------`------`------------|
142 * | = | 7 | 8 | 9 | 0 | - | . | 1 | 2 | 3 | / | \ |
143 * |-----------`------`------`------`------`-----'-------`------`------`------`------`-----------|
144 * | | | | | | | | Prev | Next | Mute |
145 * `-------+-------+-------+-------+---^^^----+---^^^----+---------+--------+--------+----------'
147 [_RAISE] = KEYMAP_JD45(
148 /*,--------+-------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------.*/
149 KC_TILD, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC, KC_BSPC,
150 /*|--------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`--------`--------|*/
151 KC_DLR , KC_4, KC_5, KC_6, KC_DOT, KC_PLUS, KC_DOT, KC_4, KC_5, KC_6, KC_ASTR, KC_PIPE ,
152 /*|---------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`----------------|*/
153 KC_EQL , CTL_T(KC_7), ALT_T(KC_8), GUI_T(KC_9), KC_0, KC_MINS, KC_DOT, KC_1 ,GUI_T(KC_2), ALT_T(KC_3), CTL_T(KC_SLSH), KC_BSLS ,
154 /*|----------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`---------------|*/
155 _______ , _______, _______, _______, _______ , _______ , _______, KC_MPRV, KC_MNXT, KC_MUTE),
156 /*`----------+-----------+-----------+-----------+----^^^----+----^^^----+-----------+-----------+-----------+--------'*/
159 * ,---------+------+------+------+------+------+------+------+------+------+------+------+------.
160 * | | |ACCL0 | | | | |WHL_L | Up |WHL_R | BTN2 | | |
161 * |---------`------`------`------`------`------`------`------`------`------`------`------`------|
162 * | |ACCL2 | BTN2 | | BTN1 |ACCL1 |WHL_Up| Left | Down |Right | BTN4 | BTN5 |
163 * |----------`------`------`------`------`------`------`------`------`------`------`------------|
164 * | | | | | BTN3 | |WHL_Dn| BTN1 | | | BTN3 | |
165 * |-----------`------`------`------`------`-----'-------`------`------`------`------`-----------|
166 * | | | | | | | | | | |
167 * `-------+-------+-------+-------+---^^^----+---^^^----+---------+--------+--------+----------'
170 [_MOUSECURSOR] = KEYMAP_JD45(
171 /*,--------+-------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------.*/
172 _______,_______, _______, KC_MS_U, _______, _______, _______, KC_ACL2, KC_ACL1, KC_ACL0, _______, _______, _______,
173 /*|--------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`--------`--------|*/
174 _______ ,_______, KC_MS_L, KC_MS_D, KC_MS_R, _______, _______, KC_BTN1, KC_BTN2, _______, _______, _______ ,
175 /*|---------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`----------------|*/
176 _______ ,_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ ,
177 /*|----------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`---------------|*/
178 _______ , _______, _______, _______, _______, _______, _______, _______, _______, _______),
179 /*`----------+-----------+-----------+-----------+----^^^----+----^^^----+-----------+-----------+-----------+--------'*/
181 /* Adjust (Lower + Raise)
182 * ,---------+------+------+------+------+------+------+------+------+------+------+------+------.
183 * | | | | | | | | | | | | | Del |
184 * |---------`------`------`------`------`------`------`------`------`------`------`------`------|
185 * | | | | | |AGnorm|AGswap|Qwerty|Mouse | |Plover| |
186 * |----------`------`------`------`------`------`------`------`------`------`------`------------|
187 * | | | | | | | | | | | | |
188 * |-----------`------`------`------`------`-----'-------`------`------`------`------`-----------|
189 * | | | | | | | | | | Reset |
190 * `-------+-------+-------+-------+---^^^----+---^^^----+---------+--------+--------+----------'
192 [_ADJUST] = KEYMAP_JD45(
194 /*,--------+-------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------.*/
195 _______,_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL ,
196 /*|--------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`--------`--------|*/
197 _______ ,_______, _______, _______, _______, AG_NORM, AG_SWAP, QWERTY, _______, _______, _______, _______ ,
198 /*|---------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`----------------|*/
199 _______ ,_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ ,
200 /*|----------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`---------------|*/
201 _______ , _______, _______, _______, _______ , _______ , _______, _______, _______, RESET),
202 /*`----------+-----------+-----------+-----------+----^^^----+----^^^----+-----------+-----------+-----------+--------'*/
205 * ,---------+------+------+------+------+------+------+------+------+------+------+------+------.
206 * | | | | | | | | | | | | | |
207 * |---------`------`------`------`------`------`------`------`------`------`------`------`------|
208 * | | | | | | | LEFT | DOWN | UP |RIGHT | | |
209 * |----------`------`------`------`------`------`------`------`------`------`------`------------|
210 * | | | | | | | | | | | | |
211 * |-----------`------`------`------`------`-----'-------`------`------`------`------`-----------|
212 * | | | | | | | | | | |
213 * `-------+-------+-------+-------+---^^^----+---^^^----+---------+--------+--------+----------'
215 [_VIM] = KEYMAP_JD45(
216 /*,--------+-------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------.*/
217 _______,_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
218 /*|--------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`--------`--------|*/
219 _______ ,_______, _______, _______, _______, _______, KC_LEFT, KC_DOWN, KC_UP, KC_RIGHT, _______, _______ ,
220 /*|---------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`----------------|*/
221 _______ ,_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ ,
222 /*|----------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`---------------|*/
223 _______ , _______, _______, _______, _______ , _______ , _______, _______, _______,_______),
224 /*`----------+-----------+-----------+-----------+----^^^----+----^^^----+-----------+-----------+-----------+--------'*/
227 * ,---------+------+------+------+------+------+------+------+------+------+------+------+------.
228 * | | | | | | | | | | | | | |
229 * |---------`------`------`------`------`------`------`------`------`------`------`------`------|
230 * | | | | | | | | Prev | Next | Mute | | Play/Pause |
231 * |----------`------`------`------`------`------`------`------`------`------`------`------------|
232 * | | | | | | | | VolD | VolU | | | |
233 * |-----------`------`------`------`------`-----'-------`------`------`------`------`-----------|
234 * | | | | | | | | | | |
235 * `-------+-------+-------+-------+---^^^----+---^^^----+---------+--------+--------+----------'
237 [_MEDIA] = KEYMAP_JD45(
238 /*,--------+-------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------.*/
239 _______,_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
240 /*|--------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`--------`--------|*/
241 _______ ,_______, _______, _______, _______, _______, _______, KC_MPRV, KC_MNXT, KC_MUTE, _______, KC_MPLY ,
242 /*|---------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`----------------|*/
243 _______ ,_______, _______, _______, _______, _______, _______, KC_VOLD, KC_VOLU, _______, _______, _______ ,
244 /*|----------`-------`--------`--------`--------`--------`--------`--------`--------`--------`--------`---------------|*/
245 _______ , _______, _______, _______, _______ , _______ , _______, _______, _______, _______)
246 /*`----------+-----------+-----------+-----------+----^^^----+----^^^----+-----------+-----------+-----------+--------'*/
249 void persistant_default_layer_set(uint16_t default_layer) {
250 eeconfig_update_default_layer(default_layer);
251 default_layer_set(default_layer);
254 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
257 if (record->event.pressed) {
258 default_layer_set(1UL<<_QWERTY);
263 if (record->event.pressed) {
265 update_tri_layer(_LOWER, _RAISE, _ADJUST);
268 update_tri_layer(_LOWER, _RAISE, _ADJUST);
273 if (record->event.pressed) {
275 update_tri_layer(_LOWER, _RAISE, _ADJUST);
278 update_tri_layer(_LOWER, _RAISE, _ADJUST);
289 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
291 if (!eeconfig_is_enabled()) {
295 bool use_cmd = true; // Use, for example, Cmd-Tab, Cmd-C, Cmd-V, etc.
296 // Compare to MAGIC_SWAP_ALT_GUI and MAGIC_UNSWAP_ALT_GUI configs, set in:
298 if(keymap_config.swap_lalt_lgui == 1 && keymap_config.swap_ralt_rgui == 1) {
299 use_cmd = false; // ... or, Alt-Tab, Ctrl-C, Ctrl-V, etc.
304 if(use_cmd) { return (record->event.pressed ? MACRO( D(LALT), D(TAB), END ) : MACRO( U(TAB), END )); }
305 else { return (record->event.pressed ? MACRO( D(LGUI), D(TAB), END ) : MACRO( U(TAB), END )); }
307 if(use_cmd) { return (record->event.pressed ? MACRO( D(LGUI), D(TAB), END ) : MACRO( U(TAB), END )); }
308 else { return (record->event.pressed ? MACRO( D(LALT), D(TAB), END ) : MACRO( U(TAB), END )); }
311 return (record->event.pressed ? MACRO( D(LCTRL), D(TAB), END ) : MACRO( U(TAB), END ));
313 return (record->event.pressed ? MACRO( D(LGUI), D(SLSH),END ) : MACRO( U(SLSH),END ));
316 return use_cmd ? MACRODOWN( D(LGUI), T(F), END ) : MACRODOWN( D(LCTRL), T(F), END );
318 return use_cmd ? MACRODOWN( D(LGUI), T(G), END ) : MACRODOWN( D(LCTRL), T(G), END );
320 return use_cmd ? MACRODOWN( D(LGUI), T(Z), END ) : MACRODOWN( D(LCTRL), T(Z), END );
322 return use_cmd ? MACRODOWN( D(LGUI), T(X), END ) : MACRODOWN( D(LCTRL), T(X), END );
324 return use_cmd ? MACRODOWN( D(LGUI), T(C), END ) : MACRODOWN( D(LCTRL), T(C), END );
326 return use_cmd ? MACRODOWN( D(LGUI), T(V), END ) : MACRODOWN( D(LCTRL), T(V), END );
329 return use_cmd ? MACRODOWN( D(LGUI), D(LCTRL), T(SCLN), END ) : MACRODOWN( D(LALT), D(LCTRL), T(SCLN), END );
331 return use_cmd ? MACRODOWN( D(LGUI), D(LCTRL), T(QUOT), END ) : MACRODOWN( D(LALT), D(LCTRL), T(QUOT), END );
334 return use_cmd ? MACRODOWN( D(LGUI), T(W), END ) : MACRODOWN( D(LCTRL), T(W), END );
336 return use_cmd ? MACRODOWN( D(LGUI), T(T), END ) : MACRODOWN( D(LCTRL), T(T), END );
338 return use_cmd ? MACRODOWN( D(LGUI), D(LSHIFT), T(T), END ) : MACRODOWN( D(LCTRL), D(LSHIFT), T(T), END );