1 #include QMK_KEYBOARD_H
3 #include "action_layer.h"
7 * See `readme.md` for notes on each define.
10 // Personal preference (enable by passing EXTRAFLAGS=... to make).
11 // #define CFQ_USE_MOMENTARY_LAYER_KEYS
12 // #define CFQ_USE_EXPEREMENTAL_LAYER
14 // keep enabled for now
15 #define CFQ_USE_DYNAMIC_MACRO
17 #if !defined(CFQ_USER_KEY1)
18 #define CFQ_USER_KEY1 KC_SPC
20 #if !defined(CFQ_USER_KEY2)
21 #define CFQ_USER_KEY2 KC_ENT
23 #if !defined(CFQ_USER_KEY3)
24 #define CFQ_USER_KEY3 CFQ_KC_FN3
26 #if !defined(CFQ_USER_KEY4)
27 #define CFQ_USER_KEY4 KC_APP
30 #define BASE 0 // default layer
31 #define SYMB 1 // symbols
32 #define MDIA 2 // media keys
33 #ifdef CFQ_USE_EXPEREMENTAL_LAYER
34 #define EXPR 3 // experimental keys
37 enum custom_keycodes {
38 PLACEHOLDER = SAFE_RANGE, // can always be here
42 #ifdef CFQ_USE_DYNAMIC_MACRO
47 #ifdef CFQ_USE_DYNAMIC_MACRO
48 #include "dynamic_macro.h"
52 #ifdef CFQ_USE_EXPEREMENTAL_LAYER
62 #define M_BRACKET_IN_CBR 10
63 #define M_BRACKET_IN_PRN 11
64 #define M_BRACKET_IN_BRC 12
65 #define M_BRACKET_IN_ANG 13
66 #define M_BRACKET_OUT_CBR 14
67 #define M_BRACKET_OUT_PRN 15
68 #define M_BRACKET_OUT_BRC 16
69 #define M_BRACKET_OUT_ANG 17
70 #define M_ARROW_RMINUS 18
71 #define M_ARROW_LMINUS 19
72 #define M_ARROW_REQL 20
73 #define M_ARROW_LEQL 21
75 #ifdef CFQ_USE_MOMENTARY_LAYER_KEYS
76 #define CFQ_KC_FN1 MO(1)
77 #define CFQ_KC_FN2 MO(2)
78 #define CFQ_KC_FN3 MO(3)
80 #define CFQ_KC_FN1 KC_FN1
81 #define CFQ_KC_FN2 KC_FN2
82 #define CFQ_KC_FN3 KC_FN3
85 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
86 /* Keymap 0: Basic layer
87 * ,--------------------------------------------------. ,--------------------------------------------------.
88 * | Grave | ! | @ | # | $ | % | { | | } | ^ | & | * | - | = | BSpace |
89 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
90 * | Tab | Q | W | E | R | T | ( | | ) | Y | U | I | O | P | \ |
91 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
92 * | Esc | A | S | D | F | G |------| |------| H | J | K | L | ; | ' |
93 * |--------+------+------+------+------+------| [ | | ] |------+------+------+------+------+--------|
94 * | LShift | Z | X | C | V | B | | | | N | M | , | . | / | RShift |
95 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
96 * | LCtl |Super | Alt | USR4 |Space | | Left | Down | Up |Right | Del |
97 * `----------------------------------' `----------------------------------'
98 * ,-------------. ,-------------.
99 * | Ins | USR3 | | Home | End |
100 * ,------|------|------| |------+------+------.
101 * | | | ~L2 | | PgUp | | |
102 * | USR1 | USR2 |------| |------|Enter |Space |
103 * | | | ~L1 | | PgDn | | |
104 * `--------------------' `--------------------'
106 // If it accepts an argument (i.e, is a function), it doesn't need KC_.
107 // Otherwise, it needs KC_*
108 [BASE] = LAYOUT_ergodox( // layer 0 : default
110 KC_GRV, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_LCBR,
111 KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_LPRN,
112 KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G,
113 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_LBRC,
114 KC_LCTL, KC_LGUI, KC_LALT, CFQ_USER_KEY4, KC_SPC,
115 KC_INS, CFQ_USER_KEY3,
117 CFQ_USER_KEY1, CFQ_USER_KEY2, CFQ_KC_FN1,
119 KC_RCBR, KC_CIRC, KC_AMPR, KC_ASTR,KC_MINS, KC_EQL, KC_BSPC,
120 KC_RPRN, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSLS,
121 KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
122 KC_RBRC, KC_N, KC_M, KC_COMM,KC_DOT, KC_SLSH, KC_RSFT,
123 KC_LEFT, KC_DOWN,KC_UP, KC_RGHT, KC_DELT,
126 #ifdef CFQ_USE_SWAP_RIGHT_SPACE_ENTER
127 KC_PGDN, KC_SPC, KC_ENT
129 KC_PGDN, KC_ENT, KC_SPC
132 /* Keymap 1: Symbol layer
134 * ,--------------------------------------------------. ,--------------------------------------------------.
135 * | | F1 | F2 | F3 | F4 | F5 | {} | | }{ | F6 | F7 | F8 | F9 | F10 | |
136 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
137 * | | | | | | => | () | | )( | <= | 7 | 8 | 9 | \ | F11 |
138 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
139 * | | | | | | -> |------| |------| <- | 4 | 5 | 6 | * | F12 |
140 * |--------+------+------+------+------+------| [] | | ][ |------+------+------+------+------+--------|
141 * | | | | | | <> | | | | >< | 1 | 2 | 3 | - | |
142 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
143 * | | | | | | | 0 | | . | + | |
144 * `----------------------------------' `----------------------------------'
145 * ,-------------. ,---------------.
146 * |Start1|Start2| | | |
147 * ,------|------|------| |------+--------+------.
148 * | | | Stop | | | | |
149 * |Play1 |Play2 |------| |------| | |
151 * `--------------------' `----------------------'
154 [SYMB] = LAYOUT_ergodox(
156 KC_TRNS, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, M(M_BRACKET_IN_CBR),
157 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M(M_ARROW_REQL), M(M_BRACKET_IN_PRN),
158 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M(M_ARROW_RMINUS),
159 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M(M_BRACKET_IN_ANG), M(M_BRACKET_IN_BRC),
160 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
161 #ifdef CFQ_USE_DYNAMIC_MACRO
162 DYN_REC_START1, DYN_REC_START2,
164 DYN_MACRO_PLAY1, DYN_MACRO_PLAY2, KC_TRNS,
168 KC_TRNS, KC_TRNS, KC_TRNS,
171 M(M_BRACKET_OUT_CBR), KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_TRNS,
172 M(M_BRACKET_OUT_PRN), M(M_ARROW_LEQL), KC_KP_7, KC_KP_8, KC_KP_9, KC_KP_SLASH, KC_F11,
173 M(M_ARROW_LMINUS), KC_KP_4, KC_KP_5, KC_KP_6, KC_KP_ASTERISK, KC_F12,
174 M(M_BRACKET_OUT_BRC), M(M_BRACKET_OUT_ANG), KC_KP_1, KC_KP_2, KC_KP_3, KC_KP_MINUS, KC_TRNS,
175 KC_KP_0, KC_TRNS, KC_KP_DOT, KC_KP_PLUS, KC_TRNS,
178 KC_TRNS, KC_TRNS, KC_TRNS
180 /* Keymap 2: Media and mouse keys
182 * ,--------------------------------------------------. ,--------------------------------------------------.
183 * | | | | | | | | | | | | | | | |
184 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
185 * | | | | MsUp | | | | | | | | | | | |
186 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
187 * | | |MsLeft|MsDown|MsRght| |------| |------| Left | Down | Up |Right | | |
188 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
189 * | | | Rclk | Mclk | Lclk | | | | | | | | | | |
190 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
191 * | | | | | | | | | | | |
192 * `----------------------------------' `----------------------------------'
193 * ,-------------. ,-------------.
194 * | MRwd | MFwd | | MPrv | MNxt |
195 * ,------|------|------| |------+------+------.
196 * | | | | |VolUp | | |
197 * | | |------| |------| Mute | Play |
198 * | | | | |VolDn | | |
199 * `--------------------' `--------------------'
202 [MDIA] = LAYOUT_ergodox(
204 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
205 KC_TRNS, KC_TRNS, KC_TRNS, KC_MS_U, KC_TRNS, KC_TRNS, KC_TRNS,
206 KC_TRNS, KC_TRNS, KC_MS_L, KC_MS_D, KC_MS_R, KC_TRNS,
207 KC_TRNS, KC_TRNS, KC_BTN2, KC_BTN3, KC_BTN1, KC_TRNS, KC_TRNS,
208 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
211 KC_TRNS, KC_TRNS, KC_TRNS,
213 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
214 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
215 KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_TRNS, KC_TRNS,
216 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
217 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
220 KC_VOLD, KC_MUTE, KC_MPLY
222 #ifdef CFQ_USE_EXPEREMENTAL_LAYER
223 /* Keymap 3: My own testing keys!
225 * ,--------------------------------------------------. ,--------------------------------------------------.
226 * | | | | { | } | | } | | | | | | | | |
227 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
228 * | | | | ( | ) | | ) | | | Spc7 | Spc8 | | | | |
229 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
230 * | | | | [ | ] | |------| |------| Spc4 | Spc5 | Spc6 | | | |
231 * |--------+------+------+------+------+------| ] | | |------+------+------+------+------+--------|
232 * | | | | < | > | | | | | Spc1 | Spc2 | Spc3 | | | |
233 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
234 * | | | | | | | | | | | |
235 * `----------------------------------' `----------------------------------'
236 * ,-------------. ,-------------.
238 * ,------|------|------| |------+------+------.
240 * | | |------| |------| | |
242 * `--------------------' `--------------------'
246 [EXPR] = LAYOUT_ergodox(
248 KC_TRNS, KC_TRNS, KC_TRNS, KC_LCBR, KC_RCBR, KC_TRNS, KC_RCBR,
249 KC_TRNS, KC_TRNS, KC_TRNS, KC_LPRN, KC_RPRN, KC_TRNS, KC_RPRN,
250 KC_TRNS, KC_TRNS, KC_TRNS, KC_LBRC, KC_RBRC, KC_TRNS,
251 KC_TRNS, KC_TRNS, KC_TRNS, S(KC_COMM), S(KC_DOT), KC_TRNS, KC_RBRC,
252 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
255 KC_TRNS, KC_TRNS, KC_TRNS,
257 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
258 KC_TRNS, KC_TRNS, M(M_SPACES_7), M(M_SPACES_8), KC_TRNS, KC_TRNS, KC_TRNS,
259 KC_TRNS, M(M_SPACES_4), M(M_SPACES_5), M(M_SPACES_6), KC_TRNS, KC_TRNS,
260 KC_TRNS, KC_TRNS, M(M_SPACES_1), M(M_SPACES_2), M(M_SPACES_3), KC_TRNS, KC_TRNS,
261 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
264 KC_TRNS, KC_TRNS, KC_TRNS
266 #endif // CFQ_USE_EXPEREMENTAL_LAYER
269 const uint16_t PROGMEM fn_actions[] = {
270 [1] = ACTION_LAYER_TAP_TOGGLE(SYMB), // FN1 - Momentary Layer 1 (Symbols)
271 [2] = ACTION_LAYER_TAP_TOGGLE(MDIA), // FN2 - Momentary Layer 2 (Media)
272 #ifdef CFQ_USE_EXPEREMENTAL_LAYER
273 [3] = ACTION_LAYER_TAP_TOGGLE(EXPR), // FN3 - Momentary Layer 3 (Expremental)
277 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
279 // MACRODOWN only works in this function
282 if (record->event.pressed) {
283 SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION);
287 if (record->event.pressed) { // For resetting EEPROM
291 #ifdef CFQ_USE_EXPEREMENTAL_LAYER
293 if (record->event.pressed) { return MACRO(T(SPC), END); }
295 if (record->event.pressed) { return MACRO(T(SPC), T(SPC), END); }
297 if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), END); }
299 if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), END); }
301 if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), END); }
303 if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), END); }
305 if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), END); }
307 if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), END); }
308 #endif // CFQ_USE_EXPEREMENTAL_LAYER
309 case M_BRACKET_IN_CBR: // {}
310 if (record->event.pressed) { return MACRO(D(LSFT), T(LBRC), T(RBRC), U(LSFT), T(LEFT), END); }
311 case M_BRACKET_IN_PRN: // ()
312 if (record->event.pressed) { return MACRO(D(LSFT), T(9), T(0), U(LSFT), T(LEFT), END); }
313 case M_BRACKET_IN_BRC: // []
314 if (record->event.pressed) { return MACRO(T(LBRC), T(RBRC), T(LEFT), END); }
315 case M_BRACKET_IN_ANG: // <>
316 if (record->event.pressed) { return MACRO(D(LSFT), T(COMM), T(DOT), U(LSFT), T(LEFT), END); }
317 case M_BRACKET_OUT_CBR: // }{
318 if (record->event.pressed) { return MACRO(D(LSFT), T(RBRC), T(LBRC), U(LSFT), T(LEFT), END); }
319 case M_BRACKET_OUT_PRN: // )(
320 if (record->event.pressed) { return MACRO(D(LSFT), T(0), T(9), U(LSFT), T(LEFT), END); }
321 case M_BRACKET_OUT_BRC: // ][
322 if (record->event.pressed) { return MACRO(T(RBRC), T(LBRC), T(LEFT), END); }
323 case M_BRACKET_OUT_ANG: // ><
324 if (record->event.pressed) { return MACRO(D(LSFT), T(DOT), T(COMM), U(LSFT), T(LEFT), END); }
327 if (record->event.pressed) { return MACRO(T(MINUS), D(LSFT), T(DOT), U(LSFT), END); }
329 if (record->event.pressed) { return MACRO(D(LSFT), T(COMM), U(LSFT), T(MINUS), END); }
331 if (record->event.pressed) { return MACRO(T(EQL), D(LSFT), T(DOT), U(LSFT), END); }
333 if (record->event.pressed) { return MACRO(D(LSFT), T(COMM), U(LSFT), T(EQL), END); }
338 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
339 #ifdef CFQ_USE_DYNAMIC_MACRO
340 if (!process_record_dynamic_macro(keycode, record)) {
345 // dynamically generate these.
347 if (record->event.pressed) {
353 if (record->event.pressed) {
354 SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION);
359 if (record->event.pressed) {
360 #ifdef RGBLIGHT_ENABLE
370 // Runs just one time when the keyboard initializes.
371 void matrix_init_user(void) {
375 // Runs constantly in the background, in a loop.
376 void matrix_scan_user(void) {
378 uint8_t layer = biton32(layer_state);
380 ergodox_board_led_off();
381 ergodox_right_led_1_off();
382 ergodox_right_led_2_off();
383 ergodox_right_led_3_off();
386 ergodox_right_led_1_on();
389 ergodox_right_led_2_on();
391 #ifdef CFQ_USE_EXPEREMENTAL_LAYER
393 ergodox_right_led_3_on();