2 Copyright 2017 Christopher Courtney <drashna@live.com> @drashna
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #ifdef RGB_MATRIX_ENABLE
23 #include "rgb_matrix.h"
26 enum userspace_layers {
43 #define MODS_SHIFT_MASK (MOD_BIT(KC_LSHIFT)|MOD_BIT(KC_RSHIFT))
44 #define MODS_CTRL_MASK (MOD_BIT(KC_LCTL)|MOD_BIT(KC_RCTRL))
45 #define MODS_ALT_MASK (MOD_BIT(KC_LALT)|MOD_BIT(KC_RALT))
46 #define MODS_GUI_MASK (MOD_BIT(KC_LGUI)|MOD_BIT(KC_RGUI))
49 // RGB color codes are no longer located here anymore. Instead, you will want to
50 // head to https://github.com/qmk/qmk_firmware/blob/master/quantum/rgblight_list.h
52 extern bool clicky_enable;
54 #ifdef RGBLIGHT_ENABLE
55 void rgblight_sethsv_default_helper(uint8_t index);
56 #endif // RGBLIGHT_ENABLE
58 inline void tap(uint16_t keycode){ register_code(keycode); unregister_code(keycode); };
59 bool mod_key_press_timer (uint16_t code, uint16_t mod_code, bool pressed);
60 bool mod_key_press (uint16_t code, uint16_t mod_code, bool pressed, uint16_t this_timer);
62 #define EECONFIG_USERSPACE (uint8_t *)19
67 bool clicky_enable :1;
68 bool rgb_layer_change :1;
74 enum userspace_custom_keycodes {
75 EPRM = SAFE_RANGE, // Resets EEPROM do defaults (as in eeconfig_init)
76 VRSN, // Prints QMK Firmware and board info
77 KC_QWERTY, // Sets default layer to QWERTY
78 KC_COLEMAK, // Sets default layer to COLEMAK
79 KC_DVORAK, // Sets default layer to DVORAK
80 KC_WORKMAN, // Sets default layer to WORKMAN
81 KC_DIABLO_CLEAR, // Clears all Diablo Timers
82 KC_OVERWATCH, // Toggles game macro input mode (so in OW, it defaults to game chat)
83 KC_SALT, // See drashna.c for details
94 KC_MAKE, // Run keyboard's customized make command
95 KC_RGB_T, // Toggles RGB Layer Indication mode
100 KC_SECRET_5, // test5
101 KC_CCCV, // Hold to copy, tap to paste
102 KC_NUKE, // NUCLEAR LAUNCH DETECTED!!!
104 #ifdef UNICODE_ENABLE
105 UC_FLIP, // Table flip (not working?)
106 #endif //UNICODE_ENABLE
107 NEW_SAFE_RANGE //use "NEWPLACEHOLDER for keymap specific codes
110 #define LOWER MO(_LOWER)
111 #define RAISE MO(_RAISE)
112 #define ADJUST MO(_ADJUST)
113 #define TG_MODS TG(_MODS)
114 #define TG_GAME TG(_GAMEPAD)
116 #define KC_SEC1 KC_SECRET_1
117 #define KC_SEC2 KC_SECRET_2
118 #define KC_SEC3 KC_SECRET_3
119 #define KC_SEC4 KC_SECRET_4
120 #define KC_SEC5 KC_SECRET_5
122 #define QWERTY KC_QWERTY
123 #define DVORAK KC_DVORAK
124 #define COLEMAK KC_COLEMAK
125 #define WORKMAN KC_WORKMAN
127 #define KC_RESET RESET
128 #define KC_RST KC_RESET
130 #ifdef SWAP_HANDS_ENABLE
131 #define KC_C1R3 SH_TT
132 #else // SWAP_HANDS_ENABLE
133 #define KC_C1R3 KC_BSPC
134 #endif // SWAP_HANDS_ENABLE
136 #define BK_LWER LT(_LOWER, KC_BSPC)
137 #define SP_LWER LT(_LOWER, KC_SPC)
138 #define DL_RAIS LT(_RAISE, KC_DEL)
139 #define ET_RAIS LT(_RAISE, KC_ENTER)
141 // OSM keycodes, to keep things clean and easy to change
142 #define KC_MLSF OSM(MOD_LSFT)
143 #define KC_MRSF OSM(MOD_RSFT)
145 #define OS_LGUI OSM(MOD_LGUI)
146 #define OS_RGUI OSM(MOD_RGUI)
147 #define OS_LSFT OSM(MOD_LSFT)
148 #define OS_RSFT OSM(MOD_RSFT)
149 #define OS_LCTL OSM(MOD_LCTL)
150 #define OS_RCTL OSM(MOD_RCTL)
151 #define OS_LALT OSM(MOD_LALT)
152 #define OS_RALT OSM(MOD_RALT)
153 #define ALT_APP ALT_T(KC_APP)
155 #define MG_NKRO MAGIC_TOGGLE_NKRO
158 #ifdef TAP_DANCE_ENABLE
165 #endif // TAP_DANCE_ENABLE
168 // Custom Keycodes for Diablo 3 layer
169 // But since TD() doesn't work when tap dance is disabled
170 // We use custom codes here, so we can substitute the right stuff
171 #ifdef TAP_DANCE_ENABLE
172 #define KC_D3_1 TD(TD_D3_1)
173 #define KC_D3_2 TD(TD_D3_2)
174 #define KC_D3_3 TD(TD_D3_3)
175 #define KC_D3_4 TD(TD_D3_4)
176 #else // TAP_DANCE_ENABLE
181 #endif // TAP_DANCE_ENABLE
185 // Since our quirky block definitions are basically a list of comma separated
186 // arguments, we need a wrapper in order for these definitions to be
187 // expanded before being used as arguments to the LAYOUT_xxx macro.
188 #if (!defined(LAYOUT) && defined(KEYMAP))
189 #define LAYOUT KEYMAP
192 #define LAYOUT_ergodox_wrapper(...) LAYOUT_ergodox(__VA_ARGS__)
193 #define LAYOUT_ergodox_pretty_wrapper(...) LAYOUT_ergodox_pretty(__VA_ARGS__)
194 #define KEYMAP_wrapper(...) LAYOUT(__VA_ARGS__)
195 #define LAYOUT_wrapper(...) LAYOUT(__VA_ARGS__)
196 #define LAYOUT_ortho_4x12_wrapper(...) LAYOUT_ortho_4x12(__VA_ARGS__)
198 // Blocks for each of the four major keyboard layouts
199 // Organized so we can quickly adapt and modify all of them
200 // at once, rather than for each keyboard, one at a time.
201 // And this allows for much cleaner blocks in the keymaps.
202 // For instance Tap/Hold for Control on all of the layouts
204 // NOTE: These are all the same length. If you do a search/replace
205 // then you need to add/remove underscores to keep the
206 // lengths consistent.
208 #define _________________QWERTY_L1_________________ KC_Q, KC_W, KC_E, KC_R, KC_T
209 #define _________________QWERTY_L2_________________ KC_A, KC_S, KC_D, KC_F, KC_G
210 #define _________________QWERTY_L3_________________ CTL_T(KC_Z), KC_X, KC_C, KC_V, KC_B
212 #define _________________QWERTY_R1_________________ KC_Y, KC_U, KC_I, KC_O, KC_P
213 #define _________________QWERTY_R2_________________ KC_H, KC_J, KC_K, KC_L, KC_SCLN
214 #define _________________QWERTY_R3_________________ KC_N, KC_M, KC_COMM, KC_DOT, CTL_T(KC_SLASH)
217 #define _________________COLEMAK_L1________________ KC_Q, KC_W, KC_F, KC_P, KC_G
218 #define _________________COLEMAK_L2________________ KC_A, KC_R, KC_S, KC_T, KC_D
219 #define _________________COLEMAK_L3________________ CTL_T(KC_Z), KC_X, KC_C, KC_V, KC_B
221 #define _________________COLEMAK_R1________________ KC_J, KC_L, KC_U, KC_Y, KC_SCLN
222 #define _________________COLEMAK_R2________________ KC_H, KC_N, KC_E, KC_I, KC_O
223 #define _________________COLEMAK_R3________________ KC_K, KC_M, KC_COMM, KC_DOT, CTL_T(KC_SLASH)
225 #define ______________COLEMAK_MOD_DH_L1____________ KC_Q, KC_W, KC_F, KC_P, KC_B
226 #define ______________COLEMAK_MOD_DH_L2____________ KC_A, KC_R, KC_S, KC_T, KC_G
227 #define ______________COLEMAK_MOD_DH_L3____________ CTL_T(KC_Z), KC_X, KC_C, KC_D, KC_V
229 #define ______________COLEMAK_MOD_DH_R1____________ KC_J, KC_L, KC_U, KC_Y, KC_SCLN
230 #define ______________COLEMAK_MOD_DH_R2____________ KC_M, KC_N, KC_E, KC_I, KC_O
231 #define ______________COLEMAK_MOD_DH_R3____________ KC_K, KC_H, KC_COMM, KC_DOT, CTL_T(KC_SLASH)
234 #define _________________DVORAK_L1_________________ KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y
235 #define _________________DVORAK_L2_________________ KC_A, KC_O, KC_E, KC_U, KC_I
236 #define _________________DVORAK_L3_________________ CTL_T(KC_SCLN),KC_Q, KC_J, KC_K, KC_X
238 #define _________________DVORAK_R1_________________ KC_F, KC_G, KC_C, KC_R, KC_L
239 #define _________________DVORAK_R2_________________ KC_D, KC_H, KC_T, KC_N, KC_S
240 #define _________________DVORAK_R3_________________ KC_B, KC_M, KC_W, KC_V, CTL_T(KC_Z)
243 #define _________________WORKMAN_L1________________ KC_Q, KC_D, KC_R, KC_W, KC_B
244 #define _________________WORKMAN_L2________________ KC_A, KC_S, KC_H, KC_T, KC_G
245 #define _________________WORKMAN_L3________________ CTL_T(KC_Z), KC_X, KC_M, KC_C, KC_V
247 #define _________________WORKMAN_R1________________ KC_J, KC_F, KC_U, KC_P, KC_SCLN
248 #define _________________WORKMAN_R2________________ KC_Y, KC_N, KC_E, KC_O, KC_I
249 #define _________________WORKMAN_R3________________ KC_K, KC_L, KC_COMM, KC_DOT, CTL_T(KC_SLASH)
252 #define _________________NORMAN_L1_________________ KC_Q, KC_W, KC_D, KC_F, KC_K
253 #define _________________NORMAN_L2_________________ KC_A, KC_S, KC_E, KC_T, KC_G
254 #define _________________NORMAN_L3_________________ CTL_T(KC_Z), KC_X, KC_C, KC_V, KC_B
256 #define _________________NORMAN_R1_________________ KC_J, KC_U, KC_R, KC_L, KC_SCLN
257 #define _________________NORMAN_R2_________________ KC_Y, KC_N, KC_I, KC_O, KC_U
258 #define _________________NORMAN_R3_________________ KC_P, KC_M, KC_COMM, KC_DOT, CTL_T(KC_SLASH)
261 #define _________________MALTRON_L1________________ KC_Q, KC_P, KC_Y, KC_C, KC_B
262 #define _________________MALTRON_L2________________ KC_A, KC_N, KC_I, KC_S, KC_F
263 #define _________________MALTRON_L3________________ CTL_T(KC_SCLN), KC_SLSH, KC_J KC_G, KC_COMM
265 #define _________________MALTRON_R1________________ KC_V, KC_M, KC_U, KC_Z, KC_L
266 #define _________________MALTRON_R2________________ KC_D, KC_T, KC_D, KC_O, KC_R
267 #define _________________MALTRON_R3________________ KC_DOT, KC_W, KC_K, KC_MINS, CTL_T(KC_x)
270 #define _________________EUCALYN_L1________________ KC_SLSH, KC_COMM, KC_DOT, KC_F, KC_Q
271 #define _________________EUCALYN_L2________________ KC_A, KC_O, KC_E, KC_I, KC_U
272 #define _________________EUCALYN_L3________________ CTL_T(KC_Z), KC_X, KC_C, KC_V, KC_W
274 #define _________________EUCALYN_R1________________ KC_M, KC_R, KC_D, KC_Y, KC_P
275 #define _________________EUCALYN_R2________________ KC_G, KC_T, KC_K, KC_S, KC_N
276 #define _________________EUCALYN_R3________________ KC_B, KC_H, KC_J, KC_L, CTL_T(KC_SCLN)
279 #define _____________CARPLAX_QFMLWY_L1_____________ KC_Q, KC_F, KC_M, KC_L, KC_W
280 #define _____________CARPLAX_QFMLWY_L2_____________ KC_D, KC_S, KC_T, KC_N, KC_R
281 #define _____________CARPLAX_QFMLWY_L3_____________ CTL_T(KC_Z), KC_V, KC_G, KC_C, KC_X
283 #define _____________CARPLAX_QFMLWY_R1_____________ KC_Y, KC_U, KC_O, KC_B, KC_J
284 #define _____________CARPLAX_QFMLWY_R2_____________ KC_I, KC_A, KC_E, KC_H, KC_SCLN
285 #define _____________CARPLAX_QFMLWY_R3_____________ KC_P, KC_K, KC_COMM, KC_DOT, CTL_T(KC_SLSH)
288 #define _____________CARPLAX_QGMLWB_L1_____________ KC_Q, KC_G, KC_M, KC_L, KC_W
289 #define _____________CARPLAX_QGMLWB_L2_____________ KC_D, KC_S, KC_T, KC_N, KC_R
290 #define _____________CARPLAX_QGMLWB_L3_____________ CTL_T(KC_Z), KC_X, KC_C, KC_F, KC_J
292 #define _____________CARPLAX_QGMLWB_R1_____________ KC_B, KC_Y, KC_U, KC_V, KC_SCLN
293 #define _____________CARPLAX_QGMLWB_R2_____________ KC_I, KC_A, KC_E, KC_O, KC_H
294 #define _____________CARPLAX_QGMLWB_R3_____________ KC_K, KC_P, KC_COMM, KC_DOT, CTL_T(KC_SLSH)
297 #define _____________CARPLAX_QGMLWY_L1_____________ KC_Q, KC_G, KC_M, KC_L, KC_W
298 #define _____________CARPLAX_QGMLWY_L2_____________ KC_D, KC_S, KC_T, KC_N, KC_R
299 #define _____________CARPLAX_QGMLWY_L3_____________ CTL_T(KC_Z), KC_X, KC_C, KC_V, KC_J
301 #define _____________CARPLAX_QGMLWY_R1_____________ KC_Y, KC_F, KC_U, KC_B, KC_SCLN
302 #define _____________CARPLAX_QGMLWY_R2_____________ KC_I, KC_A, KC_E, KC_O, KC_H
303 #define _____________CARPLAX_QGMLWY_R3_____________ KC_K, KC_P, KC_COMM, KC_DOT, CTL_T(KC_SLSH)
306 #define ________________NUMBER_LEFT________________ KC_1, KC_2, KC_3, KC_4, KC_5
307 #define ________________NUMBER_RIGHT_______________ KC_6, KC_7, KC_8, KC_9, KC_0
308 #define _________________FUNC_LEFT_________________ KC_F1, KC_F2, KC_F3, KC_F4, KC_F5
309 #define _________________FUNC_RIGHT________________ KC_F6, KC_F7, KC_F8, KC_F9, KC_F10
311 #define ___________________BLANK___________________ _______, _______, _______, _______, _______
314 #define _________________LOWER_L1__________________ KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC
315 #define _________________LOWER_L2__________________ _________________FUNC_LEFT_________________
316 #define _________________LOWER_L3__________________ _________________FUNC_RIGHT________________
318 #define _________________LOWER_R1__________________ KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN
319 #define _________________LOWER_R2__________________ _______, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR
320 #define _________________LOWER_R3__________________ _______, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
324 #define _________________RAISE_L1__________________ ________________NUMBER_LEFT________________
325 #define _________________RAISE_L2__________________ ___________________BLANK___________________
326 #define _________________RAISE_L3__________________ ___________________BLANK___________________
328 #define _________________RAISE_R1__________________ ________________NUMBER_RIGHT_______________
329 #define _________________RAISE_R2__________________ _______, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC
330 #define _________________RAISE_R3__________________ _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END
334 #define _________________ADJUST_L1_________________ RGB_MOD, RGB_HUI, RGB_SAI, RGB_VAI, RGB_TOG
335 #define _________________ADJUST_L2_________________ MU_TOG , CK_TOGG, AU_ON, AU_OFF, AG_NORM
336 #define _________________ADJUST_L3_________________ RGB_RMOD,RGB_HUD,RGB_SAD, RGB_VAD, KC_RGB_T
338 #define _________________ADJUST_R1_________________ KC_SEC1, KC_SEC2, KC_SEC3, KC_SEC4, KC_SEC5
339 #define _________________ADJUST_R2_________________ AG_SWAP, QWERTY, COLEMAK, DVORAK, WORKMAN
340 #define _________________ADJUST_R3_________________ MG_NKRO, KC_MUTE, KC_VOLD, KC_VOLU, KC_MNXT
343 // Since we have 4 default layouts (QWERTY, DVORAK, COLEMAK and WORKMAN),
344 // this allows us to quickly modify the bottom row for all of the layouts
345 // so we don't have to alter it 4 times and hope that we haven't missed
347 #define ___________ERGODOX_BOTTOM_LEFT_____________ OSM(MOD_MEH), OSM(MOD_LGUI), KC_LBRC, KC_RBRC
348 #define ___________ERGODOX_BOTTOM_RIGHT____________ KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
351 #define ___________ORTHODOX_THUMP_TOP_____________ ALT_APP, OS_LGUI, KC_LALT, OS_RGUI
352 #define ___________________ORTHODOX_THUMB_BOTTOM____________________ LOWER, KC_SPACE,KC_BSPC, KC_DEL, KC_ENT, RAISE
355 #define __________________ERGODOX_THUMB_CLUSTER_____________________ ALT_T(KC_APP), OSM(MOD_LGUI), OSM(MOD_RGUI), CTL_T(KC_ESCAPE), \
357 LT(_LOWER, KC_SPACE),KC_BSPC, KC_END, KC_PGDN, KC_DEL, LT(_RAISE, KC_ENTER)