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 // To flash planck firmware
5 // ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
6 // Reset keyboard or press hw reset button on base (hole)
8 // cd qmk_firmware/keyboards/planck
9 // sudo make KEYMAP=sdothum dfu
11 // sudo make clean (good practice before flashing)
12 // sudo make KEYMAP=sdothum (to compile check)
14 // Package requirements (for arch linux)
15 // ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
22 // ** E R G O W I D E S P L I T ** Layout
24 // Autocompletion tap dance key pairs (),[],{} are available from the
25 // number/symbol layer, as well as, numerous (un)shift key values
27 // The navigation pad provides a single hand right thumb activated cluster
28 // with left hand modifiers
30 // #define PRIVATE_STRING includes private_string.h, a user defined code
31 // block for the PRIV tap dance e.g. SEND_STRING("secret messape"),
32 // see function private()
36 // The num and sym keys together access the navigation pad layer
38 // ,-----------------------------------------------------------------------------------.
39 // | Ctrl | GUI | Alt | Esc | Space| Tab | Bksp | Ent | Left | Down | Up | Right|
40 // `-----------------------------------------------------------------------------------'
44 // For sculpted keycaps such as Cherry or OEM profile, reverse the Alt, Num,
45 // Shift, Shift, Nav, Sym keycaps for more ergonomic thumb orientation and
50 // This source is shamelessly based on the "default" planck layout
52 // #ifdef/#endif block structures are not indented, as syntax highlighting
53 // in vim is sufficient for identification
55 // c++ commenting style is used throughout
59 // See http://thedarnedestthing.com/planck%20constant
60 // See http://thedarnedestthing.com/planck%20done
66 // sudo CPATH=<keymap.c directory>/common make ...
71 #include "action_layer.h"
73 #include "keymap_steno.h"
80 extern keymap_config_t keymap_config;
104 enum planck_keycodes {
109 ,SM_CIRC // pseudo GUI_T(S(KC_6)) for shifted key-codes, see process_record_user()
110 ,SM_DLR // pseudo SFT_T(S(KC_4)) for shifted key-codes, see process_record_user()
111 ,SM_G // pseudo MT (MOD_LALT | MOD_LSFT, S(KC_G)) for shifted key-codes, see process_record_user()
112 ,SM_H // pseudo MT (MOD_LCTL | MOD_LSFT, S(KC_H)) for shifted key-codes, see process_record_user()
113 ,SM_PERC // pseudo ALT_T(S(KC_5)) for shifted key-codes, see process_record_user()
114 ,SM_W // pseudo MT (MOD_LGUI | MOD_LSFT, S(KC_W)) for shifted key-codes, see process_record_user()
115 ,SL_LEFT // pseudo LT (_MOUSE, S(KC_LEFT)) for shifted key-codes, see process_record_user()
116 ,SP_DEL // pseudo LT (_MOUSE, KC_DEL) for shifted key-codes, see process_record_user()
117 ,SL_TAB // pseudo LT (_FNCKEY, S(KC_TAB)) for shifted key-codes, see process_record_user()
127 ,LT_C = LT (_NUMBER, KC_C)
128 ,LT_V = LT (_FNCKEY, KC_V)
129 ,LT_N = LT (_EDIT, KC_N)
130 ,LT_M = LT (_SYMBOL, KC_M)
135 #define AT_B ALT_T(KC_B)
136 #define AT_DOWN ALT_T(KC_DOWN)
137 #define CT_RGHT CTL_T(KC_RGHT)
138 #define GT_C GUI_T(KC_C)
139 #define GT_UP GUI_T(KC_UP)
140 #define MT_E MT (MOD_LCTL | MOD_LALT, KC_E)
141 #define ST_A SFT_T(KC_A)
143 #define HOME_H GUI_T(KC_H)
144 #define HOME_I CTL_T(KC_I)
145 #define HOME_E ALT_T(KC_E)
146 #define HOME_A SFT_T(KC_A)
147 #define HOME_T SFT_T(KC_T)
148 #define HOME_R ALT_T(KC_R)
149 #define HOME_S CTL_T(KC_S)
150 #define HOME_W GUI_T(KC_W)
162 #define S_DOWN S (KC_DOWN)
163 #define S_LEFT S (KC_LEFT)
164 #define S_RGHT S (KC_RGHT)
165 #define S_TAB S (KC_TAB)
166 #define S_UP S (KC_UP)
168 #include "tapdance.h"
171 #define ___x___ KC_TRNS
172 #define ___fn__ KC_TRNS
176 #define _______ KC_NO
178 #define COPY LCTL(KC_C)
179 #define CUT LCTL(KC_X)
180 #define EOT LCTL(KC_D)
181 #define NAK LCTL(KC_U)
182 #define PASTE LCTL(KC_V)
183 #define UNDO LCTL(KC_Z)
184 #define TMCOPY LALT(LCTL(KC_C))
185 #define TMPASTE LALT(LCTL(KC_V))
186 #define LT_BSLS LT (_MOUSE, KC_BSLS) // see process_record_user() for extended handling
187 #define LT_BSPC LT (_EDIT, KC_BSPC)
188 #define SP_LEFT LT (_EDIT, KC_LEFT)
189 #define LT_ESC LT (_NUMBER, KC_ESC)
190 #define LT_LEFT LT (_SYMBOL, KC_LEFT) // see process_record_user() for extended handling
191 #define SP_BSPC LT (_SYMBOL, KC_BSPC) // see process_record_user() for extended handling
192 #define LT_TAB LT (_FNCKEY, KC_TAB)
193 #define LT_INS LT (_FNCKEY, KC_INS)
194 #define ADJUST MO (_ADJUST)
195 #define OS_ALT OSM (MOD_LALT)
196 #define OS_CTL OSM (MOD_LCTL)
197 #define OS_GUI OSM (MOD_LGUI)
198 #define OS_SFT OSM (MOD_LSFT)
201 #define CNTR_TL TT (_TTFNCKEY)
202 #define CNTR_TR KC_CAPS
203 #define CNTR_HL TT (_TTCURSOR)
204 #define CNTR_HR TT (_TTMOUSE)
205 #define CNTR_BL TT (_TTNUMBER)
206 #define CNTR_BR TT (_TTREGEX)
208 #define CNTR_TL OSM (MOD_LALT | MOD_LCTL)
209 #define CNTR_TR OSM (MOD_LGUI | MOD_LCTL)
210 #define CNTR_HL OSM (MOD_LALT | MOD_LSFT)
211 #define CNTR_HR OSM (MOD_LGUI | MOD_LSFT)
212 #define CNTR_BL TD (_CAPS)
213 #define CNTR_BR OSM (MOD_LSFT | MOD_LCTL)
217 #define LT_EQL LT (_ADJUST, KC_EQL)
219 #define LT_0 LT (_ADJUST, KC_0)
222 // ........................................................ Default Alpha Layout
224 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
227 #include "steno_layout.h"
229 // ...................................................... Number / Function Keys
231 #include "number_fkey_layout.h"
233 // ......................................................... Symbol / Navigation
235 #include "symbol_guifn_layout.h"
237 // ............................................................... Toggle Layers
240 #include "toggle_layout.h"
243 // ......................................................... Short Cuts / Adjust
245 #include "chord_layout.h"
249 // ...................................................................... Sounds
253 // ........................................................... User Keycode Trap
255 #include "keycode_functions.h"
260 static uint8_t base_n = 0;
262 bool process_record_user(uint16_t keycode, keyrecord_t *record)
266 if (record->event.pressed) {
267 base_n = base_n | BASE_1;
268 if (base_n == BASE_12) {
273 base_n = base_n & ~BASE_1;
277 if (record->event.pressed) {
278 base_n = base_n | BASE_2;
279 if (base_n == BASE_12) {
284 base_n = base_n & ~BASE_2;
292 tap_mods(record, KC_LALT);
299 tap_mods(record, KC_LGUI);
306 tap_mods(record, KC_LCTL);
311 tap_mods(record, KC_LSFT);
316 clear_tt(); // exit TT layer
321 if (tt_keycode != 0) {
322 clear_tt(); // exit TT layer
326 tap_layer(record, _NUMBER);
330 tap_layer(record, _SYMBOL);
331 // LT (_SYMBOL, KC_LEFT) left right combination layer
332 thumb_layer(record, RIGHT, 0, 0, _SYMBOL, _LSHIFT);
335 tap_mods(record, KC_LALT);
338 tap_mods(record, KC_LCTL);
341 tap_mods(record, KC_LGUI);
345 mt_shift(record, KC_LGUI, 0, KC_6);
349 mt_shift(record, KC_LSFT, 0, KC_4);
352 // MT(MOD_LALT | MOD_LSFT, S(KC_G))
353 mt_shift(record, KC_LALT, KC_LSFT, KC_G);
356 // MT(MOD_LCTL | MOD_LSFT, S(KC_K))
357 mt_shift(record, KC_LCTL, KC_LSFT, KC_H);
360 // MT(MOD_LGUI | MOD_LSFT, S(KC_W))
361 mt_shift(record, KC_LGUI, KC_LSFT, KC_W);
365 mt_shift(record, KC_LALT, 0, KC_5);
368 tap_layer(record, _MOUSE);
369 // LT (_MOUSE, KC_BSLS) left right combination layer, see #define LT_BSLS
370 thumb_layer(record, LEFT, 0, 0, _MOUSE, _SYMBOL);
373 tap_layer(record, _MOUSE);
374 // LT (_MOUSE, S(KC_LEFT)) left right combination layer
375 thumb_layer(record, RIGHT, SHIFT, KC_LEFT, _MOUSE, _LSHIFT);
378 tap_layer(record, _MOUSE);
379 // LT (_MOUSE, S(KC_LEFT)) left right combination layer
380 thumb_layer(record, RIGHT, NOSHIFT, KC_DEL, _MOUSE, _LSHIFT);
383 // LT (_FNCKEY, S(KC_TAB)) emulation
384 lt_shift(record, KC_TAB, _FNCKEY);
387 tap_layer(record, _RSHIFT);
388 // LT (_RSHIFT, KC_ENT) emulation, see tap dance enter
391 tap_layer(record, _LSHIFT);
392 // LT (_LSHIFT, KC_SPC) left right combination layer, see tap dance TD_SPC
393 thumb_layer(record, LEFT, 0, 0, _LSHIFT, _SYMBOL);
402 if (tt_keycode != keycode && tt_keycode != 0) {
403 clear_tt(); // return to base layer first if different TT layer selected
405 tt_keycode = keycode;
408 // #ifdef STENO_ENABLE
410 // stn_layer(record, STN_A, _NUMBER);
413 // stn_layer(record, STN_O, _FNCKEY);
416 // stn_layer(record, STN_E, _EDIT);
419 // stn_layer(record, STN_U, _SYMBOL);