]> git.donarmstrong.com Git - qmk_firmware.git/blob - users/wanleg/wanleg.h
[Keyboard] Snagpad Configurator bugfix and readme refactor (#6381)
[qmk_firmware.git] / users / wanleg / wanleg.h
1 #pragma once
2
3 #include "quantum.h"
4
5 // Define layer names and order
6 #if defined(KEYBOARD_40percentclub_gherkin) || defined(KEYBOARD_kbdfans_kbd6x)
7 enum userspace_layers {
8   gGK = 0,
9   gNUM,
10   gDIR,
11   gETC,
12   _GK,
13   _QW,
14   ONE,
15   SUB,
16   SUP,
17   NUM,
18   DIR,
19   ETC,
20   _FN,
21   PAD,
22   GK50,
23 };
24 #elif KEYBOARD_40percentclub_5x5
25 enum userspace_layers {
26   GK50 = 0,
27   _GK,
28   _QW,
29   PAD,
30   gNUM,
31   gDIR,
32   gETC,
33   gGK,
34   ONE,
35   SUB,
36   SUP,
37   NUM,
38   DIR,
39   ETC,
40   _FN,
41 };
42 #else
43   enum userspace_layers {
44   _GK = 0,
45   _QW,
46   PAD,
47   ONE,
48   SUB,
49   SUP,
50   NUM,
51   DIR,
52   ETC,
53   gGK,
54   gNUM,
55   gDIR,
56   gETC,
57   _FN,
58   GK50,
59 };
60 #endif
61
62 enum userspace_custom_keycodes {
63   gGHERKIN = SAFE_RANGE,
64   GHERKIN,
65   QWERTY,
66   ONEHAND,
67   SUBTER,
68   SUPRA,
69   NUMBER,
70   DIRECTION,
71   ETCETERA,
72   gNUMBER,
73   gDIRECTION,
74   gETCETERA,
75   FUNCTION,
76   NUMPAD,
77   GHERKIN50,
78
79 };
80
81 //Tap Dance Declarations (list of my tap dance configurations)
82 #ifdef TAP_DANCE_ENABLE
83 enum {
84   TD_SFT_CAPS = 0
85   ,TD_Q_ESC
86   ,CAD_TD
87   ,RST_TAP_DANCE
88   ,LYR_TAP_DANCE
89   ,LYR50_TAP_DANCE
90   ,LYR75_TAP_DANCE
91   ,BSW_TAP_DANCE
92 };
93 #endif
94
95 // Since our quirky block definitions are basically a list of comma separated
96 // arguments, we need a wrapper in order for these definitions to be
97 // expanded before being used as arguments to the LAYOUT_xxx macro.
98 #if (!defined(LAYOUT) && defined(KEYMAP))
99 #define LAYOUT KEYMAP
100 #endif
101
102 #define KEYMAP_wrapper(...)                  LAYOUT(__VA_ARGS__)
103 #define LAYOUT_wrapper(...)                  LAYOUT(__VA_ARGS__)
104 #define LAYOUT_ortho_3x10_wrapper(...)       LAYOUT_ortho_3x10(__VA_ARGS__)
105 #define LAYOUT_ortho_4x4_wrapper(...)        LAYOUT_ortho_4x4(__VA_ARGS__)
106 #define LAYOUT_ortho_4x12_wrapper(...)       LAYOUT_ortho_4x12(__VA_ARGS__)
107 #define LAYOUT_ortho_5x5_wrapper(...)        LAYOUT_ortho_5x5(__VA_ARGS__)
108 #define LAYOUT_ortho_5x10_wrapper(...)       LAYOUT_ortho_5x10(__VA_ARGS__)
109 #define LAYOUT_ortho_5x15_wrapper(...)       LAYOUT_ortho_5x15(__VA_ARGS__)
110
111 // Blocks for each of the major keyboard layouts
112 // Organized so we can quickly adapt and modify all of them
113 // at once, rather than for each keyboard, one at a time.
114 // And this allows for much cleaner blocks in the keymaps.
115
116 // NOTE: These are all the same length.  If you do a search/replace
117 //       then you need to add/remove underscores to keep the
118 //       lengths consistent.
119
120
121 /* Gherkin
122  * .-----------------------------------------------------------------------------------------.
123  * | Q//ESC | W      | E      | R      | T      | Y      | U      | I      | O      | P      |
124  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
125  * | A      | S      | D      | F      | G      | H      | J      | K      | L      | SPACE  |
126  * |        |        |        |        |        |        |        |        |        |SFThold |
127  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
128  * | Z      | X      | C      | V/gNUM | B/gETC |  N/Fn  | M/gDIR | ,/GUI  | ./ALT  | BSPC   |
129  * | SFThold|        |        |        |        |        |        |        |        |CTRLhold|
130  * '-----------------------------------------------------------------------------------------'
131  */
132 #define _______________Gherkin_Row_0_______________                     TD(TD_Q_ESC),   KC_W,   KC_E,   KC_R,                   KC_T,                   KC_Y,   KC_U,                   KC_I,                   KC_O,                   KC_P
133 #define _______________Gherkin_Row_1_______________                     KC_A,                   KC_S,   KC_D,   KC_F,                   KC_G,                   KC_H,   KC_J,                   KC_K,                   KC_L,                   SFT_T(KC_SPC)
134 #define _______________Gherkin_Row_2_______________                     SFT_T(KC_Z),    KC_X,   KC_C,   LT(gNUM,KC_V),  LT(gETC,KC_B),  LT(_FN,KC_N),   LT(gDIR,KC_M),  GUI_T(KC_COMM), ALT_T(KC_DOT),  CTL_T(KC_BSPC)
135
136 /* Gherkin Directional Keys
137  * .-----------------------------------------------------------------------------------------.
138  * | TAB    |   up   |        | INS    |  CTRL  | SHIFT  | PgUp   | HOME   |  -     |  =     |
139  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
140  * | left   |  down  | right  | PrScr  | SHIFT  |  CTRL  | PgDn   | END    |  [     |  ]     |
141  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
142  * | P-Brk  |        |        |        |        |        |        | RGUI   | ALT    |  /     |
143  * '-----------------------------------------------------------------------------------------'
144  */
145 #define _______________Gherkin_DIR_0_______________                     KC_TAB,  KC_UP,   _______, KC_INS,  KC_LCTL, KC_RSFT, KC_PGUP, KC_HOME, KC_MINS, KC_EQL
146 #define _______________Gherkin_DIR_1_______________                     KC_LEFT, KC_DOWN, KC_RGHT, KC_PSCR, KC_LSFT, KC_RCTL, KC_PGDN, KC_END,  KC_LBRC, KC_RBRC
147 #define _______________Gherkin_DIR_2_______________                     KC_PAUS, _______, _______, _______, _______, _______, _______, KC_RGUI, KC_LALT, KC_SLSH
148
149 /* Gherkin Numbers
150  * .-----------------------------------------------------------------------------------------.
151  * | F1     | F2     | F3     | F4     | F5     | F6     | F7     | F8     | F9     | F10    |
152  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
153  * | 1      | 2      | 3      | 4      | 5      | 6      | 7      | 8      | 9      | 0      |
154  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
155  * | F11    | F12    |        |        |        | ENTER  | SHIFT  | GUI    | ./ALT  | BSPC   |
156  * |        |        |        |        |        |        |        |        |        |CTRLhold|
157  * '-----------------------------------------------------------------------------------------'
158  */
159 #define _______________Gherkin_NUM_0_______________                     KC_F1,  KC_F2,  KC_F3,  KC_F4,   KC_F5,   KC_F6,  KC_F7,   KC_F8,   KC_F9,         KC_F10
160 #define _______________Gherkin_NUM_1_______________                     KC_1,   KC_2,   KC_3,   KC_4,    KC_5,    KC_6,   KC_7,    KC_8,    KC_9,          KC_0
161 #define _______________Gherkin_NUM_2_______________                     KC_F11, KC_F12, _______,_______, _______, KC_ENT, KC_RSFT, KC_RGUI, ALT_T(KC_DOT), CTL_T(KC_BSPC)
162
163 /* Gherkin Et Cetera
164  * .-----------------------------------------------------------------------------------------.
165  * |  `     | mUP    |        |   ESC  | RESET  | SHIFT  | mScrDn | mScrUp |        |  \     |
166  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
167  * | mLeft  | mDown  | mRight |        | SHIFT  | mBtn3  | mBtn1  | mBtn2  |  ;     |  '     |
168  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
169  * | Sft//Cp| CAPS   |        |        |        | C-A-D  | mScrL  | mScrR  | ALT    |  DEL   |
170  * '-----------------------------------------------------------------------------------------'
171  */
172 #define _______________Gherkin_ETC_0_______________                     KC_GRV,                 KC_MS_U, _______,KC_ESC,  RESET,   KC_RSFT,                     KC_WH_D, KC_WH_U, _______, KC_BSLS
173 #define _______________Gherkin_ETC_1_______________                     KC_MS_L,                KC_MS_D, KC_MS_R,_______, KC_LSFT, KC_BTN3,                     KC_BTN1, KC_BTN2, KC_SCLN, KC_QUOT
174 #define _______________Gherkin_ETC_2_______________                     TD(TD_SFT_CAPS),KC_CAPS, _______,_______, _______, LALT(LCTL(KC_DEL)),  KC_WH_L, KC_WH_R, KC_LALT, KC_DEL
175
176 /* Gherkin-Like
177  * .-----------------------------------------------------------------------------------------------------------.
178  * | ESC    | Q//ESC | W      | E      | R      | T      | Y      | U      | I      | O      | P      | BSPC   |
179  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
180  * | TAB    | A      | S      | D      | F      | G      | H      | J      | K      | L      | SPACE  |  '     |
181  * |        |        |        |        |        |        |        |        |        |        |SFThold |        |
182  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
183  * |SFT/CAPS| Z      | X      | C      | V/NUM  | B/ETC  | N/Fn   | M/DIR  | ,/GUI  | ./ALT  | BSPC   | ENT/SFT|
184  * |        |SFThold |        |        |        |        |        |        |        |        |CTRLhold|        |
185  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
186  * | LCTRL  | LGUI   | ALT    | ONEHAND|  NUM   | ETC    | SPACE  |  DIR   | RGUI   | ALT    | DEL    | CTRL   |
187  * '-----------------------------------------------------------------------------------------------------------'
188  */
189 #define _______________GherkinLike_0_______________     KC_ESC, _______________Gherkin_Row_0_______________, KC_BSPC
190 #define _______________GherkinLike_1_______________     KC_TAB, _______________Gherkin_Row_1_______________, KC_QUOT
191 #define _______________GherkinLike_2_______________     TD(TD_SFT_CAPS), SFT_T(KC_Z), KC_X, KC_C, LT(NUM, KC_V),LT(ETC, KC_B),LT(_FN,KC_N), LT(DIR, KC_M), GUI_T(KC_COMM), ALT_T(KC_DOT), CTL_T(KC_BSPC), SFT_T(KC_ENT)
192 #define _______________GherkinLike_3_______________     KC_LCTL, KC_LGUI, KC_LALT, KC_LALT, NUMBER, ETCETERA, KC_SPC,DIRECTION, KC_RGUI, KC_RALT, KC_DEL, KC_RCTL
193 #define _______________GherkinLike_3_OneHand_______     KC_LCTL, KC_LGUI, KC_LALT, ONEHAND, NUMBER, ETCETERA, KC_SPC,DIRECTION, KC_RGUI, KC_RALT, ONEHAND, KC_RCTL
194
195 /* Qwerty
196  * .-------------------------------------------------------------------------------------.
197  * | Esc   |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | BSPC  |
198  * |-------+------+------+------+------+-------------+------+------+------+------+-------|
199  * | Tab   |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  '    |
200  * |-------+------+------+------+------+------|------+------+------+------+------+-------|
201  * |Sft/Cps|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |ENT/SFT|
202  * |-------+------+------+------+------+------+------+------+------+------+------+-------|
203  * | LCTRL | LGUI | ALT  | ALT  | SUB  | SHIFT| SPACE| SUP  | RGUI | RALT | DEL  | CTRL  |
204  * '-------------------------------------------------------------------------------------'
205  */
206 #define _______________Qwerty_Row__0_______________   KC_ESC,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC
207 #define _______________Qwerty_Row__1_______________   KC_TAB,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT
208 #define _______________Qwerty_Row__2_______________   TD(TD_SFT_CAPS),  KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, SFT_T(KC_ENT)
209 #define _______________Qwerty_Row__3_______________   KC_LCTL, KC_LGUI, KC_LALT, KC_LALT, SUBTER,  KC_LSFT, KC_SPC,  SUPRA,   KC_RGUI, KC_RALT, KC_DEL,  KC_RCTL
210
211 /* SUPRA
212  * .-----------------------------------------------------------------------------------------------------------.
213  * | RESET  | TAB    |   up   |        | INS    | CTRL   | SHIFT  | PgUp   | Home   |   -    |   =    |  DEL   |
214  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
215  * |        |  left  |  down  | right  | PrScr  | SHIFT  | CTRL   | PgDn   | End    |   [    |   ]    |   \    |
216  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
217  * |        | P-Brk  |        |        |        |        |        |        | RGUI   | ALT    |        |        |
218  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
219  * |        |        |        |        |        |        |        |        |        |        |        |        |
220  * '-----------------------------------------------------------------------------------------------------------'
221  */
222 #define ________________SUPRA_Row_0________________   RESET,   KC_TAB,  KC_UP,   _______, KC_INS,  KC_LCTL, KC_RSFT, KC_PGUP, KC_HOME, KC_MINS, KC_EQL,  KC_DEL
223 #define ________________SUPRA_Row_1________________   _______, KC_LEFT, KC_DOWN, KC_RGHT, KC_PSCR, KC_LSFT, KC_RCTL, KC_PGDN, KC_END,  KC_LBRC, KC_RBRC, KC_BSLS
224 #define ________________SUPRA_Row_2________________   _______, KC_PAUS, _______, _______, _______, _______, _______, _______, KC_RGUI, KC_RALT, _______, _______
225 #define ________________SUPRA_Row_3________________   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
226
227 /* SUBTER
228  * .-----------------------------------------------------------------------------------------------------------.
229  * |        | F1     | F2     | F3     | F4     | F5     | F6     | F7     | F8     | F9     | F10    |  DEL   |
230  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
231  * |    `   | 1      | 2      | 3      | 4      | 5      | 6      | 7      | 8      | 9      | 0      |        |
232  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
233  * |        | F11    | F12    |        |        |        |        |        | RGUI   | ./ALT  | BSPC   |        |
234  * |        |        |        |        |        |        |        |        |        |        |CTRLhold|        |
235  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
236  * |        |        | gherkin|        |        |        | ENTER  | SHIFT  |        |        |        |        |
237  * '-----------------------------------------------------------------------------------------------------------'
238  */
239 #define _______________SUBTER_Row__0_______________   _______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,    KC_F8,  KC_F9,                   KC_F10,                 KC_DEL
240 #define _______________SUBTER_Row__1_______________   KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,     KC_8,   KC_9,                    KC_0,                   _______
241 #define _______________SUBTER_Row__2_______________   _______, KC_F11,  KC_F12,  _______, _______, _______, _______, _______,  KC_RGUI,ALT_T(KC_DOT),   CTL_T(KC_BSPC), _______
242 #define _______________SUBTER_Row__3_______________   _______, _______, GHERKIN, _______, _______, _______, KC_ENT,  KC_LSFT,  _______,_______,                 _______,                _______
243
244 /* Gherkin-Like Numbers
245  * .-----------------------------------------------------------------------------------------------------------.
246  * |        | F1     | F2     | F3     | F4     | F5     | F6     | F7     | F8     | F9     | F10    | BSPC |
247  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
248  * |        | 1      | 2      | 3      | 4      | 5      | 6      | 7      | 8      | 9      | 0      |        |
249  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
250  * |        | F11    | F12    |        |        |        | ENTER  | SHIFT  | RGUI   | ./ALT  | BSPC   |        |
251  * |        |        |        |        |        |        |        |        |        |        |CTRLhold|            |
252  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
253  * |        |        |        |        |        |        | ENTER  | SHIFT  | RGUI   |        |        |        |
254  * '-----------------------------------------------------------------------------------------------------------'
255  */
256 #define _______________NUMBERS_Row_0_______________   _______, _______________Gherkin_NUM_0_______________,  KC_BSPC
257 #define _______________NUMBERS_Row_1_______________   _______, _______________Gherkin_NUM_1_______________,  _______
258 #define _______________NUMBERS_Row_2_______________   _______, _______________Gherkin_NUM_2_______________,  _______
259 #define _______________NUMBERS_Row_3_______________   _______, _______, _______, _______, _______, _______, KC_ENT, KC_RSFT, KC_RGUI, _______, _______, _______
260
261
262 /* Gherkin-Like Directional Keys
263  * .-----------------------------------------------------------------------------------------------------------.
264  * |        | TAB    |   up   |        | INS    | CTRL   | SHIFT  | PgUp   | HOME   |  -     |  =     | DEL    |
265  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
266  * |        | left   |  down  | right  | PrScr  | SHIFT  | CTRL   | PgDn   | END    |  [     |  ]     |        |
267  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
268  * |        | P-Brk  |        |        |        |        |        |        | RGUI   | ALT    |  /     |        |
269  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
270  * |        |        | qwerty |        |        |        |        |        |        |        |        |        |
271  * '-----------------------------------------------------------------------------------------------------------'
272  */
273 #define _____________DIRECTIONS_Row__0_____________   _______, _______________Gherkin_DIR_0_______________, KC_DEL
274 #define _____________DIRECTIONS_Row__1_____________   _______, _______________Gherkin_DIR_1_______________, _______
275 #define _____________DIRECTIONS_Row__2_____________   _______, _______________Gherkin_DIR_2_______________, _______
276 #define _____________DIRECTIONS_Row__3_____________   _______, _______, QWERTY, _______, _______, _______, _______, _______, _______, _______, _______, _______
277
278 /* Gherkin-Like Et Cetera
279  * .-----------------------------------------------------------------------------------------------------------.
280  * |        |  `     | mUP    |        |        | RESET  | SHIFT  | mScrDn | mScrUp |        |  \     | DEL    |
281  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
282  * |        | mLeft  | mDown  | mRight |        | SHIFT  | mBtn3  | mBtn1  | mBtn2  |  ;     |  '     |        |
283  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
284  * |        | Sft//Cp|        |        |        |        | C-A-D  |mScrLeft| mScrRt | ALT    |  DEL   |        |
285  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
286  * |        |        |        |        |        |        | C-A-D  |        |        |        |        |        |
287  * '-----------------------------------------------------------------------------------------------------------'
288  */
289 #define ______________ETCETERA_Row__0______________   _______, _______________Gherkin_ETC_0_______________, KC_DEL
290 #define ______________ETCETERA_Row__1______________   _______, _______________Gherkin_ETC_1_______________, _______
291 #define ______________ETCETERA_Row__2______________   _______, _______________Gherkin_ETC_2_______________, _______
292 #define ______________ETCETERA_Row__3______________   _______, _______, _______, _______, _______, _______, LALT(LCTL(KC_DEL)), _______, _______, _______, _______, _______
293
294 /* Single 4x4 board only
295  * .-----------------------------------.
296  * |   7    |   8    |   9    |  BSPC  |
297  * |--------+--------+--------+--------|
298  * |   4    |   5    |   6    | SPACE  |
299  * |--------+--------+--------+--------|
300  * |   1    |   2    |   3    | ENTER  |
301  * |--------+--------+--------+--------|
302  * |   0    |/ //_GK |   .    |   -    |
303  * '-----------------------------------'
304  */
305
306 #define _______________NUMPAD_Row__0_______________  KC_KP_7, KC_KP_8, KC_KP_9,   KC_BSPC
307 #define _______________NUMPAD_Row__1_______________  KC_KP_4, KC_KP_5, KC_KP_6,   KC_SPC
308 #define _______________NUMPAD_Row__2_______________  KC_KP_1, KC_KP_2, KC_KP_3,   KC_PENT
309 #define _______________NUMPAD_Row__3_______________  KC_KP_0, TD(LYR_TAP_DANCE), KC_KP_DOT, KC_PMNS
310
311 /* Gherkin FN/Lighting
312  * .-----------------------------------------------------------------------------------------------------.
313  * | BL_breathe | BL_brite- | BL_brite+ | BL_toggle | BL_briteCyc | BL_briteMax |     |     |     |      |
314  * |------------+-----------+-----------+-----------+-------------+-------------+-----+-----+-----+------|
315  * | UG_breathe | UG_brite- | UG_brite+ | UG_toggle | UG_modeCycle|             |     |     |     |      |
316  * |------------+-----------+-----------+-----------+-------------+-------------+-----+-----+-----+------|
317  * |  UG_hue-   | UG_hue+   |  UG_sat-  |  UG_sat+  |             |             |     |     |     |QWERTY|
318  * '-----------------------------------------------------------------------------------------------------'
319  */
320 #define _______________Gherkin_FN_0________________                     BL_BRTG, BL_DEC,  BL_INC,  BL_TOGG, BL_STEP, BL_ON,   _______, _______, _______, _______
321 #define _______________Gherkin_FN_1________________                     RGB_M_B, RGB_VAD, RGB_VAI, RGB_TOG, RGB_MOD, _______, _______, _______, _______, _______
322 #define _______________Gherkin_FN_2________________                     RGB_HUD, RGB_HUI, RGB_SAD, RGB_SAI, _______, _______, _______, _______, _______, QWERTY