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 CFQ_KC_FN1
20 #if !defined(CFQ_USER_KEY2)
21 #define CFQ_USER_KEY2 KC_INS
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_SPC
29 #if !defined(CFQ_USER_KEY5)
30 #define CFQ_USER_KEY5 KC_ENT
32 #if !defined(CFQ_USER_KEY6)
33 #define CFQ_USER_KEY5 CFQ_KC_FN2
35 #if !defined(CFQ_USER_KEY7)
36 #define CFQ_USER_KEY5 CFQ_KC_FN1
39 #define BASE 0 // default layer
40 #define SYMB 1 // symbols
41 #define MDIA 2 // media keys
42 #ifdef CFQ_USE_EXPEREMENTAL_LAYER
43 #define EXPR 3 // experimental keys
46 enum custom_keycodes {
47 PLACEHOLDER = SAFE_RANGE, // can always be here
51 #ifdef CFQ_USE_DYNAMIC_MACRO
56 #ifdef CFQ_USE_DYNAMIC_MACRO
57 #include "dynamic_macro.h"
61 #ifdef CFQ_USE_EXPEREMENTAL_LAYER
71 #define M_BRACKET_IN_CBR 10
72 #define M_BRACKET_IN_PRN 11
73 #define M_BRACKET_IN_BRC 12
74 #define M_BRACKET_IN_ANG 13
75 #define M_BRACKET_OUT_CBR 14
76 #define M_BRACKET_OUT_PRN 15
77 #define M_BRACKET_OUT_BRC 16
78 #define M_BRACKET_OUT_ANG 17
79 #define M_ARROW_RMINUS 18
80 #define M_ARROW_LMINUS 19
81 #define M_ARROW_REQL 20
82 #define M_ARROW_LEQL 21
84 #ifdef CFQ_USE_MOMENTARY_LAYER_KEYS
85 #define CFQ_KC_FN1 MO(1)
86 #define CFQ_KC_FN2 MO(2)
87 #define CFQ_KC_FN3 MO(3)
89 #define CFQ_KC_FN1 KC_FN1
90 #define CFQ_KC_FN2 KC_FN2
91 #define CFQ_KC_FN3 KC_FN3
94 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
95 /* Keymap 0: Basic layer
96 * ,--------------------------------------------------. ,--------------------------------------------------.
97 * | Grave | ! | @ | # | $ | % | { | | } | ^ | & | * | - | = | BSpace |
98 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
99 * | Tab | Q | W | E | R | T | ( | | ) | Y | U | I | O | P | \ |
100 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
101 * | Esc | A | S | D | F | G |------| |------| H | J | K | L | ; | ' |
102 * |--------+------+------+------+------+------| [ | | ] |------+------+------+------+------+--------|
103 * | LShift | Z | X | C | V | B | | | | N | M | , | . | / | RShift |
104 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
105 * | LCtl |Super | Alt | ~L1 |Space | | Left | Down | Up |Right | Del |
106 * `----------------------------------' `----------------------------------'
107 * ,-------------. ,-------------.
108 * | Ins | ~L3 | | Home | End |
109 * ,------|------|------| |------+------+------.
110 * | | | ~L2 | | PgUp | | |
111 * |Space |Enter |------| |------|Enter |Space |
112 * | | | ~L1 | | PgDn | | |
113 * `--------------------' `--------------------'
115 * Optional overrides: see CFQ_USER_KEY# defines.
117 * -------+------+------+------+------+
119 * `----------------------------------'
123 * ,------|------|------|
125 * | USR4 | USR5 |------|
127 * `--------------------'
130 // If it accepts an argument (i.e, is a function), it doesn't need KC_.
131 // Otherwise, it needs KC_*
132 [BASE] = LAYOUT_ergodox( // layer 0 : default
134 KC_GRV, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_LCBR,
135 KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_LPRN,
136 KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G,
137 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_LBRC,
138 KC_LCTL, KC_LGUI, KC_LALT, CFQ_USER_KEY1, KC_SPC,
139 CFQ_USER_KEY2, CFQ_USER_KEY3,
141 CFQ_USER_KEY4, CFQ_USER_KEY5, CFQ_USER_KEY7,
143 KC_RCBR, KC_CIRC, KC_AMPR, KC_ASTR,KC_MINS, KC_EQL, KC_BSPC,
144 KC_RPRN, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSLS,
145 KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
146 KC_RBRC, KC_N, KC_M, KC_COMM,KC_DOT, KC_SLSH, KC_RSFT,
147 KC_LEFT, KC_DOWN,KC_UP, KC_RGHT, KC_DELT,
150 #ifdef CFQ_USE_SWAP_RIGHT_SPACE_ENTER
151 KC_PGDN, KC_SPC, KC_ENT
153 KC_PGDN, KC_ENT, KC_SPC
156 /* Keymap 1: Symbol layer
158 * ,--------------------------------------------------. ,--------------------------------------------------.
159 * | | F1 | F2 | F3 | F4 | F5 | {} | | }{ | F6 | F7 | F8 | F9 | F10 | |
160 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
161 * | | | | | | => | () | | )( | <= | 7 | 8 | 9 | \ | F11 |
162 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
163 * | | | | | | -> |------| |------| <- | 4 | 5 | 6 | * | F12 |
164 * |--------+------+------+------+------+------| [] | | ][ |------+------+------+------+------+--------|
165 * | | | | | | <> | | | | >< | 1 | 2 | 3 | - | |
166 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
167 * | | | | | | | 0 | | . | + | |
168 * `----------------------------------' `----------------------------------'
169 * ,-------------. ,---------------.
170 * |Start1|Start2| | | |
171 * ,------|------|------| |------+--------+------.
172 * | | | Stop | | | | |
173 * |Play1 |Play2 |------| |------| | |
175 * `--------------------' `----------------------'
178 [SYMB] = LAYOUT_ergodox(
180 KC_TRNS, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, M(M_BRACKET_IN_CBR),
181 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M(M_ARROW_REQL), M(M_BRACKET_IN_PRN),
182 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M(M_ARROW_RMINUS),
183 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M(M_BRACKET_IN_ANG), M(M_BRACKET_IN_BRC),
184 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
185 #ifdef CFQ_USE_DYNAMIC_MACRO
186 DYN_REC_START1, DYN_REC_START2,
188 DYN_MACRO_PLAY1, DYN_MACRO_PLAY2, KC_TRNS,
192 KC_TRNS, KC_TRNS, KC_TRNS,
195 M(M_BRACKET_OUT_CBR), KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_TRNS,
196 M(M_BRACKET_OUT_PRN), M(M_ARROW_LEQL), KC_KP_7, KC_KP_8, KC_KP_9, KC_KP_SLASH, KC_F11,
197 M(M_ARROW_LMINUS), KC_KP_4, KC_KP_5, KC_KP_6, KC_KP_ASTERISK, KC_F12,
198 M(M_BRACKET_OUT_BRC), M(M_BRACKET_OUT_ANG), KC_KP_1, KC_KP_2, KC_KP_3, KC_KP_MINUS, KC_TRNS,
199 KC_KP_0, KC_TRNS, KC_KP_DOT, KC_KP_PLUS, KC_TRNS,
202 KC_TRNS, KC_TRNS, KC_TRNS
204 /* Keymap 2: Media and mouse keys
206 * ,--------------------------------------------------. ,--------------------------------------------------.
207 * | | | | | | | | | | | | | | | |
208 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
209 * | | | | MsUp | | |MWhlUp| | | | | | | | |
210 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
211 * | | |MsLeft|MsDown|MsRght| |------| |------| Left | Down | Up |Right | | |
212 * |--------+------+------+------+------+------|MWhlDn| | |------+------+------+------+------+--------|
213 * | | | Rclk | Mclk | Lclk | | | | | | | | | | |
214 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
215 * | | | | | | | | | | | |
216 * `----------------------------------' `----------------------------------'
217 * ,-------------. ,-------------.
218 * | MRwd | MFwd | | MPrv | MNxt |
219 * ,------|------|------| |------+------+------.
220 * | | | | |VolUp | | |
221 * | | |------| |------| Mute | Play |
222 * | | | | |VolDn | | |
223 * `--------------------' `--------------------'
226 [MDIA] = LAYOUT_ergodox(
228 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
229 KC_TRNS, KC_TRNS, KC_TRNS, KC_MS_U, KC_TRNS, KC_TRNS, KC_WH_U,
230 KC_TRNS, KC_TRNS, KC_MS_L, KC_MS_D, KC_MS_R, KC_TRNS,
231 KC_TRNS, KC_TRNS, KC_BTN2, KC_BTN3, KC_BTN1, KC_TRNS, KC_WH_D,
232 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
235 KC_TRNS, KC_TRNS, KC_TRNS,
237 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
238 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
239 KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_TRNS, KC_TRNS,
240 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
241 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
244 KC_VOLD, KC_MUTE, KC_MPLY
246 #ifdef CFQ_USE_EXPEREMENTAL_LAYER
247 /* Keymap 3: My own testing keys!
249 * ,--------------------------------------------------. ,--------------------------------------------------.
250 * | | | | { | } | | } | | | | | | | | |
251 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
252 * | | | | ( | ) | | ) | | | Spc7 | Spc8 | | | | |
253 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
254 * | | | | [ | ] | |------| |------| Spc4 | Spc5 | Spc6 | | | |
255 * |--------+------+------+------+------+------| ] | | |------+------+------+------+------+--------|
256 * | | | | < | > | | | | | Spc1 | Spc2 | Spc3 | | | |
257 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
258 * | | | | | | | | | | | |
259 * `----------------------------------' `----------------------------------'
260 * ,-------------. ,-------------.
262 * ,------|------|------| |------+------+------.
264 * | | |------| |------| | |
266 * `--------------------' `--------------------'
270 [EXPR] = LAYOUT_ergodox(
272 KC_TRNS, KC_TRNS, KC_TRNS, KC_LCBR, KC_RCBR, KC_TRNS, KC_RCBR,
273 KC_TRNS, KC_TRNS, KC_TRNS, KC_LPRN, KC_RPRN, KC_TRNS, KC_RPRN,
274 KC_TRNS, KC_TRNS, KC_TRNS, KC_LBRC, KC_RBRC, KC_TRNS,
275 KC_TRNS, KC_TRNS, KC_TRNS, S(KC_COMM), S(KC_DOT), KC_TRNS, KC_RBRC,
276 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
279 KC_TRNS, KC_TRNS, KC_TRNS,
281 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
282 KC_TRNS, KC_TRNS, M(M_SPACES_7), M(M_SPACES_8), KC_TRNS, KC_TRNS, KC_TRNS,
283 KC_TRNS, M(M_SPACES_4), M(M_SPACES_5), M(M_SPACES_6), KC_TRNS, KC_TRNS,
284 KC_TRNS, KC_TRNS, M(M_SPACES_1), M(M_SPACES_2), M(M_SPACES_3), KC_TRNS, KC_TRNS,
285 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
288 KC_TRNS, KC_TRNS, KC_TRNS
290 #endif // CFQ_USE_EXPEREMENTAL_LAYER
293 const uint16_t PROGMEM fn_actions[] = {
294 [1] = ACTION_LAYER_TAP_TOGGLE(SYMB), // FN1 - Momentary Layer 1 (Symbols)
295 [2] = ACTION_LAYER_TAP_TOGGLE(MDIA), // FN2 - Momentary Layer 2 (Media)
296 #ifdef CFQ_USE_EXPEREMENTAL_LAYER
297 [3] = ACTION_LAYER_TAP_TOGGLE(EXPR), // FN3 - Momentary Layer 3 (Expremental)
301 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
303 // MACRODOWN only works in this function
306 if (record->event.pressed) {
307 SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION);
311 if (record->event.pressed) { // For resetting EEPROM
315 #ifdef CFQ_USE_EXPEREMENTAL_LAYER
317 if (record->event.pressed) { return MACRO(T(SPC), END); }
319 if (record->event.pressed) { return MACRO(T(SPC), T(SPC), END); }
321 if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), END); }
323 if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), END); }
325 if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), END); }
327 if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), END); }
329 if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), END); }
331 if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), END); }
332 #endif // CFQ_USE_EXPEREMENTAL_LAYER
333 case M_BRACKET_IN_CBR: // {}
334 if (record->event.pressed) { return MACRO(D(LSFT), T(LBRC), T(RBRC), U(LSFT), T(LEFT), END); }
335 case M_BRACKET_IN_PRN: // ()
336 if (record->event.pressed) { return MACRO(D(LSFT), T(9), T(0), U(LSFT), T(LEFT), END); }
337 case M_BRACKET_IN_BRC: // []
338 if (record->event.pressed) { return MACRO(T(LBRC), T(RBRC), T(LEFT), END); }
339 case M_BRACKET_IN_ANG: // <>
340 if (record->event.pressed) { return MACRO(D(LSFT), T(COMM), T(DOT), U(LSFT), T(LEFT), END); }
341 case M_BRACKET_OUT_CBR: // }{
342 if (record->event.pressed) { return MACRO(D(LSFT), T(RBRC), T(LBRC), U(LSFT), T(LEFT), END); }
343 case M_BRACKET_OUT_PRN: // )(
344 if (record->event.pressed) { return MACRO(D(LSFT), T(0), T(9), U(LSFT), T(LEFT), END); }
345 case M_BRACKET_OUT_BRC: // ][
346 if (record->event.pressed) { return MACRO(T(RBRC), T(LBRC), T(LEFT), END); }
347 case M_BRACKET_OUT_ANG: // ><
348 if (record->event.pressed) { return MACRO(D(LSFT), T(DOT), T(COMM), U(LSFT), T(LEFT), END); }
351 if (record->event.pressed) { return MACRO(T(MINUS), D(LSFT), T(DOT), U(LSFT), END); }
353 if (record->event.pressed) { return MACRO(D(LSFT), T(COMM), U(LSFT), T(MINUS), END); }
355 if (record->event.pressed) { return MACRO(T(EQL), D(LSFT), T(DOT), U(LSFT), END); }
357 if (record->event.pressed) { return MACRO(D(LSFT), T(COMM), U(LSFT), T(EQL), END); }
362 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
363 #ifdef CFQ_USE_DYNAMIC_MACRO
364 if (!process_record_dynamic_macro(keycode, record)) {
369 // dynamically generate these.
371 if (record->event.pressed) {
377 if (record->event.pressed) {
378 SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION);
383 if (record->event.pressed) {
384 #ifdef RGBLIGHT_ENABLE
394 // Runs just one time when the keyboard initializes.
395 void matrix_init_user(void) {
399 // Runs constantly in the background, in a loop.
400 void matrix_scan_user(void) {
402 uint8_t layer = biton32(layer_state);
404 ergodox_board_led_off();
405 ergodox_right_led_1_off();
406 ergodox_right_led_2_off();
407 ergodox_right_led_3_off();
410 ergodox_right_led_1_on();
413 ergodox_right_led_2_on();
415 #ifdef CFQ_USE_EXPEREMENTAL_LAYER
417 ergodox_right_led_3_on();