[Keymap] Updates to ortho_4x12/buswerks keymap (#4996)

* Added buswerks keymap

* cleaned up comments on buswerks keymap

* Added buswerks keymap readme.md

* Fixed spelling in buswerks readme.md

* Removed unnecessary includes, changed process_record_user to now use set_single_persistent_default_layer(), removed deprecated functions, and moved the audio ifdef block to config.h

* Changed buswerks ortho_4x12 layout to accommodate 'MIT' layout

* Updated README.md to reflect layout changes

* update buswerks keymap

* add buswerks tragicforce68 keymap

* add rotary encoder support

* update readme

* fix image link in readme

* fix KC_NO shorthand

layouts/community/ortho_4x12/buswerks/config.h

@@ -13,10 +13,15 @@
 
 #ifdef AUDIO_ENABLE 
     #define STARTUP_SONG SONG(PLANCK_SOUND) 
-     // #define STARTUP_SONG SONG(NO_SOUND) 
-  
+    // #define STARTUP_SONG SONG(NO_SOUND) 
     #define DEFAULT_LAYER_SONGS { SONG(QWERTY_SOUND), \
                                 	SONG(COLEMAK_SOUND), \
                                     SONG(DVORAK_SOUND) \
                                 } 
-#endif 
+#endif 
+
+// MIDI notes can be sent when in Music mode
+#define MIDI_BASIC
+
+// Most tactile encoders have detents every 4 stages
+#define ENCODER_RESOLUTION 4

layouts/community/ortho_4x12/buswerks/keymap.c

@@ -2,183 +2,174 @@
 
 extern keymap_config_t keymap_config;
 
-#define _QWERTY 0
-#define _COLEMAK 1
-#define _DVORAK 2
-#define _LOWER 3
-#define _RAISE 4
-#define _MOUSE 5
-#define _ADJUST 16
+enum layers {
+    _QWERTY,
+    _COLEMAK,
+    _DVORAK,
+    _LOWER,
+    _RAISE,
+    _GAME,
+    _ADJUST
+};
 
 enum custom_keycodes {
-  QWERTY = SAFE_RANGE,
-  COLEMAK,
-  DVORAK,
-  LOWER,
-  RAISE,
-  MOUSE,
-  ADJUST,
+    QWERTY = SAFE_RANGE,
+    COLEMAK,
+    DVORAK,
+    LOWER,
+    RAISE,
+    GAME,
+    ADJUST
 };
 
-// Fillers to make layering more clear
-#define _______ KC_TRNS
-#define KC_     KC_TRNS
-#define XXXXXXX KC_NO
-
-#define ESC_CMD MT(MOD_LGUI, KC_ESC)
+#define GAME TG(_GAME)
 #define RSE_ENT LT(_RAISE, KC_ENT)
-#define KC_LOWR LOWER
-#define KC_RASE RAISE
-#define KC_ADJ  ADJUST
-#define MOUSE   TG(_MOUSE)
-
-#define DESK_L  LCTL(KC_LEFT)
-#define DESK_R  LCTL(KC_RGHT)
-#define MSN_CTL LCTL(KC_UP)
-#define APP_WND LCTL(KC_DOWN)
-#define SWITCHR LGUI(KC_TAB)
-
-#define WORD_L  LALT(KC_LEFT)
-#define WORD_R  LALT(KC_RGHT)
-#define LINE_L  LGUI(KC_LEFT)
-#define LINE_R  LGUI(KC_RGHT)
-
-#define COPY    LGUI(KC_C)
-#define CUT     LGUI(KC_X)
-#define PASTE   LGUI(KC_V)
+#define ESC_CTL LCTL_T(KC_ESC) // for Linux
+#define ESC_CMD LGUI_T(KC_ESC) // for macOS
 
-const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+// Use these to switch desktops on macOS
+#define DESK_L LCTL(KC_LEFT)
+#define DESK_R LCTL(KC_RGHT)
 
