Merge branch 'userspace-muppetjones' of github.com:muppetjones/qmk_firmware into userspace-muppetjones

keyboards/kyria/keymaps/muppetjones/README.md

@@ -1,11 +0,0 @@
-# Kyria
-
-## Compile
-
-```shell
-make kyria:muppetjones:avrdude-split-left
-```
-
-```shell
-make kyria:muppetjones:avrdude-split-right
-```

keyboards/lily58/keymaps/muppetjones/README.md

@@ -5,9 +5,9 @@ qmk compile -kb lily58/rev1 -km muppetjones
 ```
 
 ```
-make lily58/rev1:muppetjones:avrdude-split-left
+qmk flash -kb lily58/rev1 -km muppetjones -bl avrdude-split-left
 ```
 
 ```
-make lily58/rev1:muppetjones:avrdude-split-left
+qmk flash -kb lily58/rev1 -km muppetjones -bl avrdude-split-right
 ```

keyboards/lily58/keymaps/muppetjones/features/bongo_cat.c

@@ -9,7 +9,7 @@ Source:
 
 #include QMK_KEYBOARD_H
 
-#ifdef OLED_DRIVER_ENABLE
+#ifdef OLED_ENABLE
 
 #    define IDLE_FRAMES 5
 #    define IDLE_SPEED 30  // below this wpm value your animation will idle
@@ -28,7 +28,6 @@ uint32_t anim_sleep         = 0;
 uint8_t  current_idle_frame = 0;
 // uint8_t current_prep_frame = 0; // uncomment if PREP_FRAMES >1
 uint8_t current_tap_frame = 0;
-char    wpm_str[12];
 
 /* Animation */
 
@@ -91,15 +90,6 @@ static const char PROGMEM ANIM_TAP[TAP_FRAMES][ANIM_SIZE] = {
 
 /* Functions */
 
-const char *wpm_state(void) {
-    uint8_t n = get_current_wpm();
-    // index:            01234567
-    char *wpm_counter = "WPM:    ";
-    wpm_counter[7]    = '0' + n % 10;
-    wpm_counter[6]    = (n /= 10) % 10 ? '0' + (n) % 10 : (n / 10) % 10 ? '0' : ' ';
-    wpm_counter[5]    = n / 10 ? '0' + n / 10 : ' ';
-    return wpm_counter;
-}
 
 void animation_phase(uint8_t wpm) {
     // NOTE: Optimized the conditional. We don't need to recheck each.

keyboards/lily58/keymaps/muppetjones/keymap.c

@@ -46,10 +46,10 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  */
 [_CLMK_DH] = LAYOUT_wrapper(
     KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_CAPS,                   __BLANK____________________________________, KC_BSPC,
-    KC_CAPS, __COLEMAK_MOD_DH_L1________________________,                   __COLEMAK_MOD_DH_R1________________________, KC_BSLS,
+    KC_CAPS, __COLEMAK_MOD_DH_L1________________________,                   __COLEMAK_MOD_DH_R1_W_QUOT_________________, KC_BSPC,
     HY_ESC,  __COLEMAK_MOD_DH_L2_W_GACS_________________,                   __COLEMAK_MOD_DH_R2_W_SCAG_________________, KC_QUOT,
     TD_LAYR, __COLEMAK_MOD_DH_L3_W_SFTV_________________, KC_CAPS, KC_TAB,  __COLEMAK_MOD_DH_R3________________________, KC_SFTENT,
-                                KC_DEL,  HY_ESC, LOW_SPC, RAI_ENT, HY_BSPC, NAV_SPC, HY_ESC, KC_BSPC
+                                XXXXXXX, XXXXXXX, HY_ESC, LOW_ENT, NAV_SPC, HY_BSPC, XXXXXXX, XXXXXXX
 ),
 
 /* QWERTY
@@ -97,10 +97,10 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  */
 [_LOWER] = LAYOUT_wrapper(
     _______, __BLANK____________________________________,                   __BLANK____________________________________, _______,
-    _______, __BLANK____________________________________,                   __NUMPAD_R1________________________________, _______,
-    _______, __BLANK_W_GACS_____________________________,                   __NUMPAD_R2________________________________, KC_PLUS,
-    _______, __BLANK____________________________________, _______, _______, __NUMPAD_R3________________________________, _______,
-                               __BLANK____________________________________, KC_0,    KC_DOT,  _______
+    _______, __SYMBOLS_L1_______________________________,                   __NUMPAD_R1________________________________, _______,
+    _______, __SYMBOLS_L2_______________________________,                   __NUMPAD_R2________________________________, KC_COMM,
+    _______, __SYMBOLS_L3_______________________________, _______, _______, __NUMPAD_R3________________________________, KC_DOT,
+                               _______, _______, _______, _______, KC_SPC,  KC_0,    KC_DOT,  _______
 ),
 /* RAISE
  * ,-----------------------------------------.                    ,-----------------------------------------.
@@ -126,7 +126,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 ),
 [_NAV] = LAYOUT_wrapper(
     _______, __BLANK____________________________________,                   __BLANK____________________________________, _______,
-    _______, __BLANK____________________________________,                   __NAV_R1___________________________________, _______,
+    _______, __VIM_L1___________________________________,                   __NAV_R1___________________________________, _______,
     _______, __BLANK_W_GACS_____________________________,                   __NAV_R2___________________________________, _______,
     _______, __BLANK____________________________________, _______, _______, __NAV_R3___________________________________, _______,
                                _______, _______, _______, _______, _______, _______, _______, _______
@@ -158,7 +158,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 };
 
 // SSD1306 OLED update loop, make sure to enable OLED_DRIVER_ENABLE=yes in rules.mk
-#ifdef OLED_DRIVER_ENABLE
+#ifdef OLED_ENABLE
 
 oled_rotation_t oled_init_user(oled_rotation_t rotation) {
     if (!is_keyboard_master()) return OLED_ROTATION_180;  // flips the display 180 degrees if offhand
@@ -206,7 +206,7 @@ const char *read_layer_state_user(void) {
     return layer_state_str;
 }
 
-void oled_task_user(void) {
+bool oled_task_user(void) {
     if (is_keyboard_master()) {
         // If you want to change the display of OLED, you need to change here
         oled_write_ln(read_layer_state_user(), false);
@@ -215,14 +215,16 @@ void oled_task_user(void) {
     } else {
         render_bongo_cat();
         oled_set_cursor(0, 6);
-        oled_write(wpm_state(), false);
+        oled_write_P(PSTR("WPM:  "), false);
+        oled_write(get_u8_str(get_current_wpm(), ' '), false);
     }
+    return false;
 }
 #endif  // OLED_DRIVER_ENABLE
 
 bool process_record_keymap(uint16_t keycode, keyrecord_t *record) {
     if (record->event.pressed) {
-#ifdef OLED_DRIVER_ENABLE
+#ifdef OLED_ENABLE
         set_keylog(keycode, record);
 #endif
         // set_timelog();

keyboards/lily58/keymaps/muppetjones/rules.mk

@@ -1,7 +1,8 @@
-OLED_DRIVER_ENABLE= yes     # OLED display
+OLED_ENABLE= yes     # OLED display
 WPM_ENABLE = yes
 TAP_DANCE_ENABLE = yes
 COMBO_ENABLE = yes
+EXTRAKEY_ENABLE = yes
 
 # If you want to change the display of OLED, you need to change here
 # SRC +=  ./lib/rgb_state_reader.c

keyboards/lily58/lib/layer_state_reader.c

@@ -7,30 +7,29 @@
 #define L_LOWER (1 << 1)
 #define L_RAISE (1 << 2)
 #define L_ADJUST (1 << 3)
-#define L_ADJUST_DUO (L_RAISE | L_LOWER)
 #define L_ADJUST_TRI (L_ADJUST | L_RAISE | L_LOWER)
 
 char layer_state_str[24];
 
 const char *read_layer_state(void) {
-    switch (layer_state) {
-        case L_BASE:
-            snprintf(layer_state_str, sizeof(layer_state_str), "Layer: Default");
-            break;
-        case L_RAISE:
-            snprintf(layer_state_str, sizeof(layer_state_str), "Layer: Raise");
-            break;
-        case L_LOWER:
-            snprintf(layer_state_str, sizeof(layer_state_str), "Layer: Lower");
-            break;
-        case L_ADJUST:
-        case L_ADJUST_DUO:
-        case L_ADJUST_TRI:
-            snprintf(layer_state_str, sizeof(layer_state_str), "Layer: Adjust");
-            break;
-        default:
-            snprintf(layer_state_str, sizeof(layer_state_str), "Layer: Undef-%ld", layer_state);
-    }
+  switch (layer_state)
+  {
+  case L_BASE:
+    snprintf(layer_state_str, sizeof(layer_state_str), "Layer: Default");
+    break;
+  case L_RAISE:
+    snprintf(layer_state_str, sizeof(layer_state_str), "Layer: Raise");
+    break;
+  case L_LOWER:
+    snprintf(layer_state_str, sizeof(layer_state_str), "Layer: Lower");
+    break;
+  case L_ADJUST:
+  case L_ADJUST_TRI:
+    snprintf(layer_state_str, sizeof(layer_state_str), "Layer: Adjust");
+    break;
+  default:
+    snprintf(layer_state_str, sizeof(layer_state_str), "Layer: Undef-%ld", layer_state);
+  }
 
-    return layer_state_str;
+  return layer_state_str;
 }

keyboards/planck/keymaps/muppetjones/config.h

@@ -1,3 +1,15 @@
+ /* Copyright 2020 Stephen Bush <muppetjones>
+  * 
+  * 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. 
+  */
 #pragma once
 
 #ifdef AUDIO_ENABLE

keyboards/planck/keymaps/muppetjones/keymap.c

@@ -123,9 +123,9 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  * 21.03.28: Completely revamped to contain 10-key numpad and symbols.
  */
 [_LOWER] = LAYOUT_planck_wrapper(
-    KC_TILD, KC_GRV,  KC_LPRN, KC_RPRN, KC_TILD, _______, _______, __NUMPAD_R1________________________________,
-    KC_LGUI, KC_LALT, HR_LBRC, HR_RBRC, KC_GRV,  _______, _______, __NUMPAD_R2________________________________,
-    XXXXXXX, XXXXXXX, KC_LCBR, KC_RCBR, KC_LSFT, _______, _______, __NUMPAD_R3________________________________,
+    __SYMBOLS_L1_______________________________, _______, _______, __NUMPAD_R1________________________________,
+    __SYMBOLS_L2_______________________________, _______, _______, __NUMPAD_R2________________________________,
+    __SYMBOLS_L3_______________________________, _______, _______, __NUMPAD_R3________________________________,
     _______, _______, _______, _______, _______, _______, _______, __NUMPAD_R4________________________________
 ),
 

keyboards/splitkb/kyria/keymaps/muppetjones/README.md

@@ -0,0 +1,11 @@
+# Kyria
+
+## Compile
+
+```shell
+make splitkb/kyria/rev1:muppetjones:avrdude-split-left
+```
+
+```shell
+make splitkb/kyria/rev1:muppetjones:avrdude-split-right
+```

keyboards/kyria/keymaps/muppetjones/config.h → keyboards/splitkb/kyria/keymaps/muppetjones/config.h

@@ -16,7 +16,7 @@
 
 #pragma once
 
-#ifdef OLED_DRIVER_ENABLE
+#ifdef OLED_ENABLE
 #    define OLED_DISPLAY_128X64
 #endif
 
@@ -36,7 +36,8 @@
 
 // Change "hold" time (default is 200 ms)
 // -- used for tap dance and other tap mods
-#define TAPPING_TERM 200
+// -- defined in user namespace
+// #define TAPPING_TERM 200
 
 // Prevent normal rollover on alphas from accidentally triggering mods.
 #define IGNORE_MOD_TAP_INTERRUPT
@@ -56,5 +57,4 @@
 
 // Allows media codes to properly register in macros and rotary encoder code
 #define TAP_CODE_DELAY 10
-
-#define COMBO_COUNT 1
+#define COMBO_TERM 40

keyboards/kyria/keymaps/muppetjones/keymap.c → keyboards/splitkb/kyria/keymaps/muppetjones/keymap.c

@@ -16,7 +16,6 @@
 #include QMK_KEYBOARD_H
 #include "muppetjones.h"
 #include "rgblight.h"
-#include <stdio.h>
 
 #define LAYOUT_wrapper(...) LAYOUT(__VA_ARGS__)
 
@@ -58,10 +57,10 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  *                        `----------------------------------'  `----------------------------------'
  */
 [_CLMK_DH] = LAYOUT_wrapper(
-    CAPSWRD, __COLEMAK_MOD_DH_L1________________________,                                     __COLEMAK_MOD_DH_R1________________________, KC_BSLS,
+    CAPSWRD, __COLEMAK_MOD_DH_L1________________________,                                     __COLEMAK_MOD_DH_R1_W_QUOT_________________, KC_BSLS,
     HY_ESC,  __COLEMAK_MOD_DH_L2_W_GACS_________________,                                     __COLEMAK_MOD_DH_R2_W_SCAG_________________, KC_QUOT,
     TD_LAYR, __COLEMAK_MOD_DH_L3________________________, KC_LSFT, KC_LEAD, KC_DEL,  KC_TAB,  __COLEMAK_MOD_DH_R3________________________, KC_SFTENT,
-                               KC_MUTE, KC_DEL,  HY_ESC,  LOW_SPC, RAI_ENT, KC_BSPC, NAV_SPC, HY_ESC,  RAI_TAB, KC_RALT
+                               KC_MUTE, KC_DEL,  HY_ESC,  LOW_BSP, RAI_ENT, KC_BSPC, NAV_SPC, HY_ESC,  RAI_TAB, KC_RALT
 ),
 [_QWERTY] = LAYOUT_wrapper(
     _______, __QWERTY_L1________________________________,                                     __QWERTY_R1________________________________, _______,
@@ -91,9 +90,9 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  */
     [_LOWER] = LAYOUT_wrapper(
       _______, __SYMBOLS_L1_______________________________,                                     __NUMPAD_R1________________________________, _______,
-      _______, __SYMBOLS_L2_______________________________,                                     __NUMPAD_R2________________________________, KC_PLUS,
-      _______, __SYMBOLS_L3_______________________________, _______, _______, _______, _______, __NUMPAD_R3________________________________, _______,
-                                 __BLANK____________________________________, _______, _______, KC_0,    KC_DOT,  _______
+      _______, __SYMBOLS_L2_______________________________,                                     __NUMPAD_R2________________________________, KC_COMM,
+      _______, __SYMBOLS_L3_______________________________, _______, _______, _______, _______, __NUMPAD_R3________________________________, KC_DOT,
+                                 __BLANK____________________________________, _______, KC_SPC,  KC_0,    KC_DOT,  _______
     ),
 /*
  * Raise Layer: Symbols
@@ -116,9 +115,9 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
     //                              _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
     // ),
     [_RAISE] = LAYOUT_wrapper(
-      _______, XXXXXXX, XXXXXXX, KC_GRV,  KC_GRV,  KC_BSLS,                                     XXXXXXX, XXXXXXX, KC_LPRN, KC_RPRN, KC_ASTR, _______,
-      _______, XXXXXXX, XXXXXXX, KC_UNDS, KC_MINS, KC_TILD,                                     KC_UNDS, KC_MINS, KC_LBRC, KC_RBRC, KC_PERC, _______,
-      _______, XXXXXXX, XXXXXXX, KC_PLUS, KC_EQL,  KC_GRV,  _______, _______, _______, _______, KC_PLUS, KC_EQL,  KC_LCBR, KC_RCBR, XXXXXXX, _______,
+      _______, XXXXXXX, XXXXXXX, KC_GRV,  KC_GRV,  KC_BSLS,                                     __SYMBOLS_R1_______________________________, _______,
+      _______, XXXXXXX, XXXXXXX, KC_UNDS, KC_MINS, KC_TILD,                                     __SYMBOLS_R2_______________________________, _______,
+      _______, XXXXXXX, XXXXXXX, KC_PLUS, KC_EQL,  KC_GRV,  _______, _______, _______, _______, __SYMBOLS_R3_______________________________, _______,
                                  __BLANK____________________________________, __BLANK____________________________________
     ),
 /*
@@ -136,16 +135,16 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  *                        `----------------------------------'  `----------------------------------'
  */
     [_NAV] = LAYOUT_wrapper(
-      _______, __SYMBOLS_L1_______________________________,                                     __NAV_R1___________________________________, KC_SLCK,
-      _______, __SYMBOLS_L2_______________________________,                                     __NAV_R2___________________________________, KC_CAPS,
-      _______, __SYMBOLS_L3_______________________________, _______, _______, _______, _______, __NAV_R3___________________________________, _______,
+      _______, __VIM_L1___________________________________,                                     __NAV_R1___________________________________, KC_SLCK,
+      _______, __BLANK_W_GACS_____________________________,                                     __NAV_R2___________________________________, KC_CAPS,
+      _______, __BLANK____________________________________, _______, _______, _______, _______, __NAV_R3___________________________________, _______,
                                  __BLANK____________________________________, __BLANK____________________________________
     ),
     /*
      * Adjust Layer: Function keys, RGB
      *
      * ,-------------------------------------------.                              ,-------------------------------------------.
-     * | RESET  |      |      |      |      |      |                              |      | F1   |  F2  | F3   | F4   |        |
+     * | RESET  |RESET |DEBUG |      |      |      |                              |      | F1   |  F2  | F3   | F4   |        |
      * |--------+------+------+------+------+------|                              |------+------+------+------+------+--------|
      * |        | TOG  | SAI  | HUI  | VAI  | MOD  |                              |      | F5   |  F6  | F7   | F8   |        |
      * |--------+------+------+------+------+------+-------------.  ,-------------+------+------+------+------+------+--------|
@@ -156,9 +155,9 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
      *                        `----------------------------------'  `----------------------------------'
      */
     [_ADJUST] = LAYOUT_wrapper(
-        RESET,   _______, _______, _______, _______, _______,                                     _______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   _______,
-        _______, RGB_TOG, RGB_SAI, RGB_HUI, RGB_VAI, RGB_MOD,                                     _______, KC_F5,   KC_F6,   KC_F7,   KC_F8,   _______,
-        _______, _______, RGB_SAD, RGB_HUD, RGB_VAD, RGB_RMOD,_______, _______, _______, _______, _______, KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______,
+        RESET,   __ADJUST_L1________________________________,                                     __MEDIA_R1_________________________________, _______,
+        _______, __ADJUST_L2________________________________,                                     __MEDIA_R2_________________________________, _______,
+        _______, __ADJUST_L3________________________________, _______, _______, _______, _______, __MEDIA_R3_________________________________, _______,
                                    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
     )
     // /*
@@ -252,19 +251,19 @@ bool encoder_update_standard(uint8_t index, bool clockwise) {
 
 #ifdef RGBLIGHT_ENABLE
 void set_layer_hsv(layer_state_t state, HSV* layer_color) {
-    int32_t h = layer_color->h, s = layer_color->s, v = layer_color->v;
+    uint16_t h = layer_color->h, s = layer_color->s, v = layer_color->v;
     switch (get_highest_layer(state)) {
         case _RAISE:
-            h += 2 * RGBLIGHT_HUE_STEP;
+            h += 3 * RGBLIGHT_HUE_STEP;
             break;
         case _LOWER:
-            h += -2 * RGBLIGHT_HUE_STEP;
+            h += -3 * RGBLIGHT_HUE_STEP;
             break;
         case _NAV:
-            h += 1 * RGBLIGHT_HUE_STEP;
+            h += 2 * RGBLIGHT_HUE_STEP;
             break;
         case _MOUSE:
-            h += -7 * RGBLIGHT_HUE_STEP;
+            h += -8 * RGBLIGHT_HUE_STEP;
             break;
         default:
             break;

keyboards/kyria/keymaps/muppetjones/rules.mk → keyboards/splitkb/kyria/keymaps/muppetjones/rules.mk

@@ -1,4 +1,4 @@
-OLED_DRIVER_ENABLE = no   # Enables the use of OLED displays
+OLED_ENABLE = no           # Enables the use of OLED displays
 ENCODER_ENABLE = yes       # Enables the use of one or more encoders
 RGBLIGHT_ENABLE = yes      # Enable keyboard RGB underglow
 LEADER_ENABLE = yes        # Enable the Leader Key feature

users/muppetjones/config.h

@@ -29,7 +29,7 @@
 #ifdef TAP_DANCE_ENABLE
 // Change "hold" time (default is 200 ms)
 // -- used for tap dance and other tap mods
-#    define TAPPING_TERM 200
+#    define TAPPING_TERM 175
 
 // Prevent normal rollover on alphas from accidentally triggering mods.
 #    define IGNORE_MOD_TAP_INTERRUPT
@@ -39,10 +39,6 @@
 
 #endif
 
-// Reduce firmware size
-// 	https://thomasbaart.nl/2018/12/01/reducing-firmware-size-in-qmk/
-// also requires EXTRAFLAGS in config.h
-#define NO_ACTION_MACRO
-#define NO_ACTION_FUNCTION
 
 #define COMBO_COUNT 3
+#define COMBO_TERM 40

users/muppetjones/features/combos.c

@@ -18,19 +18,19 @@
 #    include QMK_KEYBOARD_H
 
 enum combos {
-    K_H_TAB,
     H_COMM_TAB,
     L_U_SCLN,
+    J_M_CAPS,
 };
 
-const uint16_t PROGMEM k_h_tab[]    = {KC_K, KC_H, COMBO_END};
 const uint16_t PROGMEM h_comm_tab[] = {KC_H, KC_COMM, COMBO_END};
 const uint16_t PROGMEM l_u_scln[]   = {KC_L, KC_U, COMBO_END};
+const uint16_t PROGMEM j_m_caps[]   = {KC_J, KC_M, COMBO_END};
 
 // COMBO_COUNT defined in config.h
 combo_t key_combos[COMBO_COUNT] = {
-    [K_H_TAB]    = COMBO(k_h_tab, KC_TAB),
     [H_COMM_TAB] = COMBO(h_comm_tab, KC_TAB),
     [L_U_SCLN]   = COMBO(l_u_scln, KC_SCLN),
+    [J_M_CAPS]   = COMBO(j_m_caps, KC_CAPS),
 };
 #endif

users/muppetjones/readme/wrappers.md

@@ -0,0 +1,153 @@
+# Keymap Wrappers
+
+> Pattern adapted from users/drashna/wrapper.h
+
+Defines several object macros for common keycode sets. Each macro typically
+covers 5 keycodes with a left- or right-hand orientation, and macros are
+generally grouped into rows of three or four.
+
+> TODO: Use keymap builder to generate images.
+
+## Example
+
+```
+#define LAYOUT_wrapper(...) LAYOUT(__VA_ARGS__)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+// clang-format off
+[_MODS] = LAYOUT_wrapper(
+    _______, ___________________BLANK___________________, ...
+    ...
+),
+//clang-format on
+}
+```
+
+Substitute the appropriate `LAYOUT` function, e.g., `LAYOUT_planck_grid` for your board.
+
+## Wrappers
+
+> **How to Read the Tables**
+>
+> - Headers are numbered when wrapper is not hand-specific
+> - Headers use `L` and `R` to indicate handedness
+> - Headers use `P`, `R`, `M`, and `I` to indicate pinky, ring, middle, and index, respectively
+> - Wrappers define a maximum of **five** keycodes -- hands are shown on the same row for readability
+
+### Alpha: Colemak mod-DH
+
+| #   | LP  | LR  | LM  | LI  | LI+ | RI+ | RI  | RM  | RR  | RP  |
+| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
+| 1   | Q   | W   | F   | P   | B   | J   | L   | U   | Y   | ;ˆ  |
+| 2   | A°  | R°  | S°  | T°  | G   | M   | N°  | E°  | I°  | O°  |
+| 3   | Z   | X   | C   | D   | V˜  | K   | H   | ,   | .   | /   |
+
+- **ˆ:** (Optional) Replace `;` with `'` (top-right)
+- **°:** (Optional) Home row modifiers on tap-hold (GACS, SCAG)
+- **˜:** (Optional) Tap-hold `shift` on `v`
+
+### Alpha: QWERTY
+
+| #   | LP  | LR  | LM  | LI  | LI+ | RI+ | RI  | RM  | RR  | RP  |
+| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
+| 1   | Q   | W   | E   | R   | T   | Y   | U   | I   | O   | P   |
+| 2   | A   | S   | D   | F   | G   | H   | J   | K   | L   | ;   |
+| 3   | Z   | X   | C   | V   | B   | N   | M   | ,   | .   | /   |
+
+### Blank(-ish)
+
+Defines macros for common filler.
+
+| 1    | 2    | 3    | 4    | 5    |
+| ---- | ---- | ---- | ---- | ---- |
+| TRNS | TRNS | TRNS | TRNS | TRNS |
+| xxxx | xxxx | xxxx | xxxx | xxxx |
+
+| LP   | LR   | LM   | LI   | LI+  | RI+  | RI   | RM   | RR   | RP   |
+| ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- |
+| LGUI | LALT | LCTL | LSFT | TRNS | TRNS | RSFT | RCTL | LALT | RGUI |
+
+### Adjust
+
+| #   | LP     | LR    | LM   | LI    | LI+    | RI+  | RI     | RM     | RR   | RP   |
+| --- | ------ | ----- | ---- | ----- | ------ | ---- | ------ | ------ | ---- | ---- |
+| 1   | Reset  | Debug | xxxx | Term+ | Term-  | xxxx | AGNORM | AGSWAP | xxxx | xxxx |
+| 2   | RgbTog | Hue+  | Sat+ | Val+  | RgbMod | xxxx | CLMKDH | QWERTY | xxxx | xxxx |
+| 3   | xxxx   | Hue-  | Sat- | Val-  | xxxx   | xxxx | xxxx   | xxxx   | xxxx | xxxx |
+
+> Recommend: Define Right side per-board
+
+### Function
+
+| #   | 1   | 2   | 3   | 4   |
+| --- | --- | --- | --- | --- |
+| 1   | F1  | F2  | F3  | F4  |
+| 2   | F5  | F6  | F7  | F8  |
+| 3   | F9  | F10 | F11 | F12 |
+
+### Media
+
+| #   | 1     | 2     | 3     | 4    | 5    |
+| --- | ----- | ----- | ----- | ---- | ---- |
+| 1   | AuOn  | MiOn  | MuOn  | Brm+ | Vol+ |
+| 2   | AuOff | MiOff | MuOff | Brm- | Vol- |
+| 3   | Play  | Stop  | Next  | Prev | Mute |
+
+### Nav
+
+| #   | RI+   | RI   | RM    | RR    | RP    |
+| --- | ----- | ---- | ----- | ----- | ----- |
+| 1   | Pg Up | Home | Wh Dn | Wh Up | End   |
+| 2   | Pg Dn | Left | Down  | Up    | Right |
+| 3   | xxxx  | xxxx | xxxx  | xxxx  | xxxx  |
+
+### Numpad
+
+- `X Y` indicates the character `X` on keypress and character `Y` on `shift` keypress
+- Second table shows characters with `alt` keypress
+
+| #   | RI+   | RI    | RM    | RR    | RP    |
+| --- | ----- | ----- | ----- | ----- | ----- |
+| 1   | Del   | `7 &` | `8 _` | `9 (` |       |
+| 2   | `- _` | `4 $` | `5 %` | `6 ^` | `*`   |
+| 3   | `= +` | `1 !` | `2 @` | `3 #` | `, <` |
+| 4   |       | `0 )` | `. >` |       |       |
+
+| #   | RI+   | RI    | RM    | RR    | RP    |
+| --- | ----- | ----- | ----- | ----- | ----- |
+| 1   |       | `¶ ‡` | `• °` | `ª ·` | `« »` |
+| 2   | `– —` | `¢ ›` | `∞ fi` | `§ fl` | `° °` |
+| 3   | `≠ ±` | `¡ ⁄` | `™ €` | `£ ‹` | `≤ ¯` |
+| 4   |       |       | `º ‚` |       |       |
+
+### Symbols
+
+| #   | LP   | LR   | LM   | LI   | LI+  |
+| --- | ---- | ---- | ---- | ---- | ---- |
+| 1   | ~    | \`   | (    | )    |      |
+| 2   | LGUI | LALT | \[ ° | \] ° | \_ - |
+| 3   | xxxx | xxxx | {    | }    | LSFT |
+
+- **°:** Home row modifiers on tap-hold (GACS, SCAG)
+
+### VIM
+
+| #   | LP  | LR  | LM  | LI  | LI+ |
+| --- | --- | --- | --- | --- | --- |
+| 1   | Q°  | W°  | :   |     |     |
+
+- **°:** Via transparency
+
+## Typical Layers
+
+My keymaps typically use the following layers.
+
+| #   | Name       | Via           | Left      | Right  |
+| --- | ---------- | ------------- | --------- | ------ |
+| 0   | Colemak DH | Adjust        |           |        |
+| 1   | QWERTY     | Adjust        |           |        |
+| 2   | Mouse      | tap-dance     | n/a       | n/a    |
+| 3   | Lower      | L home thumb  | symbols   | numpad |
+| 4   | Raise      | L outer thumb |           |        |
+| 5   | Nav        | R home thumb  | home mods | nav    |
+| 6   | Adjust     | tap-dance     | RGB       | MEDIA  |

users/muppetjones/tapmods.h

@@ -33,9 +33,12 @@
 #define RAISE MO(_RAISE)
 #define NAV MO(_NAV)
 
+#define ADJ_DEL LT(_ADJUST, KC_DEL)
 #define LOW_ENT LT(_LOWER, KC_ENT)
 #define LOW_SPC LT(_LOWER, KC_SPC)
+#define LOW_BSP LT(_LOWER, KC_BSPC)
 #define NAV_SPC LT(_NAV, KC_SPC)
+#define RAI_BSP LT(_RAISE, KC_BSPC)
 #define RAI_ENT LT(_RAISE, KC_ENT)
 #define RAI_SPC LT(_RAISE, KC_SPC)
 #define RAI_TAB LT(_RAISE, KC_TAB)

users/muppetjones/wrappers.h

@@ -42,14 +42,29 @@
 #endif
 
 // clang-format off
-/* Blank-ish */
+/* Blank-ish
+ * ,----------------------------------. * ,----------------------------------.
+ * | TRNS | TRNS | TRNS | TRNS | TRNS | * | xxxx | xxxx | xxxx | xxxx | xxxx |
+ * `----------------------------------' * `----------------------------------'
+ * ,----------------------------------. * ,----------------------------------.
+ * | LGUI | LALT | LCTL | LSFT | TRNS | * | TRNS | RSFT | RCTL | LALT | RGUI |
+ * `----------------------------------' * `----------------------------------'
+*/
 #define __BLANK____________________________________ _______, _______, _______, _______, _______
 #define __BLANK_NOOP_______________________________ XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
-#define __BLANK_W_GACS_____________________________ KC_LGUI, KC_LALT, KC_LALT, KC_LSFT, _______
+#define __BLANK_W_GACS_____________________________ KC_LGUI, KC_LALT, KC_LCTL, KC_LSFT, _______
 #define __BLANK_W_SCAG_____________________________ _______, KC_RSFT, KC_RCTL, KC_LALT, KC_RGUI
 
-/* Adjust */
-// NOTE: The "BACKLIT" keycode is planck specific
+/* Adjust LH
+ * ,----------------------------------. ,----------------------------------.
+ * |Reset |Debug | xxxx |Term+ |Term- | | xxxx |AGNORM|AGSWAP| xxxx | xxxx |
+ * |------+------+------+------+------| |------+------+------+------+------|
+ * |RgbTog| Hue+ | Sat+ | Val+ |RgbMod| | xxxx |CLMKDH|QWERTY| xxxx | xxxx |
+ * |------+------+------+------+------| |------+------+------+------+------|
+ * | xxxx | Hue- | Sat- | Val- | xxxx | | xxxx | xxxx | xxxx | xxxx | xxxx |
+ * `----------------------------------' `----------------------------------'
+ */
+ // NOTE: The "BACKLIT" keycode is planck specific
 #define __ADJUST_L1________________________________ RESET,   DEBUG,   XXXXXXX, TERM_ON, TERM_OFF
 #define __ADJUST_L2________________________________ RGB_TOG, RGB_HUI, RGB_SAI, RGB_VAI, RGB_MOD
 #define __ADJUST_L3________________________________ XXXXXXX, RGB_HUD, RGB_SAD, RGB_VAD, XXXXXXX
@@ -58,7 +73,27 @@
 #define __ADJUST_R2________________________________ XXXXXXX, CLMK_DH, QWERTY,  XXXXXXX, XXXXXXX
 #define __ADJUST_R3________________________________ __BLANK_NOOP_______________________________
 
-/* COLEMAK mod-DH */
+/* Colemak mod-DH
+ * ,----------------------------------. ,----------------------------------.
+ * |   Q  |   W  |   F  |   P  |   B  | |   J  |   L  |   U  |   Y  |   ;ˆ |
+ * |------+------+------+------+------| |------+------+------+------+------|
+ * |   A  |   R  |   S  |   T  |   G  | |   M  |   N  |   E  |   I  |   O  |
+ * |------+------+------+------+------| |------+------+------+------+------|
+ * |   Z  |   X  |   C  |   D  |   V˜ | |   K  |   H  |   ,  |   .  |   /  |
+ * `----------------------------------' `----------------------------------'
+ *      ˆ Alternate: KC_QUOT
+ *      ° Alternate: Home row mods (GASC, SCAG)
+ *      ˜ Alternate: Hold for shift
+ *
+ * Colemak mod-DH (alt and alt+shift)
+ * ,----------------------------------. ,----------------------------------.
+ * | œ  Œ | ∑  „ |      | π  ∏ |    ı | | ∆  Ô |      |      | ¥  Á | æ  Æ |
+ * |------+------+------+------+------| |------+------+------+------+------|
+ * | å  Å | ®  ‰ | ß  Í | †  ˇ | ©  ˝ | | µ  Â | ˜  ˜ | ´  ´ | ˆ  ˆ |    Ø |
+ * |------+------+------+------+------| |------+------+------+------+------|
+ * | Ω  ¸ | ≈  ˛ | ç  Ç |    Î | √  ◊ | | ˚   |    Ó | ≤  ¯ | ≥  ˘ | ÷  ¿ |
+ * `----------------------------------' `----------------------------------'
+ */
 #define __COLEMAK_MOD_DH_L1________________________ KC_Q,    KC_W,    KC_F,     KC_P,   KC_B
 #define __COLEMAK_MOD_DH_L2_W_GACS_________________ HR_A,    HR_R,    HR_S,     HR_T,   KC_G
 #define __COLEMAK_MOD_DH_L3________________________ KC_Z,    KC_X,    KC_C,     KC_D,   KC_V
@@ -69,17 +104,41 @@
 #define __COLEMAK_MOD_DH_R2_W_SCAG_________________ KC_M,    HR_N,    HR_E,     HR_I,   HR_O
 #define __COLEMAK_MOD_DH_R3________________________ KC_K,    KC_H,    KC_COMM,  KC_DOT, KC_SLASH
 
+/* Function (4 columns)
+ * ,---------------------------.
+ * |  F1  |  F2  |  F3  |  F4  |
+ * |------+------+------+------|
+ * |  F5  |  F6  |  F7  |  F8  |
+ * |------+------+------+------|
+ * |  F9  |  F10 |  F11 |  F12 |
+ * `---------------------------'
+ */
+#define __FUNC_X1_________________________ KC_F1,   KC_F2,   KC_F3,   KC_F4
+#define __FUNC_X2_________________________ KC_F5,   KC_F6,   KC_F7,   KC_F8
+#define __FUNC_X3_________________________ KC_F9,   KC_F10,  KC_F11,  KC_F12
+
+/* Game
+ */
+#define __GAME_L1__________________________________ KC_BTN3, KC_BTN2, KC_UP,   KC_BTN1, KC_BTN5
+#define __GAME_L2__________________________________ KC_BTN4, KC_LEFT, KC_DOWN, KC_RIGHT,XXXXXXX
+#define __GAME_L3__________________________________ XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
+
+#define __GAME_R1__________________________________ KC_Q, KC_1, KC_2, KC_3, XXXXXXX
+#define __GAME_R2__________________________________ XXXXXXX, KC_4, KC_5, KC_6, XXXXXXX
+#define __GAME_R3__________________________________ XXXXXXX, KC_7, KC_8, KC_9, XXXXXXX
+
+
 /* Guitar
- * ,----------------------------------.
- * | Pg Up| Next | Prev | Brm+ | Vol+ |
- * |------+------+------+------+------|
- * | Pg Dn| Play | Stop | Brm- | Vol- |
- * |------+------+------+------+------|
- * | xxxx | xxxx | xxxx | xxxx | xxxx |
- * `----------------------------------'
+ * ,----------------------------------. ,----------------------------------.
+ * |  E   |  F   |• F♯  |  G   |• G♯  | |  A   |• A♯  |  B   |• C   |  C♯  |
+ * |  A   |  A♯  |• B   |  C   |• C♯  | |  D   |• D♯  |  E   |• F   |  F♯  |
+ * |  D   |  D♯  |• E   |  F   |• F♯  | |  G   |• G♯  |  A   |• A♯  |  B   |
+ * |  G   |  G♯  |• A   |  A♯  |• B   | |  C   |• C♯  |  D   |• D♯  |  E   |
+ * |  B   |  C   |• C♯  |  D   |• D♯  | |  E   |• F   |  F♯  |• G   |  G♯  |
+ * |  E   |  F   |• F♯  |  G   |• G♯  | |  A   |• A♯  |  B   |• C   |  C♯  |
+ * `----------------------------------' `----------------------------------'
  */
-//      _______, _______, _______, _______, _______, _______
-// Not sure why, but this does not work
+// Not sure why, but this does not work (possibly due to the lowercase 's'?)
 // #ifdef MIDI_ADVANCED
 // #define __GUITAR_1E_L______________________________ MI_E_1,  MI_F_1,  MI_Fs_1, MI_G_1,  MI_Gs_1
 // #define __GUITAR_2A_L______________________________ MI_A_1,  MI_As_1, MI_B_1,  MI_C_2,  MI_Cs_2
@@ -99,11 +158,11 @@
 
 /* MEDIA
  * ,----------------------------------.
- * | Pg Up| Next | Prev | Brm+ | Vol+ |
+ * | AuOn | MiOn | MuOn | Brm+ | Vol+ |
  * |------+------+------+------+------|
- * | Pg Dn| Play | Stop | Brm- | Vol- |
+ * | AuOff| MiOff| MuOff| Brm- | Vol- |
  * |------+------+------+------+------|
- * | xxxx | xxxx | xxxx | xxxx | xxxx |
+ * | Play | Stop | Next | Prev | Mute |
  * `----------------------------------'
  */
 // What it MUV_IN and MUV_DE (5C2A and B)?
@@ -126,25 +185,33 @@
 #define __NAV_R2___________________________________ KC_PGDN, KC_LEFT, KC_DOWN, KC_UP,   KC_RIGHT
 #define __NAV_R3___________________________________ __BLANK_NOOP_______________________________
 
-/* NUMPAD
- * ,----------------------------------.
- * | Bksp |  7 & |  8 * |  9 ( |  \ | |
- * |------+------+------+------+------|
- * |  - _ |  4 $ |  5 % |  6 ^ |  *   |
- * |------+------+------+------+------|
- * |  = + |  1 ! |  2 @ |  3 # |  |   |
- * |------+------+------+------+------|
- * |      |  0 ) |  . > |      |      |
- * `----------------------------------'
+/* NUMPAD * (alt, alt+shift)
+ * ,----------------------------------. * ,----------------------------------.
+ * | Del  |  7 & |  8 * |  9 ( |  \ | | * |      | ¶  ‡ | •  ° | ª  · | «  » |
+ * |------+------+------+------+------| * |------+------+------+------+------|
+ * |  - _ |  4 $ |  5 % |  6 ^ |  *   | * | –  — | ¢  › | ∞  fi | §  fl | °  ° |
+ * |------+------+------+------+------| * |------+------+------+------+------|
+ * |  = + |  1 ! |  2 @ |  3 # |  ,   | * | ≠  ± | ¡  ⁄ | ™  € | £  ‹ | ≤  ¯ |
+ * |------+------+------+------+------| * |------+------+------+------+------|
+ * |      |  0 ) |  . > |      |      | * |      |      | º  ‚ |      |      |
+ * `----------------------------------' * `----------------------------------'
  */
-#define __NUMPAD_R1________________________________ KC_BSPC, KC_7,    KC_8,    KC_9,    KC_BSLS
-#define __NUMPAD_R2________________________________ KC_MINS, HR_4,    HR_5,    HR_6,    KC_ASTR
-#define __NUMPAD_R3________________________________ KC_EQL,  KC_1,    KC_2,    KC_3,    KC_PIPE
+#define __NUMPAD_R1________________________________ KC_GRV,  KC_7,    KC_8,    KC_9,    KC_BSLS
+#define __NUMPAD_R2________________________________ KC_MINS, HR_4,    HR_5,    HR_6,    KC_COMM
+#define __NUMPAD_R3________________________________ KC_EQL,  KC_1,    KC_2,    KC_3,    KC_DOT
 #define __NUMPAD_R4________________________________ _______, KC_0,    KC_DOT,  _______, _______
 
 #define __NUMPAD_R3_ALT____________________________ KC_0,    KC_1,    KC_2,    KC_3,    KC_EQ
 
-/* QWERTY */
+/* Qwerty
+ * ,----------------------------------. ,----------------------------------.
+ * |   Q  |   W  |   E  |   R  |   T  | |   Y  |   U  |   I  |   O  |   P  |
+ * |------+------+------+------+------| |------+------+------+------+------|
+ * |   A  |   S  |   D  |   F  |   G  | |   H  |   J  |   K  |   L  |   ;  |
+ * |------+------+------+------+------| |------+------+------+------+------|
+ * |   Z  |   X  |   C  |   V  |   B  | |   N  |   M  |   ,  |   .  |   /  |
+ * `----------------------------------' `----------------------------------'
+ */
 #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
@@ -162,9 +229,21 @@
  * | xxxx | xxxx |  {   |  }   | LSFT |
  * `----------------------------------'
  */
- #define __SYMBOLS_L1_______________________________ KC_TILD, KC_GRV,  KC_LPRN, KC_RPRN, XXXXXXX
- #define __SYMBOLS_L2_______________________________ KC_LGUI, KC_LALT, HR_LBRC, HR_RBRC, KC_UNDS
- #define __SYMBOLS_L3_______________________________ XXXXXXX, XXXXXXX, KC_LCBR, KC_RCBR, KC_LSFT
+#define __SYMBOLS_L1_______________________________ KC_TILD, KC_GRV,  KC_LPRN, KC_RPRN, XXXXXXX
+#define __SYMBOLS_L2_______________________________ KC_LGUI, KC_LALT, HR_LBRC, HR_RBRC, KC_UNDS
+#define __SYMBOLS_L3_______________________________ XXXXXXX, XXXXXXX, KC_LCBR, KC_RCBR, KC_LSFT
+
+#define __SYMBOLS_R1_______________________________ KC_TILD, KC_LPRN, KC_RPRN, XXXXXXX, XXXXXXX
+#define __SYMBOLS_R2_______________________________ KC_UNDS, HR_LBRC, HR_RBRC, XXXXXXX, XXXXXXX
+#define __SYMBOLS_R3_______________________________ KC_PLUS, KC_LCBR, KC_RCBR, XXXXXXX, XXXXXXX
+
+/* VIM
+ * -- Roll through ":wq" via transparency
+ * ,----------------------------------.
+ * |   Q  |   W  |   :  |      |      |
+ * `----------------------------------'
+ */
+#define __VIM_L1___________________________________ _______, _______, KC_COLN, _______, _______
 
 // clang-format on
 // __END__