mh
/
qmk_firmware
mirror of https://github.com/qmk/qmk_firmware/


								/*

								Copyright 2017 Christopher Courtney <drashna@live.com> @drashna


								This program is free software: you can redistribute it and/or modify

								it under the terms of the GNU General Public License as published by

								the Free Software Foundation, either version 2 of the License, or

								(at your option) any later version.


								This program is distributed in the hope that it will be useful,

								but WITHOUT ANY WARRANTY; without even the implied warranty of

								MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

								GNU General Public License for more details.


								You should have received a copy of the GNU General Public License

								along with this program.  If not, see <http://www.gnu.org/licenses/>.

								*/


								#pragma once

								#include "quantum.h"

								#include "version.h"

								#include "eeprom.h"


								#ifdef RGB_MATRIX_ENABLE

								#include "rgb_matrix.h"

								#endif


								/* Define layer names */

								enum userspace_layers {

								  _QWERTY = 0,

								  _NUMLOCK = 0,

								  _COLEMAK,

								  _DVORAK,

								  _WORKMAN,

								  _MODS,

								  _GAMEPAD,

								  _DIABLO,

								  _MACROS,

								  _MEDIA,

								  _LOWER,

								  _RAISE,

								  _ADJUST,

								};


								/*

								define modifiers here, since MOD_* doesn't seem to work for these

								 */

								#define MODS_SHIFT_MASK  (MOD_BIT(KC_LSHIFT)|MOD_BIT(KC_RSHIFT))

								#define MODS_CTRL_MASK  (MOD_BIT(KC_LCTL)|MOD_BIT(KC_RCTRL))

								#define MODS_ALT_MASK  (MOD_BIT(KC_LALT)|MOD_BIT(KC_RALT))

								#define MODS_GUI_MASK  (MOD_BIT(KC_LGUI)|MOD_BIT(KC_RGUI))


								/*

								RGB color codes are no longer located here anymore.  Instead, you will want to

								head to https://github.com/qmk/qmk_firmware/blob/master/quantum/rgblight_list.h

								*/


								#ifdef RGBLIGHT_ENABLE

								void rgblight_sethsv_default_helper(uint8_t index);

								#endif // RGBLIGHT_ENABLE


								bool mod_key_press_timer (uint16_t code, uint16_t mod_code, bool pressed);

								bool mod_key_press (uint16_t code, uint16_t mod_code, bool pressed, uint16_t this_timer);


								typedef union {

								  uint32_t raw;

								  struct {

								    bool     rgb_layer_change :1;

								    bool     is_overwatch     :1;

								    bool     nuke_switch      :1;

								    uint8_t  unicode_mod      :4;

								  };

								} userspace_config_t;


								#if defined(KEYMAP_SAFE_RANGE)

								  #define PLACEHOLDER_SAFE_RANGE KEYMAP_SAFE_RANGE

								#else

								  #define PLACEHOLDER_SAFE_RANGE SAFE_RANGE

								#endif


								enum userspace_custom_keycodes {

								  EPRM = PLACEHOLDER_SAFE_RANGE, // Resets EEPROM do defaults (as in eeconfig_init)

								  VRSN,              // Prints QMK Firmware and board info

								  KC_QWERTY,         // Sets default layer to QWERTY

								  KC_COLEMAK,        // Sets default layer to COLEMAK

								  KC_DVORAK,         // Sets default layer to DVORAK

								  KC_WORKMAN,        // Sets default layer to WORKMAN

								  KC_DIABLO_CLEAR,   // Clears all Diablo Timers

								  KC_OVERWATCH,      // Toggles game macro input mode (so in OW, it defaults to game chat)

								  KC_SALT,           // See drashna.c for details

								  KC_MORESALT,

								  KC_SALTHARD,

								  KC_GOODGAME,

								  KC_SYMM,

								  KC_JUSTGAME,

								  KC_GLHF,

								  KC_TORB,

								  KC_AIM,

								  KC_C9,

								  KC_GGEZ,

								  KC_MAKE,           // Run keyboard's customized make command

								  KC_RGB_T,          // Toggles RGB Layer Indication mode

								  KC_SECRET_1,       // test1

								  KC_SECRET_2,       // test2

								  KC_SECRET_3,       // test3

								  KC_SECRET_4,       // test4

								  KC_SECRET_5,       // test5

								  KC_CCCV,           // Hold to copy, tap to paste

								  KC_NUKE,           // NUCLEAR LAUNCH DETECTED!!!

								  UC_FLIP,           // (ಠ痊ಠ)┻━┻

								  UC_TABL,           // ┬─┬ノ( º _ ºノ)

								  UC_SHRG,           // ¯\_(ツ)_/¯

								  UC_DISA,           // ಠ_ಠ

								  NEW_SAFE_RANGE     //use "NEWPLACEHOLDER for keymap specific codes

								};


								#define LOWER MO(_LOWER)

								#define RAISE MO(_RAISE)

								#define ADJUST MO(_ADJUST)

								#define TG_MODS TG(_MODS)

								#define TG_GAME TG(_GAMEPAD)


								#define KC_SEC1 KC_SECRET_1

								#define KC_SEC2 KC_SECRET_2

								#define KC_SEC3 KC_SECRET_3

								#define KC_SEC4 KC_SECRET_4

								#define KC_SEC5 KC_SECRET_5


								#define QWERTY KC_QWERTY

								#define DVORAK KC_DVORAK

								#define COLEMAK KC_COLEMAK

								#define WORKMAN KC_WORKMAN


								#define KC_RESET RESET

								#define KC_RST KC_RESET


								#ifdef SWAP_HANDS_ENABLE

								#define KC_C1R3 SH_TT

								#else // SWAP_HANDS_ENABLE

								#define KC_C1R3 KC_BSPC

								#endif // SWAP_HANDS_ENABLE


								#define BK_LWER LT(_LOWER, KC_BSPC)

								#define SP_LWER LT(_LOWER, KC_SPC)

								#define DL_RAIS LT(_RAISE, KC_DEL)

								#define ET_RAIS LT(_RAISE, KC_ENTER)


								/* OSM keycodes, to keep things clean and easy to change */

								#define KC_MLSF OSM(MOD_LSFT)

								#define KC_MRSF OSM(MOD_RSFT)


								#define OS_LGUI OSM(MOD_LGUI)

								#define OS_RGUI OSM(MOD_RGUI)

								#define OS_LSFT OSM(MOD_LSFT)

								#define OS_RSFT OSM(MOD_RSFT)

								#define OS_LCTL OSM(MOD_LCTL)

								#define OS_RCTL OSM(MOD_RCTL)

								#define OS_LALT OSM(MOD_LALT)

								#define OS_RALT OSM(MOD_RALT)

								#define ALT_APP ALT_T(KC_APP)


								#define MG_NKRO MAGIC_TOGGLE_NKRO


								#define UC_IRNY UC(0x2E2E)

								#define UC_CLUE UC(0x203D)


								#ifdef TAP_DANCE_ENABLE

								enum {

								  TD_D3_1 = 0,

								  TD_D3_2,

								  TD_D3_3,

								  TD_D3_4

								};

								#endif // TAP_DANCE_ENABLE


								/*

								Custom Keycodes for Diablo 3 layer

								But since TD() doesn't work when tap dance is disabled

								We use custom codes here, so we can substitute the right stuff

								*/

								#ifdef TAP_DANCE_ENABLE

								#define KC_D3_1 TD(TD_D3_1)

								#define KC_D3_2 TD(TD_D3_2)

								#define KC_D3_3 TD(TD_D3_3)

								#define KC_D3_4 TD(TD_D3_4)

								#else // TAP_DANCE_ENABLE

								#define KC_D3_1 KC_1

								#define KC_D3_2 KC_2

								#define KC_D3_3 KC_3

								#define KC_D3_4 KC_4

								#endif // TAP_DANCE_ENABLE


								/*

								Since our quirky block definitions are basically a list of comma separated

								arguments, we need a wrapper in order for these definitions to be

								expanded before being used as arguments to the LAYOUT_xxx macro.

								*/

								#if (!defined(LAYOUT) && defined(KEYMAP))

								#define LAYOUT KEYMAP

								#endif


								#define LAYOUT_ergodox_wrapper(...)          LAYOUT_ergodox(__VA_ARGS__)

								#define LAYOUT_ergodox_pretty_wrapper(...)   LAYOUT_ergodox_pretty(__VA_ARGS__)

								#define KEYMAP_wrapper(...)                  LAYOUT(__VA_ARGS__)

								#define LAYOUT_wrapper(...)                  LAYOUT(__VA_ARGS__)

								#define LAYOUT_ortho_4x12_wrapper(...)       LAYOUT_ortho_4x12(__VA_ARGS__)


								/*

								Blocks for each of the four major keyboard layouts

								Organized so we can quickly adapt and modify all of them

								at once, rather than for each keyboard, one at a time.

								And this allows for much cleaner blocks in the keymaps.

								For instance Tap/Hold for Control on all of the layouts


								NOTE: These are all the same length.  If you do a search/replace

								  then you need to add/remove underscores to keep the

								  lengths consistent.

								*/


								#define _________________QWERTY_L1_________________        KC_Q,    KC_W,    KC_E,    KC_R,    KC_T

								#define _________________QWERTY_L2_________________        KC_A,    KC_S,    KC_D,    KC_F,    KC_G

								#define _________________QWERTY_L3_________________        KC_Z,    KC_X,    KC_C,    KC_V,    KC_B


								#define _________________QWERTY_R1_________________        KC_Y,    KC_U,    KC_I,    KC_O,    KC_P

								#define _________________QWERTY_R2_________________        KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN

								#define _________________QWERTY_R3_________________        KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLASH


								#define _________________COLEMAK_L1________________       KC_Q,    KC_W,    KC_F,    KC_P,    KC_G

								#define _________________COLEMAK_L2________________       KC_A,    KC_R,    KC_S,    KC_T,    KC_D

								#define _________________COLEMAK_L3________________       KC_Z,    KC_X,    KC_C,    KC_V,    KC_B


								#define _________________COLEMAK_R1________________       KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN

								#define _________________COLEMAK_R2________________       KC_H,    KC_N,    KC_E,    KC_I,    KC_O

								#define _________________COLEMAK_R3________________       KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLASH


								#define ______________COLEMAK_MOD_DH_L1____________       KC_Q,    KC_W,    KC_F,    KC_P,    KC_B

								#define ______________COLEMAK_MOD_DH_L2____________       KC_A,    KC_R,    KC_S,    KC_T,    KC_G

								#define ______________COLEMAK_MOD_DH_L3____________       KC_Z,    KC_X,    KC_C,    KC_D,    KC_V


								#define ______________COLEMAK_MOD_DH_R1____________       KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN

								#define ______________COLEMAK_MOD_DH_R2____________       KC_M,    KC_N,    KC_E,    KC_I,    KC_O

								#define ______________COLEMAK_MOD_DH_R3____________       KC_K,    KC_H,    KC_COMM, KC_DOT,  KC_SLASH


								#define _________________DVORAK_L1_________________        KC_QUOT, KC_COMM, KC_DOT, KC_P,     KC_Y

								#define _________________DVORAK_L2_________________        KC_A,    KC_O,    KC_E,   KC_U,     KC_I

								#define _________________DVORAK_L3_________________        KC_SCLN, KC_Q,    KC_J,   KC_K,     KC_X


								#define _________________DVORAK_R1_________________        KC_F,    KC_G,    KC_C,    KC_R,    KC_L

								#define _________________DVORAK_R2_________________        KC_D,    KC_H,    KC_T,    KC_N,    KC_S

								#define _________________DVORAK_R3_________________        KC_B,    KC_M,    KC_W,    KC_V,    KC_Z


								#define _________________WORKMAN_L1________________       KC_Q,    KC_D,    KC_R,   KC_W,     KC_B

								#define _________________WORKMAN_L2________________       KC_A,    KC_S,    KC_H,   KC_T,     KC_G

								#define _________________WORKMAN_L3________________       KC_Z,    KC_X,    KC_M,   KC_C,     KC_V


								#define _________________WORKMAN_R1________________       KC_J,    KC_F,    KC_U,    KC_P,    KC_SCLN

								#define _________________WORKMAN_R2________________       KC_Y,    KC_N,    KC_E,    KC_O,    KC_I

								#define _________________WORKMAN_R3________________       KC_K,    KC_L,    KC_COMM, KC_DOT,  KC_SLASH


								#define _________________NORMAN_L1_________________       KC_Q,    KC_W,    KC_D,    KC_F,    KC_K

								#define _________________NORMAN_L2_________________       KC_A,    KC_S,    KC_E,    KC_T,    KC_G

								#define _________________NORMAN_L3_________________       KC_Z,    KC_X,    KC_C,    KC_V,    KC_B


								#define _________________NORMAN_R1_________________       KC_J,    KC_U,    KC_R,    KC_L,    KC_SCLN

								#define _________________NORMAN_R2_________________       KC_Y,    KC_N,    KC_I,    KC_O,    KC_U

								#define _________________NORMAN_R3_________________       KC_P,    KC_M,    KC_COMM, KC_DOT,  KC_SLASH


								#define _________________MALTRON_L1________________       KC_Q,    KC_P,    KC_Y,    KC_C,    KC_B

								#define _________________MALTRON_L2________________       KC_A,    KC_N,    KC_I,    KC_S,    KC_F

								#define _________________MALTRON_L3________________       KC_SCLN, KC_SLSH, KC_J     KC_G,    KC_COMM


								#define _________________MALTRON_R1________________       KC_V,    KC_M,    KC_U,    KC_Z,    KC_L

								#define _________________MALTRON_R2________________       KC_D,    KC_T,    KC_D,    KC_O,    KC_R

								#define _________________MALTRON_R3________________       KC_DOT,  KC_W,    KC_K,    KC_MINS,  KC_X


								#define _________________EUCALYN_L1________________       KC_SLSH, KC_COMM, KC_DOT,  KC_F,    KC_Q

								#define _________________EUCALYN_L2________________       KC_A,    KC_O,    KC_E,    KC_I,    KC_U

								#define _________________EUCALYN_L3________________       KC_Z,    KC_X,    KC_C,    KC_V,    KC_W


								#define _________________EUCALYN_R1________________       KC_M,    KC_R,    KC_D,    KC_Y,    KC_P

								#define _________________EUCALYN_R2________________       KC_G,    KC_T,    KC_K,    KC_S,    KC_N

								#define _________________EUCALYN_R3________________       KC_B,    KC_H,    KC_J,    KC_L,    KC_SCLN


								#define _____________CARPLAX_QFMLWY_L1_____________       KC_Q,    KC_F,    KC_M,    KC_L,    KC_W

								#define _____________CARPLAX_QFMLWY_L2_____________       KC_D,    KC_S,    KC_T,    KC_N,    KC_R

								#define _____________CARPLAX_QFMLWY_L3_____________       KC_Z,    KC_V,    KC_G,    KC_C,    KC_X


								#define _____________CARPLAX_QFMLWY_R1_____________       KC_Y,    KC_U,    KC_O,    KC_B,    KC_J

								#define _____________CARPLAX_QFMLWY_R2_____________       KC_I,    KC_A,    KC_E,    KC_H,    KC_SCLN

								#define _____________CARPLAX_QFMLWY_R3_____________       KC_P,    KC_K,    KC_COMM, KC_DOT,  KC_SLSH


								#define _____________CARPLAX_QGMLWB_L1_____________       KC_Q,    KC_G,    KC_M,    KC_L,    KC_W

								#define _____________CARPLAX_QGMLWB_L2_____________       KC_D,    KC_S,    KC_T,    KC_N,    KC_R

								#define _____________CARPLAX_QGMLWB_L3_____________       KC_Z,   KC_X,    KC_C,    KC_F,    KC_J


								#define _____________CARPLAX_QGMLWB_R1_____________       KC_B,    KC_Y,    KC_U,    KC_V,    KC_SCLN

								#define _____________CARPLAX_QGMLWB_R2_____________       KC_I,    KC_A,    KC_E,    KC_O,    KC_H

								#define _____________CARPLAX_QGMLWB_R3_____________       KC_K,    KC_P,    KC_COMM, KC_DOT,  KC_SLSH


								#define _____________CARPLAX_QGMLWY_L1_____________       KC_Q,    KC_G,    KC_M,    KC_L,    KC_W

								#define _____________CARPLAX_QGMLWY_L2_____________       KC_D,    KC_S,    KC_T,    KC_N,    KC_R

								#define _____________CARPLAX_QGMLWY_L3_____________       KC_Z,   KC_X,    KC_C,    KC_V,    KC_J


								#define _____________CARPLAX_QGMLWY_R1_____________       KC_Y,    KC_F,    KC_U,    KC_B,    KC_SCLN

								#define _____________CARPLAX_QGMLWY_R2_____________       KC_I,    KC_A,    KC_E,    KC_O,    KC_H

								#define _____________CARPLAX_QGMLWY_R3_____________       KC_K,    KC_P,    KC_COMM, KC_DOT,  KC_SLSH


								#define ________________NUMBER_LEFT________________       KC_1,    KC_2,    KC_3,    KC_4,    KC_5

								#define ________________NUMBER_RIGHT_______________       KC_6,    KC_7,    KC_8,    KC_9,    KC_0

								#define _________________FUNC_LEFT_________________       KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5

								#define _________________FUNC_RIGHT________________       KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10


								#define ___________________BLANK___________________        _______, _______, _______, _______, _______


								#define _________________LOWER_L1__________________        KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC

								#define _________________LOWER_L2__________________        _________________FUNC_LEFT_________________

								#define _________________LOWER_L3__________________        _________________FUNC_RIGHT________________


								#define _________________LOWER_R1__________________        KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN

								#define _________________LOWER_R2__________________        _______, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR

								#define _________________LOWER_R3__________________        _______, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT


								#define _________________RAISE_L1__________________        ________________NUMBER_LEFT________________

								#define _________________RAISE_L2__________________        ___________________BLANK___________________

								#define _________________RAISE_L3__________________        ___________________BLANK___________________


								#define _________________RAISE_R1__________________        ________________NUMBER_RIGHT_______________

								#define _________________RAISE_R2__________________        _______, KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC

								#define _________________RAISE_R3__________________        _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END


								#define _________________ADJUST_L1_________________        RGB_MOD, RGB_HUI, RGB_SAI, RGB_VAI, RGB_TOG

								#define _________________ADJUST_L2_________________        MU_TOG , CK_TOGG, AU_ON,   AU_OFF,  AG_NORM

								#define _________________ADJUST_L3_________________        RGB_RMOD,RGB_HUD,RGB_SAD, RGB_VAD, KC_RGB_T


								#define _________________ADJUST_R1_________________        KC_SEC1, KC_SEC2, KC_SEC3, KC_SEC4, KC_SEC5

								#define _________________ADJUST_R2_________________        AG_SWAP, QWERTY,  COLEMAK, DVORAK,  WORKMAN

								#define _________________ADJUST_R3_________________        MG_NKRO, KC_MUTE, KC_VOLD, KC_VOLU, KC_MNXT