-[_QWERTY] = LAYOUT_ortho_4x12(
-  // .--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------.
-       KC_TAB , KC_Q   , KC_W   , KC_E   , KC_R   , KC_T   , KC_Y   , KC_U   , KC_I,    KC_O   , KC_P   , KC_BSPC, \
-  // |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
-       ESC_CMD, KC_A   , KC_S   , KC_D   , KC_F   , KC_G   , KC_H   , KC_J   , KC_K,    KC_L   , KC_SCLN, KC_QUOT, \
-  // |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
-       KC_LSPO, KC_Z   , KC_X   , KC_C   , KC_V   , KC_B   , KC_N   , KC_M   , KC_COMM, KC_DOT , KC_SLSH, KC_RSPC, \
-  // |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
-       KC_LCTL, KC_HYPR, MOUSE  , KC_LALT, LOWER  , KC_SPC , KC_SPC , RSE_ENT, KC_LEFT, KC_DOWN, KC_UP  , KC_RGHT \
-  // '--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------'
-),
-
-[_COLEMAK] = LAYOUT_ortho_4x12( \
-  // .--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------.
-       KC_TAB , KC_Q   , KC_W   , KC_F   , KC_P   , KC_G   , KC_J   , KC_L   , KC_U   , KC_Y   , KC_SCLN, KC_BSPC, \
-  // |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
-       ESC_CMD, KC_A   , KC_R   , KC_S   , KC_T   , KC_D   , KC_H   , KC_N   , KC_E   , KC_I   , KC_O   , KC_QUOT, \
-  // |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
-       KC_LSPO, KC_Z   , KC_X   , KC_C   , KC_V   , KC_B   , KC_K   , KC_M   , KC_COMM, KC_DOT , KC_SLSH, KC_RSPC, \
-  // |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
-       KC_LCTL, KC_HYPR, MOUSE  , KC_LALT, LOWER  , KC_SPC , KC_SPC , RSE_ENT, KC_LEFT, KC_DOWN, KC_UP  , KC_RGHT \
-  // '--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------'
-),
-
-[_DVORAK] = LAYOUT_ortho_4x12( \
-  // .--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------.
-       KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC, \
-  // |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
-       ESC_CMD, KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH, \
-  // |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
-       KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT , \
-  // |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
-       KC_LCTL, KC_HYPR, MOUSE  , KC_LALT, LOWER  , KC_SPC , KC_SPC , RSE_ENT, KC_LEFT, KC_DOWN, KC_UP  , KC_RGHT \
-  // '--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------'
-),
-
-[_LOWER] = LAYOUT_ortho_4x12( \
-  // .--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------.
-       SWITCHR, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_7,    KC_8,    KC_9,    KC_MINS, _______, \
-  // |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
-       KC_TILD, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_4,    KC_5,    KC_6,    KC_PLUS, KC_PIPE, \
-  // |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
-       _______, _______, _______, KC_UNDS, KC_EQL,  _______, _______, KC_1,    KC_2,    KC_3,    _______, _______, \
-  // |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
-       _______, _______, _______, _______, _______, _______, _______, KC_0,    KC_DOT,  KC_COMM, _______, _______ \
-  // '--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------'
-),
-
-[_RAISE] = LAYOUT_ortho_4x12( \
-  // .--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------.
-       KC_GRV,  KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_UNDS, KC_EQL,  KC_DEL, \
-  // |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
-       _______, _______, KC_LBRC, KC_LCBR, KC_RCBR, KC_RBRC, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, _______, KC_BSLS, \
-  // |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
-       _______, _______, _______, _______, _______, _______, LINE_L,  WORD_L,  WORD_R,  LINE_R,  _______, _______, \
-  // |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
-       _______, _______, _______, _______, _______, _______, _______, _______, KC_MPRV, KC_VOLD, KC_VOLU, KC_MNXT \
-  // '--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------'
-),
-
-[_MOUSE] = LAYOUT_ortho_4x12( \
-  // .--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------.
-       SWITCHR, _______, _______, KC_MS_U, _______, _______, _______, KC_ACL0, KC_ACL1, KC_ACL2, _______, _______, \
-  // |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
-       _______, _______, KC_MS_L, KC_MS_D, KC_MS_R, _______, _______, KC_BTN1, KC_BTN2, KC_BTN3, _______, _______, \
-  // |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
-       _______, _______, _______, KC_WH_U, KC_WH_D, COPY,    PASTE,   KC_BTN4, KC_BTN5, _______, _______, _______, \
-  // |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
-       _______, _______, MOUSE  , _______, _______, KC_SPC,  KC_SPC,  KC_ENT,  KC_LEFT, KC_DOWN, KC_UP  , KC_RGHT \
-  // '--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------'
-),
-
-[_ADJUST] =  LAYOUT_ortho_4x12( \
-  _______, QWERTY,  COLEMAK, DVORAK,  RESET,   _______, _______, _______, _______, AG_NORM, AG_SWAP, _______, \
-  _______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   _______, _______, AU_OFF , AU_ON  , _______, \
-  _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______, _______, _______, _______, _______, \
-  _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ \
-)
+// Use these to switch desktops on Gnome
+#define DESK_UP LGUI(KC_PGUP)
+#define DESK_DN LGUI(KC_PGDN)
 
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+    // Use QWERTY on macOS (Colemak mapped using software)
+    [_QWERTY] = LAYOUT_ortho_4x12(
+            KC_TAB , KC_Q   , KC_W   , KC_E   , KC_R   , KC_T   , KC_Y   , KC_U   , KC_I,    KC_O   , KC_P   , KC_BSPC, \
+            ESC_CMD, KC_A   , KC_S   , KC_D   , KC_F   , KC_G   , KC_H   , KC_J   , KC_K,    KC_L   , KC_SCLN, KC_QUOT, \
+            KC_LSPO, KC_Z   , KC_X   , KC_C   , KC_V   , KC_B   , KC_N   , KC_M   , KC_COMM, KC_DOT , KC_SLSH, KC_RSPC, \
+            XXXXXXX, KC_LCTL, KC_LGUI, KC_LALT, LOWER  , KC_SPC , KC_SPC , RSE_ENT, KC_LEFT, KC_DOWN, KC_UP  , KC_RGHT \
+            ),
+
+    // Use Colemak on Linux (No native Colemak mapping)
+    [_COLEMAK] = LAYOUT_ortho_4x12( \
+            KC_TAB , KC_Q   , KC_W   , KC_F   , KC_P   , KC_G   , KC_J   , KC_L   , KC_U   , KC_Y   , KC_SCLN, KC_BSPC, \
+            ESC_CTL, KC_A   , KC_R   , KC_S   , KC_T   , KC_D   , KC_H   , KC_N   , KC_E   , KC_I   , KC_O   , KC_QUOT, \
+            KC_LSPO, KC_Z   , KC_X   , KC_C   , KC_V   , KC_B   , KC_K   , KC_M   , KC_COMM, KC_DOT , KC_SLSH, KC_RSPC, \
+            XXXXXXX, KC_LCTL, KC_LGUI, KC_LALT, LOWER  , KC_SPC , KC_SPC , RSE_ENT, KC_LEFT, KC_DOWN, KC_UP  , KC_RGHT \
+            ),
+
+    [_DVORAK] = LAYOUT_ortho_4x12( \
+            KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC, \
+            ESC_CTL, KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH, \
+            KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT , \
+            XXXXXXX, KC_LCTL, KC_LGUI, KC_LALT, LOWER  , KC_SPC , KC_SPC , RSE_ENT, KC_LEFT, KC_DOWN, KC_UP  , KC_RGHT \
+            ),
+
+    [_LOWER] = LAYOUT_ortho_4x12( \
+            KC_GRV,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_7,    KC_8,    KC_9,    KC_MINS, _______, \
+            KC_TILD, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_4,    KC_5,    KC_6,    KC_PLUS, KC_PIPE, \
+            _______, _______, _______, KC_UNDS, KC_EQL,  _______, _______, KC_1,    KC_2,    KC_3,    _______, _______, \
+            _______, _______, _______, _______, _______, _______, _______, KC_0,    KC_DOT,  KC_COMM, _______, _______ \
+            ),
+
+    [_RAISE] = LAYOUT_ortho_4x12( \
+            KC_GRV,  KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, _______, KC_INS,  KC_DEL, \
+            KC_TILD, _______, KC_LBRC, KC_LCBR, KC_RCBR, KC_RBRC, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, _______, KC_BSLS, \
+            _______, _______, _______, _______, _______, _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END,  _______, _______, \
+            _______, _______, _______, _______, _______, _______, _______, _______, DESK_R,  DESK_DN, DESK_UP, DESK_L \
+            ),
+
+    [_GAME] = LAYOUT_ortho_4x12( \
+            KC_TAB , KC_Q   , KC_W   , KC_F   , KC_P   , KC_G   , KC_J   , KC_L   , KC_U   , KC_Y   , KC_SCLN, KC_BSPC, \
+            ESC_CMD, KC_A   , KC_R   , KC_S   , KC_T   , KC_D   , KC_H   , KC_N   , KC_E   , KC_I   , KC_O   , KC_QUOT, \
+            KC_LSFT, KC_Z   , KC_X   , KC_C   , KC_V   , KC_B   , KC_K   , KC_M   , KC_COMM, KC_DOT , KC_SLSH, KC_ENT, \
+            xxxxxxx, KC_LCTL, KC_LGUI, KC_LALT, LOWER  , KC_SPC , KC_SPC , RSE_ENT, KC_LEFT, KC_DOWN, KC_UP  , KC_RGHT \
+            ),
+
+    [_ADJUST] = LAYOUT_planck_grid(
+            _______, RESET,   DEBUG,   _______, _______, _______, _______, _______, _______,  _______, _______, KC_DEL ,
+            _______, _______, MU_MOD,  AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK,  DVORAK,  GAME,    _______,
+            _______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______,  _______, _______, _______,
+            _______, _______, _______, _______, _______, _______, _______, _______, _______,  _______, _______, _______
+            )
 
 };
 
 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
