Merge remote-tracking branch 'origin/master' into develop

9 files changed, 804 insertions, 0 deletions

diff --git a/users/jjerrell/.gitignore b/users/jjerrell/.gitignore
new file mode 100644
index 0000000000..1753bf931b
--- /dev/null
+++ b/users/jjerrell/.gitignore
@@ -0,0 +1 @@
+secrets.*
diff --git a/users/jjerrell/config.h b/users/jjerrell/config.h
new file mode 100644
index 0000000000..bddafe1557
--- /dev/null
+++ b/users/jjerrell/config.h
@@ -0,0 +1,26 @@
+// Copyright (C) 2021 Jerrell, Jacob <@jjerrell>
+// 
+// This file is part of jjerrell.
+// 
+// jjerrell 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 3 of the License, or
+// (at your option) any later version.
+// 
+// jjerrell 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 jjerrell.  If not, see <http://www.gnu.org/licenses/>.
+
+#pragma once
+
+#define LEADER_TIMEOUT 250
+#define LEADER_PER_KEY_TIMING
+
+#if defined(TAP_CODE_DELAY)
+#    undef TAP_CODE_DELAY
+#endif
+#define TAP_CODE_DELAY 20
diff --git a/users/jjerrell/jjerrell.c b/users/jjerrell/jjerrell.c
new file mode 100644
index 0000000000..95c2acba5e
--- /dev/null
+++ b/users/jjerrell/jjerrell.c
@@ -0,0 +1,138 @@
+/**
+ * Copyright (C) 2021 Jerrell, Jacob <@jjerrell>
+ * 
+ * This file is part of qmk_firmware.
+ * 
+ * qmk_firmware 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 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * qmk_firmware 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 qmk_firmware.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "jjerrell.h"
+
+__attribute__((weak)) void matrix_scan_keymap(void) {}
+__attribute__((weak)) void leader_scan_secrets(void) {}
+
+#ifdef LEADER_ENABLE
+    LEADER_EXTERNS();
+    void matrix_scan_leader(void) {
+        static uint8_t mods = 0;
+        mods = get_mods();
+        LEADER_DICTIONARY() {
+            leading = false;
+            leader_end();
+            clear_mods();
+
+            // Website Refresh / XCode "Run"
+            SEQ_ONE_KEY(KC_R) {
+                SEND_STRING(SS_LGUI("r"));
+            }
+
+            SEQ_TWO_KEYS(KC_B, KC_D) {
+                send_string_with_delay_P(PSTR(QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION " Built at: " QMK_BUILDDATE), TAP_CODE_DELAY);
+            }
+
+            SEQ_TWO_KEYS(KC_L, KC_C) {
+                send_string_with_delay("/**  */", TAP_CODE_DELAY);
+                wait_ms(TAPPING_TERM);
+                tap_code(KC_LEFT);
+                tap_code(KC_LEFT);
+                tap_code(KC_LEFT);
+                if (!(mods & MOD_MASK_SHIFT)) {
+                    tap_code(KC_ENT);
+                }
+            }
+
+            set_mods(mods);
+            #ifndef NO_SECRETS
+            leader_scan_secrets();
+            #endif // !NO_SECRETS
+        }
+    }
+#endif
+
+static bool is_first_run = true;
+void matrix_scan_user(void) {
+    if (is_first_run) {
+        is_first_run = false;
+        startup_user();
+    }
+    #ifdef LEADER_ENABLE
+    matrix_scan_leader();
+    #endif
+    matrix_scan_keymap();
+}
+
+__attribute__((weak)) layer_state_t layer_state_set_keymap(layer_state_t state) { return state; }
+
+// on layer change, no matter where the change was initiated
+// Then runs keymap's layer change check
+layer_state_t layer_state_set_user(layer_state_t state) {
+    if (!is_keyboard_master()) {
+        return state;
+    }
+
+    state = update_tri_layer_state(state, _RAISE, _LOWER, _ADJUST);
+    state = layer_state_set_keymap(state);
+#if defined(RGBLIGHT_ENABLE)
+    state = layer_state_set_rgb_light(state);
+#endif  // RGBLIGHT_ENABLE
+    return state;
+}
+
+__attribute__((weak)) void dip_switch_update_keymap(uint8_t index, bool active) {}
+void dip_switch_update_user(uint8_t index, bool active) {
+    dip_switch_update_keymap(index, active);
+}
+
+__attribute__((weak)) bool music_mask_keymap(uint16_t keycode) { return true; }
+bool music_mask_user(uint16_t keycode) {
+    switch (keycode){
+        default:
+            return music_mask_keymap(keycode);
+            break;
+    }
+}
+
+__attribute__((weak)) layer_state_t default_layer_state_set_keymap(layer_state_t state) { return state; }
+
+// Runs state check and changes underglow color and animation
+layer_state_t default_layer_state_set_user(layer_state_t state) {
+    if (!is_keyboard_master()) {
+        return state;
+    }
+    return default_layer_state_set_keymap(state);
+}
+
+#ifdef AUDIO_ENABLE
+__attribute__((weak)) void startup_keymap(void) {}
+void startup_user(void)
+{
+    wait_ms(TAP_CODE_DELAY); // gets rid of tick
+    startup_keymap();
+}
+
+__attribute__((weak))  void shutdown_keymap(void) {}
+void shutdown_user(void)
+{
+    wait_ms(TAP_CODE_DELAY);
+    stop_all_notes();
+    shutdown_keymap();
+}
+
+__attribute__((weak)) void music_on_keymap(void) {}
+void music_on_user(void)
+{
+    music_scale_user();
+    music_on_keymap();
+}
+#endif // AUDIO_ENABLE
diff --git a/users/jjerrell/jjerrell.h b/users/jjerrell/jjerrell.h
new file mode 100644
index 0000000000..92b95ccc01
--- /dev/null
+++ b/users/jjerrell/jjerrell.h
@@ -0,0 +1,53 @@
+/**
+ * Copyright (C) 2021 Jerrell, Jacob <@jjerrell>
+ * 
+ * This file is part of qmk_firmware.
+ * 
+ * qmk_firmware 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 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * qmk_firmware 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 qmk_firmware.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+#include QMK_KEYBOARD_H
+
+/** QMK Includes **/
+#include "version.h"
+#include "eeprom.h"
+#include "muse.h"
+
+#include "process_records.h"
+#include "wrappers.h"
+
+/************************* Userspace Layers *************************
+ *    Keymaps can define additional layers by making the first case
+ * equal to `LAYER_SAFE_RANGE`           
+ ********************************************************************/
+enum userspace_layers {
+    _WORKMAN,
+    _QWERTY,
+    _LOWER,
+    _RAISE,
+    _ADJUST,
+    _SPECIAL,
+    _GAME,
+    LAYER_SAFE_RANGE,
+};
+
+void matrix_scan_keymap(void);
+layer_state_t layer_state_set_keymap(layer_state_t state);
+void dip_switch_update_keymap(uint8_t index, bool active);
+bool music_mask_keymap(uint16_t keycode);
+layer_state_t default_layer_state_set_keymap(layer_state_t state);
+void startup_keymap(void);
+void shutdown_keymap(void);
+void music_on_keymap(void);
diff --git a/users/jjerrell/process_records.c b/users/jjerrell/process_records.c
new file mode 100644
index 0000000000..abdcd0934c
--- /dev/null
+++ b/users/jjerrell/process_records.c
@@ -0,0 +1,139 @@
+/**
+ * Copyright (C) 2021 Jerrell, Jacob <@jjerrell>
+ * 
+ * This file is part of qmk_firmware.
+ * 
+ * qmk_firmware 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 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * qmk_firmware 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 qmk_firmware.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "jjerrell.h"
+
+float game_song[][2] = SONG(TO_BOLDLY_GO);
+float work_song[][2] = SONG(MARIO_GAMEOVER);
+float doom_song[][2] = SONG(E1M1_DOOM);
+
+__attribute__((weak)) bool process_record_keymap(uint16_t keycode, keyrecord_t *record) { return true; }
+
+static uint16_t key_timer;
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+    if (process_record_keymap(keycode, record)) {
+        static uint8_t mods = 0;
+        // static uint8_t layer = 0;
+        mods = get_mods();
+        switch (keycode) {
+        case KC_QWERTY:
+            if (record->event.pressed) {
+                set_single_persistent_default_layer(_QWERTY);
+            }
+            return false;
+            break;
+        case KC_WORKMAN:
+            if (record->event.pressed) {
+                set_single_persistent_default_layer(_WORKMAN);
+            }
+            return false;
+            break;
+        case KC_CCCV:
+            if (record->event.pressed) {
+                key_timer = timer_read();
+            } else {
+                clear_mods();
+                if (timer_elapsed(key_timer) > TAPPING_TERM) {  // Hold, copy
+                    tap_code16(G(KC_C));
+                } else if (mods & MOD_MASK_SHIFT) {  
+                    // Tap w/ shift held, open [Paste App](https://pasteapp.io) (no affiliation)
+                    // Shift + Command(GUI) + V                
+                    tap_code16(S(G(KC_V)));
+                } else { // Regular tap, do paste
+                    tap_code16(G(KC_V));
+                }
+                set_mods(mods);
+            }
+            return false;
+            break;
+        case KC_ARROW:
+            if (record->event.pressed) {
+                clear_mods();
+                if (mods & MOD_MASK_SHIFT) {
+                    SEND_STRING("=>");
+                } else {
+                    SEND_STRING("->"); 
+                }
+                set_mods(mods);
+            }
+            return false;
+            break;
+        case KC_MAKE:
+            if (!record->event.pressed) {
+#ifndef MAKE_BOOTLOADER
+                uint8_t temp_mod = mod_config(get_mods());
+                uint8_t temp_osm = mod_config(get_oneshot_mods());
+                clear_mods();
+                clear_oneshot_mods();
+#endif
+                send_string_with_delay_P(PSTR("qmk"), TAP_CODE_DELAY);
+#ifndef MAKE_BOOTLOADER
+                if ((temp_mod | temp_osm) & MOD_MASK_SHIFT)
+#endif
+                {
+                    send_string_with_delay_P(PSTR(" flash "), TAP_CODE_DELAY);
+#ifndef MAKE_BOOTLOADER
+                } else {
+                    send_string_with_delay_P(PSTR(" compile "), TAP_CODE_DELAY);
+#endif
+                }
+                send_string_with_delay_P(PSTR("-kb " QMK_KEYBOARD " -km " QMK_KEYMAP), TAP_CODE_DELAY);
+                send_string_with_delay_P(PSTR(SS_TAP(X_ENTER)), TAP_CODE_DELAY);
+            }
+            return false;
+            break;
+        case KC_VRSN:
+            if (!record->event.pressed) {
+                send_string_with_delay_P(PSTR(QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION " Built at: " QMK_BUILDDATE), TAP_CODE_DELAY);
+            }
+            return false;
+            break;
+        case KC_GAME:
+            if (record->event.pressed) {
+                key_timer = timer_read();
+            } else {
+                if (IS_LAYER_OFF(_GAME)) {
+                    if (timer_elapsed(key_timer) > TAPPING_TERM) {
+                        layer_move(_GAME);
+#ifdef AUDIO_ENABLE
+PLAY_SONG(game_song);
+#endif
+                    }
+                    break;
+                    // todo: cycle game layers
+                // } else if (mods & MOD_MASK_SHIFT) {
+// #ifdef AUDIO_ENABLE
+// PLAY_SONG(doom_song);
+// #endif
+//                     break;
+                } else {
+                    layer_move(_WORKMAN);
+#ifdef AUDIO_ENABLE
+PLAY_SONG(work_song);
+#endif
+                    break;
+                }
+            }
+            return false;
+            break;
+        }
+    }
+    return true;
+}
diff --git a/users/jjerrell/process_records.h b/users/jjerrell/process_records.h
new file mode 100644
index 0000000000..de37421b10
--- /dev/null
+++ b/users/jjerrell/process_records.h
@@ -0,0 +1,41 @@
+// Copyright (C) 2021 Jerrell, Jacob <@jjerrell>
+// 
+// This file is part of qmk_firmware.
+// 
+// qmk_firmware 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 3 of the License, or
+// (at your option) any later version.
+// 
+// qmk_firmware 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 qmk_firmware.  If not, see <http://www.gnu.org/licenses/>.
+
+#pragma once
+#include "jjerrell.h"
+
+#if defined(KEYMAP_SAFE_RANGE)
+#    define PLACEHOLDER_SAFE_RANGE KEYMAP_SAFE_RANGE
+#else
+#    define PLACEHOLDER_SAFE_RANGE SAFE_RANGE
+#endif
+
+enum userspace_keycodes {
+    KC_ARROW = PLACEHOLDER_SAFE_RANGE, // `->`
+    KC_MAKE,       // Runs the keyboard's make command
+    KC_QWERTY,     // Default Layer -> QWERTY
+    KC_WORKMAN,    // Default Layer -> Workman
+    KC_VRSN,       // Print QMK Firmware and board info
+    RGB_IDL,       // Toggle RGB Idle animations
+    RGB_TGL,       // Toggle RGB Layer Indication
+    KC_CCCV,       // One key copy/paste,
+    KC_GAME,       // To game layer. If on game layer, cycle game layers
+    NEW_SAFE_RANGE // use NEW_SAFE_RANGE for keymap specific codes
+};
+
+bool process_record_keymap(uint16_t keycode, keyrecord_t *record);
+
diff --git a/users/jjerrell/readme.md b/users/jjerrell/readme.md
new file mode 100644
index 0000000000..a382524f2e
--- /dev/null
+++ b/users/jjerrell/readme.md
@@ -0,0 +1,50 @@
+<!--
+ Copyright (C) 2021 Jerrell, Jacob <@jjerrell>
+ 
+ This file is part of qmk_firmware.
+ 
+ qmk_firmware 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 3 of the License, or
+ (at your option) any later version.
+ 
+ qmk_firmware 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 qmk_firmware.  If not, see <http://www.gnu.org/licenses/>.
+-->
+
+# JJerrell's QMK Userspace
+
+This userspace showcases my personal journey with QMK keyboards and aims to simplify additional development, reduce code duplication, and maintain a consistent experience across my current keyboards. My original userspace has been archived because I wanted to take the time to grasp _how_ what I was doing worked -- rather than copy/pasta and blind luck.
+
+Some keyboard specific code is stored here because it's contextually relevant. It may be somewhat pedantic, but an effort has been made to wrap this code with preprocessor checks. i.e. `#if (defined(KEYBOARD_planck_ez))`.
+
+## Daily Drivers
+
+1. Ergodox EZ - My first mechanical love. Now the office keyboard (if we go back). After finding inferior travel cases for exorbitant amounts of money, I built a custom travel case out of a case designed for drones and maticulous work cutting guncase foam. Around $50 with plenty of foam left over for family LARPing weapons. I'll post a picture one of these days. It also has a spot for my wireless touchpad.
+2. Planck EZ - The solution to not being able to sit at a desk 100% of the time and not being able to live without QMK for any amount of time. Karabiner-Elements disables the Macbook keyboard when this is plugged in and the planck sits ontop of it with a very short usb-c cable. Probably terrible for the built in keyboard but they screwed up this generation anyway.
+3. Moonlander - Just when I thought it was over, the lovely people with ZSA did it again. This one stays at home on my desk.
+
+## Features
+
+- Keymap level customization
+  - User methods implemented here will give the keymaps a chance to override functionality by optionally implementing relevant _keymap methods
+- Layer Macros
+  - WRAPPER defines in [wrapper.c] simplify consistent keymaps
+- Leader key secrets
+  - [jjerrell.c] sets up the functionality for this feature and calls into the leader_scan_secrets method.
+  - TODO: add documentation for leader_scan_secrets implementation
+
+## Issues
+
+### Tap/hold keys and shifted keycodes
+
+An immediate part of my love for QMK was it's ability to differentiate between holds and presses to a level where you can apply modifiers when a normal alpha code is held. This feature was the single-most health related improvement to adopting QMK, in my opinion.
+
+Beloved as it may be it comes with some baggage; shifted keycodes will be applied as their unshifted counterparts. I've worked around this in the past but the solution this time is a close adoption of the symbol layer inspired by the Neo keyboard.
+
+There is also a problem with relying on SFT_T() for all of your shifting needs because if you attempt to swap which fingers are holding it and don't release the first before pressing the second, shift won't register anymore. This could probably be fixed but it discourages typing in all caps because it becomes too tedious. However, most layers do have a dedicated shift key to counteract this when necessary.
diff --git a/users/jjerrell/rules.mk b/users/jjerrell/rules.mk
new file mode 100644
index 0000000000..db359a5757
--- /dev/null
+++ b/users/jjerrell/rules.mk
@@ -0,0 +1,27 @@
+SRC += jjerrell.c \
+       process_records.c
+
+LEADER_ENABLE = yes
+MOUSEKEY_ENABLE = yes
+EXTRAKEY_ENABLE = yes
+
+ifneq ($(PLATFORM),CHIBIOS)
+    LTO_ENABLE        = yes
+endif
+SPACE_CADET_ENABLE    = no
+GRAVE_ESC_ENABLE      = no
+
+ifneq ($(strip $(NO_SECRETS)), yes)
+    ifneq ("$(wildcard $(USER_PATH)/secrets.c)","")
+        SRC += secrets.c
+    endif
+    ifeq ($(strip $(NO_SECRETS)), lite)
+        OPT_DEFS += -DNO_SECRETS
+    endif
+endif
+
+# TODO: RGB is next
+# RGB_MATRIX_ENABLE ?= no
+# ifneq ($(strip $(RGB_MATRIX_ENABLE)), no)
+#     SRC += rgb_matrix_stuff.c
+# endif
diff --git a/users/jjerrell/wrappers.h b/users/jjerrell/wrappers.h
new file mode 100644
index 0000000000..cc0f963e8d
--- /dev/null
+++ b/users/jjerrell/wrappers.h
@@ -0,0 +1,329 @@
+// Copyright (C) 2021 Jerrell, Jacob <@jjerrell>
+// 
+// This file is part of qmk_firmware.
+// 
+// qmk_firmware 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 3 of the License, or
+// (at your option) any later version.
+// 
+// qmk_firmware 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 qmk_firmware.  If not, see <http://www.gnu.org/licenses/>.
+
+#pragma once
+#include "jjerrell.h"
+
+#define QWERTY  KC_QWERTY
+#define WORKMN  KC_WORKMAN
+
+#define KC_CUT  LGUI(KC_X) 
+
+// Non-sane shortcuts for software macros or keybindings
+#define MACRO_1 ALL_T(KC_F12)
+#define MACRO_2 ALL_T(KC_F13)
+#define MACRO_3 ALL_T(KC_F14)
+#define MACRO_4 ALL_T(KC_F15)
+
+#define MACRO_5 ALL_T(KC_F16)
+#define MACRO_6 ALL_T(KC_F17)
+#define MACRO_7 ALL_T(KC_F18)
+#define MACRO_8 ALL_T(KC_F19)
+
+// clang-format off
+#if (!defined(LAYOUT) && defined(KEYMAP))
+#    define LAYOUT KEYMAP
+#endif
+
+#if (defined(KEYBOARD_planck_ez))
+/** Planck EZ Empty
+ * ,-----------------------------------------------------------------------------------.
+ * |      |      |      |      |      |      |      |      |      |      |      |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |      |      |      |      |      |      |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |      |      |      |      |      |      |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      |      |      |      |      |
+ * `-----------------------------------------------------------------------------------'
+ */
+
+#   define ____________________________________________________________PLANCK_VERBOSE_BOTTOM_ROW_____________________________________________________________ \
+           KC_LEAD, KC_LSFT, KC_CCCV, KC_HYPR, LT(_LOWER, KC_BSPC), SFT_T(KC_SPC), XXXXXXX, LT(_RAISE, KC_ENT),  KC_MEH,    RGB_TOG,    RGB_IDL,    LED_LEVEL
+
+#   define _________________________________________PLANCK_LOWER_BOTTOM_ROW_________________________________________ \
+           KC_LEAD, KC_LSFT, KC_CCCV, KC_HYPR,  KC_BSPC,  KC_SPC, XXXXXXX,   KC_ENT, KC_0, KC_DOT, KC_COMM, LED_LEVEL
+// TODO: It would be nice to find a way to apply the bottom row with optional left/right varargs. 
+//       I'm completely unsure if this language can support something like that though.
+
+/**
+ * Basic Planck EZ Wrapper to expand "block" defines before sending 
+ * to LAYOUT_ortho_4x12
+ */
+#   define WRAPPER_ortho_4x12(...) LAYOUT_ortho_4x12(__VA_ARGS__)
+
+#   define WRAPPER_planck_common( \
+        K01, K02, K03, K04, K05,     K08, K09, K0A, K0B, K0C, \
+        K11, K12, K13, K14, K15,     K18, K19, K1A, K1B, K1C, \
+        K21, K22, K23, K24, K25,     K28, K29, K2A, K2B, K2C  \
+    ) WRAPPER_ortho_4x12( \
+        K01,     K02,     K03,     K04,                K05 ,       XXXXXXX ,  XXXXXXX, K08,                 K09,     K0A,     K0B,     K0C,      \
+        K11,     K12,     K13,     K14,                K15 ,       XXXXXXX ,  XXXXXXX, K18,                 K19,     K1A,     K1B,     K1C,      \
+        K21,     K22,     K23,     K24,                K25 ,       XXXXXXX ,  XXXXXXX, K28,                 K29,     K2A,     K2B,     K2C,      \
+    ____________________________________________________________PLANCK_VERBOSE_BOTTOM_ROW_____________________________________________________________ )
+
+/**
+ * Shifted Key conflicts:
+ * K12, K13, K14, K19, K1A, K1B, K21, K2C
+ */
+#   define WRAPPER_planck_base( \
+        K01, K02, K03, K04, K05,     K08, K09, K0A, K0B, K0C, \
+        K11, K12, K13, K14, K15,     K18, K19, K1A, K1B, K1C, \
+        K21, K22, K23, K24, K25,     K28, K29, K2A, K2B, K2C  \
+    ) WRAPPER_ortho_4x12( \
+                K01 ,       K02 ,       K03 ,       K04 ,                K05 ,      KC_GAME , KC_GAME, K08,                 K09 ,       K0A ,       K0B ,       K0C,        \
+                K11 , SFT_T(K12), GUI_T(K13), ALT_T(K14),                K15 ,      XXXXXXX , XXXXXXX, K18,                 ALT_T(K19), GUI_T(K1A), SFT_T(K1B), K1C,        \
+          CTL_T(K21),       K22 ,       K23 ,       K24 ,                K25 ,      XXXXXXX , XXXXXXX, K28,                 K29 ,       K2A ,       K2B ,       CTL_T(K2C), \
+                ____________________________________________________________PLANCK_VERBOSE_BOTTOM_ROW_____________________________________________________________   )
+
+#   define WRAPPER_planck_mods( \
+        K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, \
+        K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, \
+        K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, \
+        K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3C  \
+    ) WRAPPER_ortho_4x12( \
+                K01 ,       K02 ,       K03 ,       K04 ,            K05 ,         K06 ,     K07, K08,             K09 ,       K0A ,       K0B ,       K0C,        \
+                K11 , SFT_T(K12), GUI_T(K13), ALT_T(K14),            K15 ,         K16 ,     K17, K18,             ALT_T(K19), GUI_T(K1A), SFT_T(K1B), K1C,        \
+          CTL_T(K21),       K22 ,       K23 ,       K24 ,            K25 ,         K26 ,     K27, K28,             K29 ,       K2A ,       K2B ,       CTL_T(K2C), \
+                K31,        K32 ,       K33 ,       K34 , LT(_LOWER, K35),   SFT_T(K36), XXXXXXX, LT(_RAISE, K38), K39 ,       K3A ,       K3B,        K3C         )
+
+
+
+// These macros are used when defining layouts in keymap.c
+#   define LAYOUT_planck_base(...)    WRAPPER_planck_base(__VA_ARGS__)
+#   define LAYOUT_planck_common(...)  WRAPPER_planck_common(__VA_ARGS__)
+#   define LAYOUT_planck_mods(...)    WRAPPER_planck_mods(__VA_ARGS__)
+
+#elif defined(KEYBOARD_moonlander)
+/** Moonlander Empty
+ * ( \
+        k00, k01, k02, k03, k04, k05, k06,   k60, k61, k62, k63, k64, k65, k66, \
+        k10, k11, k12, k13, k14, k15, k16,   k70, k71, k72, k73, k74, k75, k76, \
+        k20, k21, k22, k23, k24, k25, k26,   k80, k81, k82, k83, k84, k85, k86, \
+        k30, k31, k32, k33, k34, k35,             k91, k92, k93, k94, k95, k96, \
+        k40, k41, k42, k43, k44,      k53,   kb3,      ka2, ka3, ka4, ka5, ka6, \
+                            k50, k51, k52,   kb4, kb5, kb6 \
+    ) \
+ */
+#   define WRAPPER_moonlander(...)    LAYOUT_moonlander(__VA_ARGS__)
+#   define WRAPPER_moonlander_common( \
+             k11, k12, k13, k14, k15,             k71, k72, k73, k74, k75, \
+             k21, k22, k23, k24, k25,             k81, k82, k83, k84, k85, \
+             k31, k32, k33, k34, k35,             k91, k92, k93, k94, k95, \
+             k41, k42, k43, k44,                       ka2, ka3, ka4, ka5  \
+    ) WRAPPER_moonlander( \
+        XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,   XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,      \
+        XXXXXXX,     k11,     k12,     k13,     k14,     k15, XXXXXXX,   XXXXXXX, k71,     k72,     k73,     k74,     k75,     XXXXXXX,      \
+        XXXXXXX,     k21,     k22,     k23,     k24,     k25, XXXXXXX,   XXXXXXX, k81,     k82,     k83,     k84,     k85,     XXXXXXX,      \
+        KC_LSFT,     k31,     k32,     k33,     k34,     k35,                     k91,     k92,     k93,     k94,     k95,     KC_RSFT,      \
+   MO(_SPECIAL),     k41,     k42,     k43,     k44,        TO(_GAME),   XXXXXXX,          ka2,     ka3,     ka4,     ka5,     MO(_SPECIAL), \
+                           LT(_LOWER, KC_SPC),HYPR_T(KC_BSPC),KC_LEAD,   KC_CCCV,SFT_T(KC_TAB),LT(_RAISE, KC_ENT)                            )
+
+#   define WRAPPER_moonlander_mods( \
+        k11, k12, k13, k14, k15,             k71, k72, k73, k74, k75, \
+        k21, k22, k23, k24, k25,             k81, k82, k83, k84, k85, \
+        k31, k32, k33, k34, k35,             k91, k92, k93, k94, k95, \
+        k41, k42, k43, k44,                       ka2, ka3, ka4, ka5  \
+    ) WRAPPER_moonlander_common( \
+              k11 ,       k12 ,       k13 ,       k14 , k15,             k71, k72,        k73,        k74,        k75, \
+              k21 , SFT_T(k22), GUI_T(k23), ALT_T(k24), k25,             k81, ALT_T(k82), GUI_T(k83), SFT_T(k84), k85, \
+        CTL_T(k31),       k32 ,       k33 ,       k34 , k35,             k91, k92,        k93,        k94,        CTL_T(k95), \
+              k41 ,       k42 ,       k43 ,       k44 ,                       ka2,        ka3,        ka4,        ka5  \
+    )
+#   define WRAPPER_moonlander_gamepad( \
+        k00, k01, k02, k03, k04, k05, k06, \
+        k10, k11, k12, k13, k14, k15, k16, \
+        k20, k21, k22, k23, k24, k25, k26, \
+        k30, k31, k32, k33, k34, k35,      \
+        k40, k41, k42, k43, k44,      k53, \
+                            k50, k51, k52  \
+    ) WRAPPER_moonlander( \
+        k00, k01, k02, k03, k04, k05, k06,   XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, \
+        k10, k11, k12, k13, k14, k15, k16,   XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, \
+        k20, k21, k22, k23, k24, k25, k26,   XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, \
+        k30, k31, k32, k33, k34, k35,                 XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, \
+        k40, k41, k42, k43, k44,      k53,   XXXXXXX,          XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, \
+                            k50, k51, k52,   XXXXXXX, XXXXXXX, TO(_WORKMAN) \
+    )
+
+#   define LAYOUT_moonlander_common(...)  WRAPPER_moonlander_common(__VA_ARGS__)
+#   define LAYOUT_moonlander_mods(...)    WRAPPER_moonlander_mods(__VA_ARGS__)
+#   define LAYOUT_moonlander_gamepad(...) WRAPPER_moonlander_gamepad(__VA_ARGS__)
+#elif defined(KEYBOARD_ergodox_ez)
+/** Ergodox EZ Empty
+     .---------------------------------------------. .---------------------------------------------.
+     |       |     |     |     |     |     |       | !       |     |     |     |     |     |       |
+     !-------+-----+-----+-----+-----+-------------! !-------+-----+-----+-----+-----+-----+-------!
+     |       |     |     |     |     |     |       | !       |     |     |     |     |     |       |
+     !-------+-----+-----+-----x-----x-----!       ! !       !-----x-----x-----+-----+-----+-------!
+     |       |     |     |     |     |     |-------! !-------!     |     |     |     |     |       |
+     !-------+-----+-----+-----x-----x-----!       ! !       !-----x-----x-----+-----+-----+-------!
+     |       |     |     |     |     |     |       | !       |     |     |     |     |     |       |
+     '-------+-----+-----+-----+-----+-------------' '-------------+-----+-----+-----+-----+-------'
+      |      |     |     |     |     |                             !     |     |     |     |      |
+      '------------------------------'                             '------------------------------'
+                                   .---------------. .---------------.
+                                   |       |       | !       |       |
+                           .-------+-------+-------! !-------+-------+-------.
+                           !       !       |       | !       |       !       !
+                           !       !       !-------! !-------!       !       !
+                           |       |       |       | !       |       |       |
+                           '-----------------------' '-----------------------'
+
+    ---------- LEFT HAND -----------   ---------- RIGHT HAND ----------
+    (                                                                    \
+    L00,L01,L02,L03,L04,L05,L06,           R00,R01,R02,R03,R04,R05,R06,  \
+    L10,L11,L12,L13,L14,L15,L16,           R10,R11,R12,R13,R14,R15,R16,  \
+    L20,L21,L22,L23,L24,L25,                   R21,R22,R23,R24,R25,R26,  \
+    L30,L31,L32,L33,L34,L35,L36,           R30,R31,R32,R33,R34,R35,R36,  \
+    L40,L41,L42,L43,L44,                           R42,R43,R44,R45,R46,  \
+                            L55,L56,   R50,R51,                          \
+                                L54,   R52,                              \
+                        L53,L52,L51,   R55,R54,R53                       \
+    )
+*/
+#   define WRAPPER_ergodox_ez(...)     LAYOUT_ergodox_pretty(__VA_ARGS__)
+
+/** Common Wrapper
+     .---------------------------------------------. .---------------------------------------------.
+     |   X   |  X  |  X  |  X  |  X  |  X  |   X   | !   X   |  X  |  X  |  X  |  X  |  X  |   X   |
+     !-------+-----+-----+-----+-----+-------------! !-------+-----+-----+-----+-----+-----+-------!
+     |   X   |     |     |     |     |     |   X   | !   X   |     |     |     |     |     |   X   |
+     !-------+-----+-----+-----x-----x-----!       ! !       !-----x-----x-----+-----+-----+-------!
+     |   X   |     |     |     |     |     |-------! !-------!     |     |     |     |     |   X   |
+     !-------+-----+-----+-----x-----x-----!   X   ! !   X   !-----x-----x-----+-----+-----+-------!
+     |   X   |     |     |     |     |     |       | !       |     |     |     |     |     |   X   |
+     '-------+-----+-----+-----+-----+-------------' '-------------+-----+-----+-----+-----+-------'
+      | SPCL |     |     |     |     |                             !     |     |     |     | SPCL |
+      '------------------------------'                             '------------------------------'
+                                   .---------------. .---------------.
+                                   |   X   |   X   | !   X   |   X   |
+                           .-------+-------+-------! !-------+-------+-------.
+                           ! Space ! BSpace|   X   | !   X   |  Tab  ! Enter !
+                           !   /   !   /   !-------! !-------!   /   !   /   !
+                           | LOWER | Hyper |  LEAD | !  CCCV |  Meh  | RAISE |
+                           '-----------------------' '-----------------------'
+*/
+#   define WRAPPER_ergodox_common( \
+        L11,L12,L13,L14,L15,           R11,R12,R13,R14,R15,  \
+        L21,L22,L23,L24,L25,           R21,R22,R23,R24,R25,  \
+        L31,L32,L33,L34,L35,           R31,R32,R33,R34,R35,  \
+        L41,L42,L43,L44,                   R42,R43,R44,R45   \
+    ) WRAPPER_ergodox_ez( \
+        XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,           XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,      XXXXXXX, \
+        XXXXXXX,     L11,     L12,     L13,     L14,     L15, XXXXXXX,           XXXXXXX,     R11,     R12,     R13,     R14,     R15,      XXXXXXX, \
+        XXXXXXX,     L21,     L22,     L23,     L24,     L25,                                 R21,     R22,     R23,     R24,     R25,      XXXXXXX, \
+        KC_LSFT,     L31,     L32,     L33,     L34,     L35, XXXXXXX,           XXXXXXX,     R31,     R32,     R33,     R34,     R35,      KC_RSFT, \
+   MO(_SPECIAL),     L41,     L42,     L43,     L44,                                                   R42,     R43,     R44,     R45, MO(_SPECIAL), \
+                                                                                                                                                     \
+                                                      XXXXXXX,XXXXXXX,           XXXXXXX,XXXXXXX,                                                    \
+                                                              XXXXXXX,           XXXXXXX,                                                            \
+                           LT(_LOWER, KC_SPC),HYPR_T(KC_BSPC),KC_LEAD,           KC_CCCV,SFT_T(KC_TAB),LT(_RAISE, KC_ENT)                            )
+
+/** Common Wrapper with Mod Tap/Hold overlay
+     .---------------------------------------------. .---------------------------------------------.
+     |   X   |  X  |  X  |  X  |  X  |  X  |   X   | !   X   |  X  |  X  |  X  |  X  |  X  |   X   |
+     !-------+-----+-----+-----+-----+-------------! !-------+-----+-----+-----+-----+-----+-------!
+     |   X   |     |     |     |     |     |   X   | !   X   |     |     |     |     |     |   X   |
+     !-------+-----+-----+-----x-----x-----!       ! !       !-----x-----x-----+-----+-----+-------!
+     |   X   |     |Shift| Cmd | Alt |     |-------! !-------!     | Alt | Cmd |Shift|     |   X   |
+     !-------+-----+-----+-----x-----x-----!   X   ! !   X   !-----x-----x-----+-----+-----+-------!
+     |  Sft  | Ctl |     |     |     |     |       | !       |     |     |     |     | Ctl |  Sft  |
+     '-------+-----+-----+-----+-----+-------------' '-------------+-----+-----+-----+-----+-------'
+      | SPCL |     |     |     |     |                             !     |     |     |     | SPCL |
+      '------------------------------'                             '------------------------------'
+                                   .---------------. .---------------.
+                                   |   X   |   X   | !   X   |   X   |
+                           .-------+-------+-------! !-------+-------+-------.
+                           ! Space ! BSpace|   X   | !   X   |  Tab  ! Enter !
+                           !   /   !   /   !-------! !-------!   /   !   /   !
+                           | LOWER | Hyper |  LEAD | !  CCCV |  Meh  | RAISE |
+                           '-----------------------' '-----------------------'
+*/
+#   define WRAPPER_ergodox_mods( \
+        L11,L12,L13,L14,L15,           R11,R12,R13,R14,R15,  \
+        L21,L22,L23,L24,L25,           R21,R22,R23,R24,R25,  \
+        L31,L32,L33,L34,L35,           R31,R32,R33,R34,R35,  \
+        L41,L42,L43,L44,                   R42,R43,R44,R45   \
+    ) WRAPPER_ergodox_common( \
+              L11 ,       L12 ,       L13 ,       L14 , L15,           R11,       R12 ,       R13 ,       R14 ,        R15,  \
+              L21 , SFT_T(L22), GUI_T(L23), ALT_T(L24), L25,           R21, ALT_T(R22), GUI_T(R23), SFT_T(R24),        R25,  \
+        CTL_T(L31),       L32 ,       L33 ,       L34 , L35,           R31,       R32 ,       R33 ,       R34 , CTL_T(R35),  \
+              L41 ,       L42 ,       L43 ,       L44 ,                           R42 ,       R43 ,       R44 ,        R45   )
+
+// These macros are used when defining layouts in keymap.c
+#   define LAYOUT_ergodox_common(...)  WRAPPER_ergodox_common(__VA_ARGS__)
+#   define LAYOUT_ergodox_mods(...)    WRAPPER_ergodox_mods(__VA_ARGS__)
+#endif // END Keyboard specific wrapper defines
+/**
+ * Alpha/Num key wrappers for portability
+ */
+
+// Workman
+#define __________________WORKMN_L1__________________   KC_Q, KC_D, KC_R, KC_W, KC_B
+#define __________________WORKMN_L2__________________   KC_A, KC_S, KC_H, KC_T, KC_G
+#define __________________WORKMN_L3__________________   KC_Z, KC_X, KC_M, KC_C, KC_V
+
+#define __________________WORKMN_R1__________________   KC_J, KC_F, KC_U,    KC_P,   KC_SCLN
+#define __________________WORKMN_R2__________________   KC_Y, KC_N, KC_E,    KC_O,   KC_I
+#define __________________WORKMN_R3__________________   KC_K, KC_L, KC_COMM, KC_DOT, KC_SLSH
+
+// QWERTY
+#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_SLSH
+
+#define ________________QWERTY_R1_LHS________________   KC_P,    KC_O,   KC_I,     KC_U, KC_Y
+#define ________________QWERTY_R2_LHS________________   KC_SCLN, KC_L,   KC_K,     KC_J, KC_H
+#define ________________QWERTY_R3_LHS________________   KC_SLSH, KC_DOT, KC_COMM,  KC_M, KC_N
+
+// Nums
+#define ___________________NUMS_L____________________   KC_1, KC_2, KC_3, KC_4, KC_5,    KC_6
+#define ___________________NUMS_R____________________   KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL
+
+// Lower
+#define __________________LOWER_L1___________________   KC_PGUP, KC_TAB,  KC_UP,   KC_ENT,  KC_PGDN
+#define __________________LOWER_L2___________________   KC_HOME, KC_LEFT, KC_DOWN, KC_RGHT, KC_END
+#define __________________LOWER_L3___________________   KC_ESC,  KC_BSPC, KC_CUT,  KC_DEL,  KC_CCCV
+
+#define __________________LOWER_R1___________________   XXXXXXX, KC_7, KC_8,   KC_9,    KC_ASTR
+#define __________________LOWER_R2___________________   XXXXXXX, KC_4, KC_5,   KC_6,    KC_SLSH
+#define __________________LOWER_R3___________________   XXXXXXX, KC_1, KC_2,   KC_3,    KC_MINS
+//  Relevant keys: ->                                            KC_0, KC_DOT, KC_COMM, KC_PLUS <- these keys break our lovely wrapper pattern
+ 
+// Raise
+#define __________________RAISE_L1___________________   KC_PIPE, KC_UNDS, KC_LBRC, KC_RBRC, KC_AMPR
+#define __________________RAISE_L2___________________   KC_BSLS, KC_SLSH, KC_LCBR, KC_RCBR, KC_ASTR
+#define __________________RAISE_L3___________________   KC_HASH, KC_DLR , KC_PERC, KC_TILD, KC_GRV
+
+#define __________________RAISE_R1___________________   KC_EXLM, KC_LABK, KC_RABK, KC_MINS, KC_SCLN
+#define __________________RAISE_R2___________________   KC_QUES, KC_LPRN, KC_RPRN, KC_EQL,  KC_COLN
+#define __________________RAISE_R3___________________   KC_AT,   KC_QUOT, KC_DQUO, KC_PLUS, KC_CIRC
+
+// Adjust
+#define __________________ADJUST_L1__________________   KC_MAKE,        DEBUG,     RESET, TERM_ON, TERM_OFF
+#define __________________ADJUST_L2__________________   KC__MUTE, KC__VOLDOWN, KC__VOLUP, KC_MPLY,  KC_MNXT
+#define __________________ADJUST_L3__________________   KC_VRSN,        AU_ON,    AU_OFF, CG_SWAP,  CG_NORM
+
+#define __________________ADJUST_R1__________________   MU_MOD, MU_ON,   MU_OFF,  MI_ON,   MI_OFF
+#define __________________ADJUST_R2__________________   MUV_IN, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD
+#define __________________ADJUST_R3__________________   MUV_DE, RGB_TOG, RGB_MOD, RGB_VAI, RGB_VAD
+// clang-format on