users/drashna/drashna.h

   1 /*
   2 Copyright 2017 Christopher Courtney <drashna@live.com> @drashna
   3
   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.
   8
   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.
  13
  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/>.
  16 */
  17
  18 #pragma once
  19 #include "quantum.h"
  20 #include "version.h"
  21 #include "eeprom.h"
  22 #ifdef RGB_MATRIX_ENABLE
  23 #include "rgb_matrix.h"
  24 #endif
  25 // Define layer names
  26 enum userspace_layers {
  27   _QWERTY = 0,
  28   _NUMLOCK = 0,
  29   _COLEMAK,
  30   _DVORAK,
  31   _WORKMAN,
  32   _MODS,
  33   _GAMEPAD,
  34   _DIABLO,
  35   _MACROS,
  36   _MEDIA,
  37   _LOWER,
  38   _RAISE,
  39   _ADJUST,
  40 };
  41
  42 //define modifiers
  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))
  47
  48
  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
  51
  52 extern bool rgb_layer_change;
  53
  54 #ifdef RGBLIGHT_ENABLE
  55 void rgblight_sethsv_default_helper(uint8_t index);
  56 #endif // RGBLIGHT_ENABLE
  57
  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);
  61
  62 #define EECONFIG_USERSPACE (uint8_t *)19
  63
  64 typedef union {
  65   uint8_t raw;
  66   struct {
  67     bool     rgb_layer_change :1;
  68     bool     is_overwatch     :1;
  69     bool     nuke_switch      :1;
  70   };
  71 } userspace_config_t;
  72
  73 enum userspace_custom_keycodes {
  74   EPRM = SAFE_RANGE, // Resets EEPROM do defaults (as in eeconfig_init)
  75   VRSN,              // Prints QMK Firmware and board info
  76   KC_QWERTY,         // Sets default layer to QWERTY
  77   KC_COLEMAK,        // Sets default layer to COLEMAK
  78   KC_DVORAK,         // Sets default layer to DVORAK
  79   KC_WORKMAN,        // Sets default layer to WORKMAN
  80   KC_DIABLO_CLEAR,   // Clears all Diablo Timers
  81   KC_OVERWATCH,      // Toggles game macro input mode (so in OW, it defaults to game chat)
  82   KC_SALT,           // See drashna.c for details
  83   KC_MORESALT,
  84   KC_SALTHARD,
  85   KC_GOODGAME,
  86   KC_SYMM,
  87   KC_JUSTGAME,
  88   KC_GLHF,
  89   KC_TORB,
  90   KC_AIM,
  91   KC_C9,
  92   KC_GGEZ,
  93   KC_MAKE,           // Run keyboard's customized make command
  94   KC_RGB_T,          // Toggles RGB Layer Indication mode
  95   KC_SECRET_1,       // test1
  96   KC_SECRET_2,       // test2
  97   KC_SECRET_3,       // test3
  98   KC_SECRET_4,       // test4
  99   KC_SECRET_5,       // test5
 100   KC_CCCV,           // Hold to copy, tap to paste
 101   KC_NUKE,           // NUCLEAR LAUNCH DETECTED!!!
 102
 103 #ifdef UNICODE_ENABLE
 104   UC_FLIP,           // Table flip (not working?)
 105 #endif //UNICODE_ENABLE
 106   NEW_SAFE_RANGE     //use "NEWPLACEHOLDER for keymap specific codes
 107 };
 108
 109 #define LOWER MO(_LOWER)
 110 #define RAISE MO(_RAISE)
 111 #define ADJUST MO(_ADJUST)
 112 #define TG_MODS TG(_MODS)
 113 #define TG_GAME TG(_GAMEPAD)
 114
 115 #define KC_SEC1 KC_SECRET_1
 116 #define KC_SEC2 KC_SECRET_2
 117 #define KC_SEC3 KC_SECRET_3
 118 #define KC_SEC4 KC_SECRET_4
 119 #define KC_SEC5 KC_SECRET_5
 120
 121 #define QWERTY KC_QWERTY
 122 #define DVORAK KC_DVORAK
 123 #define COLEMAK KC_COLEMAK
 124 #define WORKMAN KC_WORKMAN
 125
 126 #define KC_RESET RESET
 127 #define KC_RST KC_RESET
 128
 129 #ifdef SWAP_HANDS_ENABLE
 130 #define KC_C1R3 SH_TT
 131 #else // SWAP_HANDS_ENABLE
 132 #define KC_C1R3 KC_BSPC
 133 #endif // SWAP_HANDS_ENABLE
 134
 135 #define BK_LWER LT(_LOWER, KC_BSPC)
 136 #define SP_LWER LT(_LOWER, KC_SPC)
 137 #define DL_RAIS LT(_RAISE, KC_DEL)
 138 #define ET_RAIS LT(_RAISE, KC_ENTER)
 139
 140 // OSM keycodes, to keep things clean and easy to change
 141 #define KC_MLSF OSM(MOD_LSFT)
 142 #define KC_MRSF OSM(MOD_RSFT)
 143
 144 #define OS_LGUI OSM(MOD_LGUI)
 145 #define OS_RGUI OSM(MOD_RGUI)
 146 #define OS_LSFT OSM(MOD_LSFT)
 147 #define OS_RSFT OSM(MOD_RSFT)
 148 #define OS_LCTL OSM(MOD_LCTL)
 149 #define OS_RCTL OSM(MOD_RCTL)
 150 #define OS_LALT OSM(MOD_LALT)
 151 #define OS_RALT OSM(MOD_RALT)
 152 #define ALT_APP ALT_T(KC_APP)
 153
 154 #define MG_NKRO MAGIC_TOGGLE_NKRO
 155
 156
 157 #ifdef TAP_DANCE_ENABLE
 158 enum {
 159   TD_D3_1 = 0,
 160   TD_D3_2,
 161   TD_D3_3,
 162   TD_D3_4
 163 };
 164 #endif // TAP_DANCE_ENABLE
 165
 166
 167 // Custom Keycodes for Diablo 3 layer
 168 // But since TD() doesn't work when tap dance is disabled
 169 // We use custom codes here, so we can substitute the right stuff
 170 #ifdef TAP_DANCE_ENABLE
 171 #define KC_D3_1 TD(TD_D3_1)
 172 #define KC_D3_2 TD(TD_D3_2)
 173 #define KC_D3_3 TD(TD_D3_3)
 174 #define KC_D3_4 TD(TD_D3_4)
 175 #else // TAP_DANCE_ENABLE
 176 #define KC_D3_1 KC_1
 177 #define KC_D3_2 KC_2
 178 #define KC_D3_3 KC_3
 179 #define KC_D3_4 KC_4
 180 #endif // TAP_DANCE_ENABLE
 181
 182
 183
 184 // Since our quirky block definitions are basically a list of comma separated
 185 // arguments, we need a wrapper in order for these definitions to be
 186 // expanded before being used as arguments to the LAYOUT_xxx macro.
 187 #if (!defined(LAYOUT) && defined(KEYMAP))
 188 #define LAYOUT KEYMAP
 189 #endif
 190
 191 #define LAYOUT_ergodox_wrapper(...)          LAYOUT_ergodox(__VA_ARGS__)
 192 #define LAYOUT_ergodox_pretty_wrapper(...)   LAYOUT_ergodox_pretty(__VA_ARGS__)
 193 #define KEYMAP_wrapper(...)                  LAYOUT(__VA_ARGS__)
 194 #define LAYOUT_wrapper(...)                  LAYOUT(__VA_ARGS__)
 195 #define LAYOUT_ortho_4x12_wrapper(...)       LAYOUT_ortho_4x12(__VA_ARGS__)
 196
 197 // Blocks for each of the four major keyboard layouts
 198 // Organized so we can quickly adapt and modify all of them
 199 // at once, rather than for each keyboard, one at a time.
 200 // And this allows for much cleaner blocks in the keymaps.
 201 // For instance Tap/Hold for Control on all of the layouts
 202
 203 // NOTE: These are all the same length.  If you do a search/replace
 204 //       then you need to add/remove underscores to keep the
 205 //       lengths consistent.
 206
 207 #define _________________QWERTY_L1_________________        KC_Q,    KC_W,    KC_E,    KC_R,    KC_T
 208 #define _________________QWERTY_L2_________________        KC_A,    KC_S,    KC_D,    KC_F,    KC_G
 209 #define _________________QWERTY_L3_________________  CTL_T(KC_Z),   KC_X,    KC_C,    KC_V,    KC_B
 210
 211 #define _________________QWERTY_R1_________________        KC_Y,    KC_U,    KC_I,    KC_O,    KC_P
 212 #define _________________QWERTY_R2_________________        KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN
 213 #define _________________QWERTY_R3_________________        KC_N,    KC_M,    KC_COMM, KC_DOT,  CTL_T(KC_SLASH)
 214
 215
 216 #define _________________COLEMAK_L1________________       KC_Q,    KC_W,    KC_F,    KC_P,    KC_G
 217 #define _________________COLEMAK_L2________________       KC_A,    KC_R,    KC_S,    KC_T,    KC_D
 218 #define _________________COLEMAK_L3________________ CTL_T(KC_Z),   KC_X,    KC_C,    KC_V,    KC_B
 219
 220 #define _________________COLEMAK_R1________________       KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN
 221 #define _________________COLEMAK_R2________________       KC_H,    KC_N,    KC_E,    KC_I,    KC_O
 222 #define _________________COLEMAK_R3________________       KC_K,    KC_M,    KC_COMM, KC_DOT,  CTL_T(KC_SLASH)
 223
 224 #define ______________COLEMAK_MOD_DH_L1____________       KC_Q,    KC_W,    KC_F,    KC_P,    KC_B
 225 #define ______________COLEMAK_MOD_DH_L2____________       KC_A,    KC_R,    KC_S,    KC_T,    KC_G
 226 #define ______________COLEMAK_MOD_DH_L3____________ CTL_T(KC_Z),   KC_X,    KC_C,    KC_D,    KC_V
 227
 228 #define ______________COLEMAK_MOD_DH_R1____________       KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN
 229 #define ______________COLEMAK_MOD_DH_R2____________       KC_M,    KC_N,    KC_E,    KC_I,    KC_O
 230 #define ______________COLEMAK_MOD_DH_R3____________       KC_K,    KC_H,    KC_COMM, KC_DOT,  CTL_T(KC_SLASH)
 231
 232
 233 #define _________________DVORAK_L1_________________        KC_QUOT, KC_COMM, KC_DOT, KC_P,     KC_Y
 234 #define _________________DVORAK_L2_________________        KC_A,    KC_O,    KC_E,   KC_U,     KC_I
 235 #define _________________DVORAK_L3_________________  CTL_T(KC_SCLN),KC_Q,    KC_J,   KC_K,     KC_X
 236
 237 #define _________________DVORAK_R1_________________        KC_F,    KC_G,    KC_C,    KC_R,    KC_L
 238 #define _________________DVORAK_R2_________________        KC_D,    KC_H,    KC_T,    KC_N,    KC_S
 239 #define _________________DVORAK_R3_________________        KC_B,    KC_M,    KC_W,    KC_V,    CTL_T(KC_Z)
 240
 241
 242 #define _________________WORKMAN_L1________________       KC_Q,    KC_D,    KC_R,   KC_W,     KC_B
 243 #define _________________WORKMAN_L2________________       KC_A,    KC_S,    KC_H,   KC_T,     KC_G
 244 #define _________________WORKMAN_L3________________ CTL_T(KC_Z),   KC_X,    KC_M,   KC_C,     KC_V
 245
 246 #define _________________WORKMAN_R1________________       KC_J,    KC_F,    KC_U,    KC_P,    KC_SCLN
 247 #define _________________WORKMAN_R2________________       KC_Y,    KC_N,    KC_E,    KC_O,    KC_I
 248 #define _________________WORKMAN_R3________________       KC_K,    KC_L,    KC_COMM, KC_DOT,  CTL_T(KC_SLASH)
 249
 250
 251 #define _________________NORMAN_L1_________________       KC_Q,    KC_W,    KC_D,    KC_F,    KC_K
 252 #define _________________NORMAN_L2_________________       KC_A,    KC_S,    KC_E,    KC_T,    KC_G
 253 #define _________________NORMAN_L3_________________ CTL_T(KC_Z),   KC_X,    KC_C,    KC_V,    KC_B
 254
 255 #define _________________NORMAN_R1_________________       KC_J,    KC_U,    KC_R,    KC_L,    KC_SCLN
 256 #define _________________NORMAN_R2_________________       KC_Y,    KC_N,    KC_I,    KC_O,    KC_U
 257 #define _________________NORMAN_R3_________________       KC_P,    KC_M,    KC_COMM, KC_DOT,  CTL_T(KC_SLASH)
 258
 259
 260 #define _________________MALTRON_L1________________       KC_Q,    KC_P,    KC_Y,    KC_C,    KC_B
 261 #define _________________MALTRON_L2________________       KC_A,    KC_N,    KC_I,    KC_S,    KC_F
 262 #define _________________MALTRON_L3________________ CTL_T(KC_SCLN), KC_SLSH, KC_J    KC_G,    KC_COMM
 263
 264 #define _________________MALTRON_R1________________       KC_V,    KC_M,    KC_U,    KC_Z,    KC_L
 265 #define _________________MALTRON_R2________________       KC_D,    KC_T,    KC_D,    KC_O,    KC_R
 266 #define _________________MALTRON_R3________________       KC_DOT,  KC_W,    KC_K,    KC_MINS,  CTL_T(KC_x)
 267
 268
 269 #define _________________EUCALYN_L1________________       KC_SLSH, KC_COMM, KC_DOT,  KC_F,    KC_Q
 270 #define _________________EUCALYN_L2________________       KC_A,    KC_O,    KC_E,    KC_I,    KC_U
 271 #define _________________EUCALYN_L3________________ CTL_T(KC_Z),   KC_X,    KC_C,    KC_V,    KC_W
 272
 273 #define _________________EUCALYN_R1________________       KC_M,    KC_R,    KC_D,    KC_Y,    KC_P
 274 #define _________________EUCALYN_R2________________       KC_G,    KC_T,    KC_K,    KC_S,    KC_N
 275 #define _________________EUCALYN_R3________________       KC_B,    KC_H,    KC_J,    KC_L,    CTL_T(KC_SCLN)
 276
 277
 278 #define _____________CARPLAX_QFMLWY_L1_____________       KC_Q,    KC_F,    KC_M,    KC_L,    KC_W
 279 #define _____________CARPLAX_QFMLWY_L2_____________       KC_D,    KC_S,    KC_T,    KC_N,    KC_R
 280 #define _____________CARPLAX_QFMLWY_L3_____________ CTL_T(KC_Z),   KC_V,    KC_G,    KC_C,    KC_X
 281
 282 #define _____________CARPLAX_QFMLWY_R1_____________       KC_Y,    KC_U,    KC_O,    KC_B,    KC_J
 283 #define _____________CARPLAX_QFMLWY_R2_____________       KC_I,    KC_A,    KC_E,    KC_H,    KC_SCLN
 284 #define _____________CARPLAX_QFMLWY_R3_____________       KC_P,    KC_K,    KC_COMM, KC_DOT,  CTL_T(KC_SLSH)
 285
 286
 287 #define _____________CARPLAX_QGMLWB_L1_____________       KC_Q,    KC_G,    KC_M,    KC_L,    KC_W
 288 #define _____________CARPLAX_QGMLWB_L2_____________       KC_D,    KC_S,    KC_T,    KC_N,    KC_R
 289 #define _____________CARPLAX_QGMLWB_L3_____________ CTL_T(KC_Z),   KC_X,    KC_C,    KC_F,    KC_J
 290
 291 #define _____________CARPLAX_QGMLWB_R1_____________       KC_B,    KC_Y,    KC_U,    KC_V,    KC_SCLN
 292 #define _____________CARPLAX_QGMLWB_R2_____________       KC_I,    KC_A,    KC_E,    KC_O,    KC_H
 293 #define _____________CARPLAX_QGMLWB_R3_____________       KC_K,    KC_P,    KC_COMM, KC_DOT,  CTL_T(KC_SLSH)
 294
 295
 296 #define _____________CARPLAX_QGMLWY_L1_____________       KC_Q,    KC_G,    KC_M,    KC_L,    KC_W
 297 #define _____________CARPLAX_QGMLWY_L2_____________       KC_D,    KC_S,    KC_T,    KC_N,    KC_R
 298 #define _____________CARPLAX_QGMLWY_L3_____________ CTL_T(KC_Z),   KC_X,    KC_C,    KC_V,    KC_J
 299
 300 #define _____________CARPLAX_QGMLWY_R1_____________       KC_Y,    KC_F,    KC_U,    KC_B,    KC_SCLN
 301 #define _____________CARPLAX_QGMLWY_R2_____________       KC_I,    KC_A,    KC_E,    KC_O,    KC_H
 302 #define _____________CARPLAX_QGMLWY_R3_____________       KC_K,    KC_P,    KC_COMM, KC_DOT,  CTL_T(KC_SLSH)
 303
 304
 305 #define ________________NUMBER_LEFT________________       KC_1,    KC_2,    KC_3,    KC_4,    KC_5
 306 #define ________________NUMBER_RIGHT_______________       KC_6,    KC_7,    KC_8,    KC_9,    KC_0
 307 #define _________________FUNC_LEFT_________________       KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5
 308 #define _________________FUNC_RIGHT________________       KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10
 309
 310 #define ___________________BLANK___________________        _______, _______, _______, _______, _______
 311
 312
 313 #define _________________LOWER_L1__________________        KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC
 314 #define _________________LOWER_L2__________________        _________________FUNC_LEFT_________________
 315 #define _________________LOWER_L3__________________        _________________FUNC_RIGHT________________
 316
 317 #define _________________LOWER_R1__________________        KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN
 318 #define _________________LOWER_R2__________________        _______, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR
 319 #define _________________LOWER_R3__________________        _______, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT
 320
 321
 322
 323 #define _________________RAISE_L1__________________        ________________NUMBER_LEFT________________
 324 #define _________________RAISE_L2__________________        ___________________BLANK___________________
 325 #define _________________RAISE_L3__________________        ___________________BLANK___________________
 326
 327 #define _________________RAISE_R1__________________        ________________NUMBER_RIGHT_______________
 328 #define _________________RAISE_R2__________________        _______, KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC
 329 #define _________________RAISE_R3__________________        _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END
 330
 331
 332
 333 #define _________________ADJUST_L1_________________        RGB_MOD, RGB_HUI, RGB_SAI, RGB_VAI, RGB_TOG
 334 #define _________________ADJUST_L2_________________        MU_TOG , CK_TOGG, AU_ON,   AU_OFF,  AG_NORM
 335 #define _________________ADJUST_L3_________________        RGB_RMOD,RGB_HUD,RGB_SAD, RGB_VAD, KC_RGB_T
 336
 337 #define _________________ADJUST_R1_________________        KC_SEC1, KC_SEC2, KC_SEC3, KC_SEC4, KC_SEC5
 338 #define _________________ADJUST_R2_________________        AG_SWAP, QWERTY,  COLEMAK, DVORAK,  WORKMAN
 339 #define _________________ADJUST_R3_________________        MG_NKRO, KC_MUTE, KC_VOLD, KC_VOLU, KC_MNXT
 340
 341
 342 // Since we have 4 default layouts (QWERTY, DVORAK, COLEMAK and WORKMAN),
 343 // this allows us to quickly modify the bottom row for all of the layouts
 344 // so we don't have to alter it 4 times and hope that we haven't missed
 345 // anything
 346 #define ___________ERGODOX_BOTTOM_LEFT_____________       OSM(MOD_MEH), OSM(MOD_LGUI), KC_LBRC, KC_RBRC
 347 #define ___________ERGODOX_BOTTOM_RIGHT____________       KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT
 348
 349
 350 #define ___________ORTHODOX_THUMP_TOP_____________           ALT_APP, OS_LGUI,         KC_LALT, OS_RGUI
 351 #define ___________________ORTHODOX_THUMB_BOTTOM____________________ LOWER,   KC_SPACE,KC_BSPC,         KC_DEL,  KC_ENT,  RAISE
 352
 353
 354 #define __________________ERGODOX_THUMB_CLUSTER_____________________           ALT_T(KC_APP), OSM(MOD_LGUI),           OSM(MOD_RGUI), CTL_T(KC_ESCAPE), \
 355                                                                                               KC_HOME,                 KC_PGUP, \
 356                                                                 LT(_LOWER, KC_SPACE),KC_BSPC, KC_END,                  KC_PGDN, KC_DEL,  LT(_RAISE, KC_ENTER)
 357
 358