-  switch (keycode) {
-    case QWERTY:
-      if (record->event.pressed) {
-        set_single_persistent_default_layer(_QWERTY);
-      }
-      return false;
-      break;
-    case COLEMAK:
-      if (record->event.pressed) {
-        set_single_persistent_default_layer(_COLEMAK);
-      }
-      return false;
-      break;
-    case DVORAK:
-      if (record->event.pressed) {
-        set_single_persistent_default_layer(_DVORAK);
-      }
-      return false;
-      break;
-    case LOWER:
-      if (record->event.pressed) {
-        layer_on(_LOWER);
-        update_tri_layer(_LOWER, _RAISE, _ADJUST);
-      } else {
-        layer_off(_LOWER);
-        update_tri_layer(_LOWER, _RAISE, _ADJUST);
-      }
-      return false;
-      break;
-    case RAISE:
-      if (record->event.pressed) {
-        layer_on(_RAISE);
-        update_tri_layer(_LOWER, _RAISE, _ADJUST);
-      } else {
-        layer_off(_RAISE);
-        update_tri_layer(_LOWER, _RAISE, _ADJUST);
-      }
-      return false;
-      break;
-    case ADJUST:
-      if (record->event.pressed) {
-        layer_on(_ADJUST);
-      } else {
-        layer_off(_ADJUST);
-      }
-      return false;
-      break;
-  }
-  return true;
-}
+    switch (keycode) {
+        case QWERTY:
+            if (record->event.pressed) {
+                set_single_persistent_default_layer(_QWERTY);
+            }
+            return false;
+            break;
+        case COLEMAK:
+            if (record->event.pressed) {
+                set_single_persistent_default_layer(_COLEMAK);
+            }
+            return false;
+            break;
+        case DVORAK:
+            if (record->event.pressed) {
+                set_single_persistent_default_layer(_DVORAK);
+            }
+            return false;
+            break;
+        case LOWER:
+            if (record->event.pressed) {
+                layer_on(_LOWER);
+                update_tri_layer(_LOWER, _RAISE, _ADJUST);
+            } else {
+                layer_off(_LOWER);
+                update_tri_layer(_LOWER, _RAISE, _ADJUST);
+            }
+            return false;
+            break;
+        case RAISE:
+            if (record->event.pressed) {
+                layer_on(_RAISE);
+                update_tri_layer(_LOWER, _RAISE, _ADJUST);
+            } else {
+                layer_off(_RAISE);
+                update_tri_layer(_LOWER, _RAISE, _ADJUST);
+            }
+            return false;
+            break;
+        case ADJUST:
+            if (record->event.pressed) {
+                layer_on(_ADJUST);
+            } else {
+                layer_off(_ADJUST);
+            }
+            return false;
+            break;
+    }
+    return true;
+}
+
+void encoder_update(bool clockwise) {
+    if (IS_LAYER_ON(_RAISE) || IS_LAYER_ON(_LOWER)) {
+        if (clockwise) {
+            register_code(KC_VOLU);
+            unregister_code(KC_VOLU);
+        } else {
+            register_code(KC_VOLD);
+            register_code(KC_VOLD);
+        }
+    } else {
+        if (clockwise) {
+            #ifdef MOUSEKEY_ENABLE
+                register_code(KC_MS_WH_DOWN);
+                unregister_code(KC_MS_WH_DOWN);
+            #else
+                register_code(KC_PGDN);
+                unregister_code(KC_PGDN);
+            #endif
+        } else {
+            #ifdef MOUSEKEY_ENABLE
+                register_code(KC_MS_WH_UP);
+                unregister_code(KC_MS_WH_UP);
+            #else
+                register_code(KC_PGUP);
+                unregister_code(KC_PGUP);
+            #endif
+        }
+    }
+}
+
+

