[Keymap] Update/refactor userspace and add keymaps for rmeli (#18398)

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Elliot Powell <johnp8727@gmail.com>

8 files changed, 268 insertions, 26 deletions

diff --git a/users/rmeli/.gitignore b/users/rmeli/.gitignore
new file mode 100644
index 0000000000..799fc4adc1
--- /dev/null
+++ b/users/rmeli/.gitignore
@@ -0,0 +1,2 @@
+# Ignore symlinks to keymaps
+km_*
\ No newline at end of file
diff --git a/users/rmeli/config.h b/users/rmeli/config.h
new file mode 100644
index 0000000000..1a6db91d1b
--- /dev/null
+++ b/users/rmeli/config.h
@@ -0,0 +1,44 @@
+/*
+Copyright 2021-2022 Rocco Meli <@RMeli>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#pragma once
+
+#define TAPPING_TERM 200
+
+#ifdef UNICODEMAP_ENABLE
+#    define UNICODE_SELECTED_MODES UC_MAC, UC_LNX
+#endif
+
+#ifdef AUTO_SHIFT_ENABLED
+#    define AUTO_SHIFT_REPEAT
+#endif
+
+#ifdef HOME_ROW_MODS_ENABLED
+#    define IGNORE_MOD_TAP_INTERRUPT
+#endif
+
+#ifdef CAPS_WORD_ENABLE
+#    define BOTH_SHIFTS_TURNS_ON_CAPS_WORD
+//#define DOUBLE_TAP_SHIFT_TURNS_ON_CAPS_WORD
+#endif
+
+#ifdef RGBLIGHT_ENABLE
+#    define RGBLIGHT_LIMIT_VAL 120
+#    define RGBLIGHT_HUE_STEP 10
+#    define RGBLIGHT_SAT_STEP 17
+#    define RGBLIGHT_VAL_STEP 17
+#endif
diff --git a/users/rmeli/keyrecords/tap_dances.h b/users/rmeli/keyrecords/tap_dances.h
index fa749a17f4..1d3018441e 100644
--- a/users/rmeli/keyrecords/tap_dances.h
+++ b/users/rmeli/keyrecords/tap_dances.h
@@ -16,6 +16,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #pragma once
+
 #include QMK_KEYBOARD_H
 
 // https://beta.docs.qmk.fm/using-qmk/software-features/feature_tap_dance#example-4-quad-function-tap-dance-id-example-4
@@ -26,9 +27,9 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 // Tap dance enums
 enum {
-    TD_LSPO_CAPS,  // Tap once for (, hold once for LSFT, tap twice for CAPS
-    TD_RSPC_CAPS,  // Tap once for ), hold once for RSFT, tap twice for CAPS
-    TD_ESC_DEL,    // Tap once for KC_ESC, twice for KC_DEL
+    TD_LSPO_CAPS, // Tap once for (, hold once for LSFT, tap twice for CAPS
+    TD_RSPC_CAPS, // Tap once for ), hold once for RSFT, tap twice for CAPS
+    TD_ESC_DEL,   // Tap once for KC_ESC, twice for KC_DEL
 };
 
 // Rename tap dances for keymap with shortcuts
diff --git a/users/rmeli/keyrecords/unicode.h b/users/rmeli/keyrecords/unicode.h
index 8e0c02d278..d818af02ee 100644
--- a/users/rmeli/keyrecords/unicode.h
+++ b/users/rmeli/keyrecords/unicode.h
@@ -16,6 +16,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #pragma once
+
 #include QMK_KEYBOARD_H
 
 // Needs to be active on the OS side as well
@@ -46,30 +47,30 @@ enum unicode_names {
 
 const uint32_t PROGMEM unicode_map[] = {
     // KC_A
-    [aGRV] = 0x00E0,  // à
-    [AGRV] = 0x00C0,  // À
-    [aUML] = 0x00E4,  // ä
-    [AUML] = 0x00C4,  // Ä
+    [aGRV] = 0x00E0, // à
+    [AGRV] = 0x00C0, // À
+    [aUML] = 0x00E4, // ä
+    [AUML] = 0x00C4, // Ä
     // KC_E
-    [eGRV] = 0x00E8,  // è
-    [EGRV] = 0x00C8,  // È
-    [eACT] = 0x00E9,  // é
-    [EACT] = 0x00C9,  // É
+    [eGRV] = 0x00E8, // è
+    [EGRV] = 0x00C8, // È
+    [eACT] = 0x00E9, // é
+    [EACT] = 0x00C9, // É
     // KC_I
-    [iGRV] = 0x00EC,  // ì
-    [IGRV] = 0x00CC,  // Ì
-    [iCIR] = 0x00EE,  // î
-    [ICIR] = 0x00CE,  // Î
+    [iGRV] = 0x00EC, // ì
+    [IGRV] = 0x00CC, // Ì
+    [iCIR] = 0x00EE, // î
+    [ICIR] = 0x00CE, // Î
     // KC_O
-    [oGRV] = 0x00F2,  // ò
-    [OGRV] = 0x00D2,  // Ò
-    [oUML] = 0x00F6,  // ö
-    [OUML] = 0x00D6,  // Ö
+    [oGRV] = 0x00F2, // ò
+    [OGRV] = 0x00D2, // Ò
+    [oUML] = 0x00F6, // ö
+    [OUML] = 0x00D6, // Ö
     // KC_U
-    [uGRV] = 0x00F9,  // ù
-    [UGRV] = 0x00D9,  // Ù
-    [uUML] = 0x00FC,  // ü
-    [UUML] = 0x00DC,  // Ü
+    [uGRV] = 0x00F9, // ù
+    [UGRV] = 0x00D9, // Ù
+    [uUML] = 0x00FC, // ü
+    [UUML] = 0x00DC, // Ü
 };
 
 // Accents
diff --git a/users/rmeli/keyrecords/wrappers.h b/users/rmeli/keyrecords/wrappers.h
new file mode 100644
index 0000000000..70ec4878bf
--- /dev/null
+++ b/users/rmeli/keyrecords/wrappers.h
@@ -0,0 +1,178 @@
+/*
+Copyright 2020 Christopher Courtney, aka Drashna Jael're  (@drashna) <drashna@live.com>
+Copyright 2020 @jola5
+Copyright 2021-2022 Rocco Meli <@RMeli>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#pragma once
+
+#ifdef UNICODEMAP_ENABLE
+#    include "keyrecords/unicode.h"
+#endif
+
+// + ------------- +
+// + HOME ROW MODS |
+// + ------------- +
+
+// https://precondition.github.io/home-row-mods
+
+// Left, QWERTY
+#define HM_A LCTL_T(KC_A)
+#define HM_S LALT_T(KC_S)
+#define HM_D LGUI_T(KC_D)
+#define HM_F LSFT_T(KC_F)
+
+// Left, COLEMAK
+#define HMCMK_A LCTL_T(KC_A)
+#define HMCMK_R LALT_T(KC_R)
+#define HMCMK_S LGUI_T(KC_S)
+#define HMCMK_T LSFT_T(KC_T)
+
+// Right, QWERTY
+#define HM_J RSFT_T(KC_J)
+#define HM_K RGUI_T(KC_K)
+#define HM_L LALT_T(KC_L) // LALT, not RALT
+#define HM_SCLN RCTL_T(KC_SCLN)
+
+// Right, COLEMAK
+#define HMCMK_N RSFT_T(KC_N)
+#define HMCMK_E RGUI_T(KC_E)
+#define HMCMK_I LALT_T(KC_I) // LALT, not RALT
+#define HMCMK_O RCTL_T(KC_O)
+
+// clang-format off
+
+// + ------ +
+// + QWERTY |
+// + ------ +
+
+#define _________QWERTY_HRM_LEFT__________    HM_A,    HM_S,    HM_D,    HM_F
+#define _________QWERTY_HRM_RIGHT_________    HM_J,    HM_K,    HM_L, HM_SCLN
+
+#define _______________QWERTY_L1_x5________________    KC_Q,    KC_W,    KC_E,    KC_R,    KC_T
+#ifdef HOME_ROW_MODS_ENABLED
+#define _______________QWERTY_L2_x5________________ _________QWERTY_HRM_LEFT__________,    KC_G
+#else
+#define _______________QWERTY_L2_x5________________    KC_A,    KC_S,    KC_D,    KC_F,    KC_G
+#endif
+#define _______________QWERTY_L3_x5________________    KC_Z,    KC_X,    KC_C,    KC_V,    KC_B
+
+#define _______________QWERTY_R1_x5________________    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P
+#ifdef HOME_ROW_MODS_ENABLED
+#define _______________QWERTY_R2_x5________________    KC_H, _________QWERTY_HRM_RIGHT_________
+#else
+#define _______________QWERTY_R2_x5________________    KC_H,    KC_J,    KC_K,    KC_L, KC_SCLN
+#endif
+#define _______________QWERTY_R3_x5________________    KC_N,    KC_M, KC_COMM,  KC_DOT, KC_SLSH
+
+// + ------ +
+
+#define ___________________QWERTY_L1_x6_____________________  KC_TAB, _______________QWERTY_L1_x5________________
+#define ___________________QWERTY_L2_x6_____________________   TD_ED, _______________QWERTY_L2_x5________________
+#define ___________________QWERTY_L3_x6_____________________ TD_LSPC, _______________QWERTY_L3_x5________________
+#define ___________________QWERTY_R1_x6_____________________ _______________QWERTY_R1_x5________________, KC_BSPC
+#define ___________________QWERTY_R2_x6_____________________ _______________QWERTY_R2_x5________________, KC_QUOT
+#define ___________________QWERTY_R3_x6_____________________ _______________QWERTY_R3_x5________________, TD_RSPC
+
+// + -------------- +
+// + COLEMAK_MOD_DH |
+// + -------------- +
+
+#define _____COLEMAK_MOD_DH_HRM_LEFT______ HMCMK_A, HMCMK_R, HMCMK_S, HMCMK_T
+#define _____COLEMAK_MOD_DH_HMR_RIGHT_____ HMCMK_N, HMCMK_E, HMCMK_I, HMCMK_O
+
+#define ____________COLEMAK_MOD_DH_L1_x5___________    KC_Q,    KC_W,    KC_F,    KC_P,    KC_B
+#ifdef HOME_ROW_MODS_ENABLED
+#define ____________COLEMAK_MOD_DH_L2_x5___________ _____COLEMAK_MOD_DH_HRM_LEFT______,    KC_G
+#else
+#define ____________COLEMAK_MOD_DH_L2_x5___________    KC_A,    KC_R,    KC_S,    KC_T,    KC_G
+#endif
+#define ____________COLEMAK_MOD_DH_L3_x5___________    KC_Z,    KC_X,    KC_C,    KC_D,    KC_V
+
+#define ____________COLEMAK_MOD_DH_R1_x5___________    KC_J,    KC_L,    KC_U,    KC_Y, KC_SCLN
+#ifdef HOME_ROW_MODS_ENABLED
+#define ____________COLEMAK_MOD_DH_R2_x5___________    KC_M, _____COLEMAK_MOD_DH_HMR_RIGHT_____
+#else
+#define ____________COLEMAK_MOD_DH_R2_x5___________    KC_M,    KC_N,    KC_E,    KC_I,    KC_O
+#endif
+#define ____________COLEMAK_MOD_DH_R3_x5___________    KC_K,    KC_H, KC_COMM,  KC_DOT,KC_SLASH
+
+// + ------- +
+
+#define ________________COLEMAK_MOD_DH_L1_x6________________  KC_TAB, ____________COLEMAK_MOD_DH_L1_x5___________
+#define ________________COLEMAK_MOD_DH_L2_x6________________   TD_ED, ____________COLEMAK_MOD_DH_L2_x5___________
+#define ________________COLEMAK_MOD_DH_L3_x6________________ TD_LSPC, ____________COLEMAK_MOD_DH_L3_x5___________
+#define ________________COLEMAK_MOD_DH_R1_x6________________ ____________COLEMAK_MOD_DH_R1_x5___________, KC_BSPC
+#define ________________COLEMAK_MOD_DH_R2_x6________________ ____________COLEMAK_MOD_DH_R2_x5___________, KC_QUOT
+#define ________________COLEMAK_MOD_DH_R3_x6________________ ____________COLEMAK_MOD_DH_R3_x5___________, TD_RSPC
+
+// + --------------- +
+// + NUMBERS/SYMBOLS |
+// + --------------- +
+
+#define ______________NUMBER_LEFT_x5_______________    KC_1,    KC_2,    KC_3,    KC_4,    KC_5
+#define ______________NUMBER_RIGHT_x5______________    KC_6,    KC_7,    KC_8,    KC_9,    KC_0
+#define ___________________NUMBER_LEFT_x6___________________  KC_GRV, ______________NUMBER_LEFT_x5_______________
+#define ___________________NUMBER_RIGHT_x6__________________ ______________NUMBER_RIGHT_x5______________, KC_MINS
+
+#define ______________SYMBOL_LEFT_x5_______________ KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC
+#define ______________SYMBOL_RIGHT_x5______________ KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN
+#define ___________________SYMBOL_LEFT_x6___________________  KC_GRV, ______________SYMBOL_LEFT_x5_______________
+#define ___________________SYMBOL_RIGHT_x6__________________ ______________SYMBOL_RIGHT_x5______________, KC_TILD
+
+#define ____________________SYMBOL_R2_x6____________________ KC_MINS,  KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS,  KC_GRV
+#define ____________________SYMBOL_R3_x6____________________ KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE, KC_TILD
+
+// + ------- +
+// + UNICODE |
+// + ------- +
+
+#ifdef UNICODEMAP_ENABLE
+#define ______________UNICODE_L2_x5________________   A_GRV,   E_GRV,   I_GRV,   O_GRV,   U_GRV
+#define ______________UNICODE_L3_x5________________   A_UML,   E_ACT,   I_CIR,   O_UML,   U_UML
+#endif
+
+// + ---- +
+// + FUNC |
+// + ---- +
+
+#define ______________FUNC_LEFT_5x_________________   KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5
+#define ______________FUNC_RIGHT_5x________________   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10
+#define ____________________FUNC_LEFT_x6____________________ ______________FUNC_LEFT_5x_________________, KC_F6
+#define ____________________FUNC_RIGHT_x6___________________ KC_F7, ______________FUNC_RIGHT_5x________________
+
+// + ---- +
+// + MISC |
+// + ---- +
+
+#define _________________BLANK_5x__________________ _______, _______, _______, _______, _______
+#define ______________________BLANK_6x______________________ _________________BLANK_5x__________________, _______
+
+#define _________________NONE_5x___________________ XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
+#define ______________________NONE_6x_______________________ _________________NONE_5x___________________, XXXXXXX
+
+#define ________________NAV_R2_x5__________________ XXXXXXX, XXXXXXX,   KC_UP, XXXXXXX, KC_PGUP
+#define ________________NAV_R3_x5__________________ XXXXXXX, KC_LEFT, KC_DOWN, KC_RGHT, KC_PGDN
+#define ____________NAV_VIM_x4____________ KC_LEFT, KC_DOWN,  KC_UP, KC_RIGHT
+
+#define _______________CONFIG_R1_x5________________ UC_MOD,  KC_ASUP,   NK_ON, XXXXXXX, XXXXXXX
+#define _______________CONFIG_R2_x5________________ XXXXXXX, KC_ASTG, NK_TOGG, CG_TOGG, XXXXXXX
+#define _______________CONFIG_R3_x5________________ UC_RMOD, KC_ASDN,  NK_OFF, CG_NORM, XXXXXXX
+
+#define ________________RGB_L2_x5__________________  RGB_MOD, RGB_HUI, RGB_SAI, RGB_VAI, RGB_SPI
+#define ________________RGB_L3_x5__________________ RGB_RMOD, RGB_HUD, RGB_SAD, RGB_VAD, RGB_SPD
+
+// clang-format on
diff --git a/users/rmeli/oled/oled.c b/users/rmeli/oled/oled.c
index d6d4b2c43c..27c1e9c600 100644
--- a/users/rmeli/oled/oled.c
+++ b/users/rmeli/oled/oled.c
@@ -18,6 +18,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "oled/oled.h"
 
 void oled_render_rocco(void) {
+    // clang-format off
     static const char PROGMEM rocco[] = {
         // 'rocco', 128x32px
         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf0, 0xf8, 0xf8, 0xf8, 0x18, 
@@ -53,10 +54,13 @@ void oled_render_rocco(void) {
         0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x07, 0x0f, 0x0e, 0x1c, 0x1c, 0x18, 0x18, 0x18, 0x18, 0x18, 
         0x1c, 0x0e, 0x0f, 0x07, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
     };
+    // clang-format on
+
     oled_write_raw_P(rocco, sizeof(rocco));
 }
 
 void oled_render_meli(void) {
+    // clang-format off
     static const char PROGMEM meli[] = {
         // 'meli', 128x32px
         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
@@ -92,5 +96,7 @@ void oled_render_meli(void) {
         0x18, 0x1f, 0x1f, 0x1f, 0x18, 0x18, 0x18, 0x18, 0x18, 0x18, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
     };
+    // clang-format on
+
     oled_write_raw_P(meli, sizeof(meli));
 }
diff --git a/users/rmeli/rmeli.h b/users/rmeli/rmeli.h
index e6f51d4908..d3533db7c3 100644
--- a/users/rmeli/rmeli.h
+++ b/users/rmeli/rmeli.h
@@ -15,6 +15,10 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+#pragma once
+
+#include "keyrecords/wrappers.h"
+
 #ifdef UNICODEMAP_ENABLE
 #    include "keyrecords/unicode.h"
 #endif
@@ -25,4 +29,4 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 #ifdef TAP_DANCE_ENABLE
 #    include "keyrecords/tap_dances.h"
-#endif
\ No newline at end of file
+#endif
diff --git a/users/rmeli/rules.mk b/users/rmeli/rules.mk
index 293685e08b..db68d6326c 100644
--- a/users/rmeli/rules.mk
+++ b/users/rmeli/rules.mk
@@ -1,11 +1,12 @@
 # https://github.com/qmk/qmk_firmware/blob/develop/docs/squeezing_avr.md
 CONSOLE_ENABLE = no
-COMMAND_ENABLE = no # Needed for Space Cadet Shift
+COMMAND_ENABLE = no # Turned off for Space Cadet Shift and Caps Word
 MOUSEKEY_ENABLE = no
 SPACE_CADET_ENABLE = no # Implemented with tap dance
 GRAVE_ESC_ENABLE = no
-MAGIC_ENABLE = no
 MUSIC_ENABLE = no
+CAPS_WORD_ENABLE = yes
+HOME_ROW_MODS_ENABLE = yes
 
 # VIA only support 4 layers by default
 # Use "#define DYNAMIC_KEYMAP_LAYER_COUNT" in config.h to change the limit
@@ -17,4 +18,9 @@ endif
 
 ifeq ($(strip $(TAP_DANCE_ENABLE)), yes)
     SRC += $(USER_PATH)/keyrecords/tap_dances.c
+endif
+
+ifeq ($(strip $(HOME_ROW_MODS_ENABLE)), yes)
+    # Define custom variable
+    OPT_DEFS += -DHOME_ROW_MODS_ENABLED
 endif
\ No newline at end of file