added matrixman layout

2 files changed, 313 insertions, 0 deletions

diff --git a/keyboards/ergodox_ez/keymaps/matrixman/keymap.c b/keyboards/ergodox_ez/keymaps/matrixman/keymap.c
new file mode 100644
index 0000000000..12b02813d4
--- /dev/null
+++ b/keyboards/ergodox_ez/keymaps/matrixman/keymap.c
@@ -0,0 +1,213 @@
+#include "ergodox_ez.h"
+#include "debug.h"
+#include "action_layer.h"
+
+// http://www.keyboard-layout-editor.com/#/gists/9be130e4c9b503317619
+
+#define BASE 0 // default layer
+#define SYMB_R 1 // symbols (activated by right hand)
+#define SYMB_L 2 // symbols (activated by left hand)
+#define NAV 3 // navigation
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+/* Keymap 0: Prose layer
+ *
+ * Layer switch keys:
+ * [tap/toggle]
+ * (momentary)
+ * {toggle}
+ *
+ * ,--------------------------------------------------.           ,--------------------------------------------------.
+ * |   ESC  |   1  |   2  |   3  |   4  |   5  | Del  |           | BSPC |   6  |   7  |   8  |   9  |   0  | BSPC   |
+ * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
+ * |   Tab  |   Q  |   W  |   E  |   R  |   T  | Ctrl/|           |Ctrl/ |   Y  |   U  |   I  |   O  |   P  |   \    |
+ * |--------+------+------+------+------+------| Esc  |           |  ;   |------+------+------+------+------+--------|
+ * |  Ctrl  |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |   ;  |   '    |
+ * |--------+------+------+------+------+------|Alt/  |           |Alt/  |------+------+------+------+------+--------|
+ * |  Shift |   Z  |   X  |   C  |   V  |   B  |Tab   |           |Ins   |   N  |   M  |   ,  |   .  | /    | Shift  |
+ * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
+ *   |Ctrl  |Super |  Alt |[Nav] |[Symb]|                                       |[Symb]|[Nav] | Alt  | Ctrl | Enter|
+ *   `----------------------------------'                                       `----------------------------------'
+ *                                        ,-------------.       ,-------------.
+ *                                        | Shift| Alt  |       | Alt  | Shift  |
+ *                                 ,------|------|------|       |------+--------+------.
+ *                                 |      |      |[Nav] |       |[Nav] |        |      |
+ *                                 | Tab  | Esc  |------|       |------|  Space | Bspc |
+ *                                 |      |      | Ctrl |       | Ctrl |        |      |
+ *                                 `--------------------'       `----------------------'
+ */
+[BASE] = KEYMAP(  // layer 0 : default
+        // left hand
+   LT(NAV,KC_ESC),  KC_1,         KC_2,   KC_3,   KC_4,   KC_5,   KC_DELETE,
+        KC_TAB,     KC_Q,         KC_W,   KC_E,   KC_R,   KC_T,   CTL_T(KC_ESC),
+        KC_LCTRL,   KC_A,         KC_S,   KC_D,   KC_F,   KC_G,
+        KC_LSFT,    KC_Z,         KC_X,   KC_C,   KC_V,   KC_B,   ALT_T(KC_TAB),
+        KC_LCTRL,   KC_LGUI,      KC_LALT,KC_NO,  MO(NAV),
+
+                                           KC_LCTRL,  KC_LALT,
+                                                      MO(NAV),
+                       KC_TAB,    LT(SYMB_L,KC_ESC),  KC_LSFT,
+                  // right hand
+                  KC_BSPC,       KC_6,   KC_7,   KC_8,   KC_9,   KC_0,      KC_BSPC,
+                  CTL_T(KC_SCLN),KC_Y,   KC_U,   KC_I,   KC_O,   KC_P,      KC_BSLS,
+                                 KC_H,   KC_J,   KC_K,   KC_L,   KC_SCLN,   KC_QUOT,
+                  ALT_T(KC_INS), KC_N,   KC_M,   KC_COMM,KC_DOT, KC_SLSH,   KC_RSFT,
+                                         MO(NAV),KC_NO,  KC_RALT,KC_RGUI,   CTL_T(KC_ENT),
+                  KC_RALT,   KC_RCTRL,
+                  MO(NAV),
+                  KC_RSFT, LT(SYMB_R,KC_SPACE), KC_BSPC
+    ),
+/* Keymap 1: Symbol Layer
+ *
+ * ,--------------------------------------------------.           ,--------------------------------------------------.
+ * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
+ * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
+ * |        |  `   |  ~   |   *  |   &  |   /  |  <   |           |   >  |   \  |   7  |   8  |   9  |   |  |        |
+ * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
+ * |        |  _   |  ^   |   %  |   $  |   (  |------|           |------|   )  |   4  |   5  |   6  |   -  | Enter  |
+ * |--------+------+------+------+------+------|  [   |           |   ]  |------+------+------+------+------+--------|
+ * |        |  =   |  #   |   @  |   !  |   {  |      |           |      |   }  |   1  |   2  |   3  |   +  | Enter  |
+ * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
+ *   |   "  |      |      |      |      |                                       |   0  |   .  |   .  |      |      |
+ *   `----------------------------------'                                       `----------------------------------'
+ *                                        ,-------------.       ,-------------.
+ *                                        |      |      |       |      |      |
+ *                                 ,------|------|------|       |------+------+------.
+ *                                 |      |      |      |       |      |      |      |
+ *                                 |   ?  |   :  |------|       |------|   ;  |  .   |
+ *                                 |      |      |      |       |      |      |      |
+ *                                 `--------------------'       `--------------------'
+ */
+[SYMB_L] = KEYMAP(
+       // left hand
+       KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,
+       KC_TRNS,  KC_GRV ,  KC_TILD,  KC_ASTR,  KC_AMPR,  KC_SLSH,  LSFT(KC_COMM),
+       KC_TRNS,  KC_UNDS,  KC_CIRC,  KC_PERC,  KC_DLR,   KC_LPRN,
+       KC_TRNS,  KC_EQL,   KC_HASH,  KC_AT,    KC_EXLM,  KC_LCBR,  KC_LBRC,
+ LSFT(KC_QUOT),  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,
+                                         KC_TRNS,  KC_TRNS,
+                                                   KC_TRNS,
+                         LSFT(KC_SLSH),  KC_TRNS,  KC_TRNS,
+       // right hand
+       KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,
+  LSFT(KC_DOT),  KC_BSLS,  KC_7,     KC_8,     KC_9,     KC_PIPE,  KC_TRNS,
+                 KC_RPRN,  KC_4,     KC_5,     KC_6,     KC_MINS,  KC_ENT,
+       KC_RBRC,  KC_RCBR,  KC_1,     KC_2,     KC_3,     KC_PLUS,  KC_ENT,
+                           KC_0,    KC_DOT,  KC_DOT,     KC_TRNS,  KC_TRNS,
+       KC_TRNS,  KC_TRNS,
+       KC_TRNS,
+       KC_TRNS,  KC_SCLN,  KC_DOT
+),
+
+[SYMB_R] = KEYMAP(  // same as above, but avoids clash between SYMB and ;/:
+       // left hand
+       KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,
+       KC_TRNS,  KC_GRV ,  KC_TILD,  KC_ASTR,  KC_AMPR,  KC_SLSH,  LSFT(KC_COMM),
+       KC_TRNS,  KC_UNDS,  KC_CIRC,  KC_PERC,  KC_DLR,   KC_LPRN,
+       KC_TRNS,  KC_EQL,   KC_HASH,  KC_AT,    KC_EXLM,  KC_LCBR,  KC_LBRC,
+ LSFT(KC_QUOT),  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,
+                                         KC_TRNS,  KC_TRNS,
+                                                   KC_TRNS,
+                         LSFT(KC_SLSH),  KC_COLN,  KC_TRNS,
+       // right hand
+       KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,
+  LSFT(KC_DOT),  KC_BSLS,  KC_7,     KC_8,     KC_9,     KC_PIPE,  KC_TRNS,
+                 KC_RPRN,  KC_4,     KC_5,     KC_6,     KC_MINS,  KC_ENT,
+       KC_RBRC,  KC_RCBR,  KC_1,     KC_2,     KC_3,     KC_PLUS,  KC_ENT,
+                           KC_0,   KC_DOT,     KC_DOT,   KC_TRNS,  KC_TRNS,
+       KC_TRNS,  KC_TRNS,
+       KC_TRNS,
+       KC_TRNS,  KC_TRNS,  KC_DOT
+),
+/* Keymap 2: Navigation Layer
+ *
+ * ,--------------------------------------------------.           ,--------------------------------------------------.
+ * |        |  F1  |  F2  |  F3  |  F4  |  F5  |Break |           |PrntSc|  F6  |  F7  |  F8  |  F9  |  F10 |   F11  |
+ * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
+ * |        |  F1  |  F2  |  F3  |  F4  |  F5  |      |           |      |  F6  |  F7  |  F8  |  F9  |  F10 |   F12  |
+ * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
+ * |        | ---  |MsLeft|MsUp  |MsDown|MsRght|------|           |------| Left | Down | Up   | Right|  F11 |   Enter|
+ * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
+ * |        | ---  | Btn4 |ScrlDn|ScrlUp| Btn5 |      |           |      | Home | PgDwn| PgUp | End  |  F12 |        |
+ * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
+ *   |      |      |      |      |      |                                       |      |      |      |      |      |
+ *   `----------------------------------'                                       `----------------------------------'
+ *                                        ,-------------.       ,-------------.
+ *                                        |      |      |       |      |      |
+ *                                 ,------|------|------|       |------+------+------.
+ *                                 |      |      |      |       |      |      |      |
+ *                                 |      |      |------|       |------|      |      |
+ *                                 |      |      |      |       |      |      |      |
+ *                                 `--------------------'       `--------------------'
+ */
+[NAV] = KEYMAP(
+       // left hand
+       KC_TRNS,  KC_F1,    KC_F2,          KC_F3,        KC_F4,    KC_F5,  KC_PAUSE,
+       KC_TRNS,  KC_F1,    KC_F2,          KC_F3,        KC_F4,    KC_F5,  KC_TRNS,
+       KC_TRNS,  KC_BTN1,  KC_MS_L,        KC_MS_U,      KC_MS_D,  KC_MS_R,
+       KC_TRNS,  KC_BTN2,  KC_BTN4,        KC_MS_WH_UP,  KC_MS_WH_DOWN,  KC_BTN5,  KC_TRNS,
+       KC_TRNS,  KC_TRNS,  KC_TRNS,        KC_TRNS,      KC_TRNS,
+                                           KC_TRNS,      KC_TRNS,
+                                                         KC_TRNS,
+                               KC_TRNS,    KC_TRNS,      KC_TRNS,
+       // right hand
+       KC_PSCREEN,  KC_F6,    KC_F7,    KC_F8,    KC_F9,    KC_F10,   KC_F11,
+       KC_TRNS,     KC_F6,    KC_F7,    KC_F8,    KC_F9,    KC_F10,   KC_F12,
+                    KC_LEFT,  KC_DOWN,  KC_UP,    KC_RGHT,  KC_F11,   KC_ENT,
+       KC_TRNS,     KC_HOME,  KC_PGDN,  KC_PGUP,  KC_END,   KC_F12,   KC_TRNS,
+                              KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,
+       KC_TRNS,     KC_TRNS,
+       KC_TRNS,
+       KC_TRNS, KC_TRNS,  KC_TRNS
+),
+};
+
+const uint16_t PROGMEM fn_actions[] = {
+//    [1] = ACTION_LAYER_TAP_TOGGLE(SYMB),               // FN1 - Tap/Toggle Layer 1 (Symbols)
+//    [2] = ACTION_LAYER_TAP_TOGGLE(NAV)                // FN2 - Tap/Toggle Layer 2 (Nav)
+};
+
+const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
+{
+  // MACRODOWN only works in this function
+      switch(id) {
+        case 0:
+        if (record->event.pressed) {
+          register_code(KC_RSFT);
+        } else {
+          unregister_code(KC_RSFT);
+        }
+        break;
+      }
+    return MACRO_NONE;
+};
+
+// Runs just one time when the keyboard initializes.
+void matrix_init_user(void) {
+
+};
+
+// Runs constantly in the background, in a loop.
+void matrix_scan_user(void) {
+
+    uint8_t layer = biton32(layer_state);
+
+    ergodox_board_led_off();
+    ergodox_right_led_1_off();
+    ergodox_right_led_2_off();
+    ergodox_right_led_3_off();
+    switch (layer) {
+      // TODO: Make this relevant to the ErgoDox EZ.
+        case 1:
+        case 2:
+            ergodox_right_led_1_on();
+            break;
+        case 3:
+        case 4:
+            ergodox_right_led_2_on();
+            break;
+        default:
+            // none
+            break;
+    }
+};
diff --git a/keyboards/ergodox_ez/keymaps/matrixman/readme.md b/keyboards/ergodox_ez/keymaps/matrixman/readme.md
new file mode 100644
index 0000000000..1f72d73221
--- /dev/null
+++ b/keyboards/ergodox_ez/keymaps/matrixman/readme.md
@@ -0,0 +1,100 @@
+The Matrixman Ergodox / Split-Planck Keyboard Layout
+====================================================
+
+### The problem
+
+These layouts were designed to give my aching pinkeys a break
+
+### The Design
+
+ - Pinkeys do less:
+   - Left q, a, z, `, _, =, [Shift], [F1] [Click], [Right Click]
+   - Right p, ', /, |, -, +, [Shift], [F10], [F11], [F12]
+ - Index fingers do more:
+   - Left: r, f, v, t, g, b, &, $, !, /, (, {, <, [, [Ctrl], [Tab], [Alt], [PrintScr]
+   - Right: u, j, m, y, h, n, 7, 4, 1, \, ), }, >, ], ;, [Ctrl], [Insert], [Alt], [Pause]
+ - Thumbs do more:
+   - Left: [Esc], :, [Shift], [Tab]
+   - Right: [Space], ;, [Shift], [Backspace]
+ - Palm Presses too:
+   - Left: [Ctrl], "
+   - Right: [Ctrl, [Enter]
+
+### The Plan
+
+I keep an Ergodox at home and at work, and when I'm mobile, I carry a planck.
+These keymaps are designed to minimize the difficulty of switching between the two.
+
+### Other features
+
+- 10-key at home row for right hand
+- "Matching" symbols use same finger on opposite hand: <> [] {} /\ () 1! 2@ 3# 4$ 5% 6^ 7& 8* -_ +=
+- Supports vim-like (hjkl) movements:
+  - mouse movement and scrolling
+  - arrow keys and nav keys (home, end, pg up, pg down)
+- All non-modal keys mapped (all keys from a typical 105 key keyboard except caps, num, and scroll lock)
+
+The Planck Layout
+-----------------
+
+For a picture, see here: http://www.keyboard-layout-editor.com/#/gists/eb0696806831fc0d93c9
+
+### Prose Layer
+
+    qwert▓▓yuiop
+    asdfg▓;hjkl'
+    zxcvb▓▓nm,./
+    ▓▓▓▓▓▓▓ ▓▓▓▓
+
+### Symbol Layer
+
+    `~*&/<>\789|
+    _^%$([])456-
+    =#@!{▓▓}123+
+    "▓,?:▓▓;0▓.▓
+
+### Nav Layer
+
+    FKEYF▓▓KEYFK
+    mouse▓▓arowE
+    scrol▓▓seekY
+    ▓▓▓▓▓▓▓▓▓▓▓▓
+
+
+The Ergodox Layout
+------------------
+
+For a picture, see here: http://www.keyboard-layout-editor.com/#/gists/9be130e4c9b503317619
+
+Wherever the Ergodox has keys that the Planck doesn't, whichever key would be expected on a typical 105 key is in that place
+
+### Prose Layer
+
+▓▓▓▓▓▓▓          ▓▓▓▓▓▓
+▓qwert▓         ▓yuiop\
+▓asdfg▓         ;hjkl;'
+▓zxcvb           nm,./▓
+▓▓▓▓▓▓           ▓▓▓▓▓▓
+        ▓▓   ▓▓
+       ▓▓▓   ▓ ▓
+
+### Symbol Layer
+
+▓▓▓▓▓▓           ▓▓▓▓▓▓
+▓`~*&/<         >\789|\
+▓_^%$([         ])456-▓
+▓=#@!{           }123+▓
+"▓▓▓▓▓▓           0▓.▓▓
+        ▓▓   ▓▓
+       ?:▓   ▓;.
+
+
+### Nav Layer
+
+▓▓▓▓▓▓▓          ▓▓▓▓▓▓
+▓FKEYF▓         ▓KEYFK▓
+▓mouse▓          arowE▓
+▓scrol           seekY▓
+▓▓▓▓▓▓           ▓▓▓▓▓▓
+        ▓▓   ▓▓
+       ▓▓▓   ▓▓▓