layouts/community/ortho_4x12/buswerks/readme.md

@@ -1,29 +1,12 @@
-Buswerks' 4x12 Ortholinear Layout
-============================
-For use on Planck, Let's Split, and similar keyboards
+![Imgur](https://i.imgur.com/yx9tFUq.png)
 
-### Layout Overview
+# Logan's Ortho 4x12 Layout
 
-- Main Layer
-	- Enter is located on the Raise key (layer-tap)
-	- Space Cadet shift keys
-		- Lower + shift keys = Brackets[]
-		- Raise + shift keys = Braces{}
-	- The bottom left key is the Adjust modifier
-	- Escape is in the traditional Caps Lock position
-		- Holding down the escape key acts as LGUI (intended for macOS use)
-- Lower
-	- There is a numpad on the right hand (4, 5, and 6 are located under JKL/NEI/HTN)
-	- Plus and minus keys are located to the right of the numpad
-	- There are macOS desktop navigation keys and volume controls under the left hand
+This layout is what I use on my Planck. Some features of the layout:
 
-- Raise
-	- Vim-style arrow keys
-		- Below the arrow keys are home, end, pgup, and pgdn
-	- Symbols are located on the right side of the keyboard, in a somewhat logical order
-		- Symbols from the number row are in order, starting on the left pinky.
-		- Equals and underscore are in easily accessible spots, since they're commonly used in programming
-		- The ampersand is less common, so it's to the right of the equals symbol
-		
-- Adjust
-	- Function keys are located along the top row (reset is moved to the Colemak 'R' position)
+- Rotary encoder support (no function for clicking yet)
+- Numpad under right hand (I find this much more comfortable than touch-typing the number row)
+- Space cadet shift
+- Curly braces are under the home row (makes programming much more comfortable)
+
+Also, another note: the QWERTY layout uses `LGUI_T(KC_ESC)` and the COLEMAK/DVORAK layouts use `LCTL_T(KC_ESC)`. This is because I use the QWERTY layout on my Mac laptop so that I don't have to change the software remapping every time I dock my laptop. This also allows a convenient remapping of the modifier keys. I use the hardware mapped COLEMAK layout on Linux.