MechWild Mercutio Layout Addition (#20738)

* add matrix_diagram.md

* info.json: apply friendly formatting

* add LAYOUT_625u_space with reference keymap

4 files changed, 177 insertions, 46 deletions

diff --git a/keyboards/mechwild/mercutio/info.json b/keyboards/mechwild/mercutio/info.json
index 1b13b61cb9..f4b1fa141a 100644
--- a/keyboards/mechwild/mercutio/info.json
+++ b/keyboards/mechwild/mercutio/info.json
@@ -23,56 +23,108 @@
     "layouts": {
         "LAYOUT_all": {
             "layout": [
-                {"matrix": [4, 2], "x": 12, "y": 0},
+                {"label": "Mute", "matrix": [4, 2], "x": 12, "y": 0},
 
-                {"matrix": [0, 0], "x": 0, "y": 1, "w": 1.5},
-                {"matrix": [0, 1], "x": 1.5, "y": 1},
-                {"matrix": [0, 2], "x": 2.5, "y": 1},
-                {"matrix": [0, 3], "x": 3.5, "y": 1},
-                {"matrix": [0, 4], "x": 4.5, "y": 1},
-                {"matrix": [0, 5], "x": 5.5, "y": 1},
-                {"matrix": [0, 6], "x": 6.5, "y": 1},
-                {"matrix": [4, 6], "x": 7.5, "y": 1},
-                {"matrix": [4, 5], "x": 8.5, "y": 1},
-                {"matrix": [4, 4], "x": 9.5, "y": 1},
-                {"matrix": [4, 3], "x": 10.5, "y": 1},
-                {"matrix": [5, 2], "x": 11.5, "y": 1, "w": 1.5},
+                {"label": "Tab", "matrix": [0, 0], "x": 0, "y": 1, "w": 1.5},
+                {"label": "Q", "matrix": [0, 1], "x": 1.5, "y": 1},
+                {"label": "W", "matrix": [0, 2], "x": 2.5, "y": 1},
+                {"label": "E", "matrix": [0, 3], "x": 3.5, "y": 1},
+                {"label": "R", "matrix": [0, 4], "x": 4.5, "y": 1},
+                {"label": "T", "matrix": [0, 5], "x": 5.5, "y": 1},
+                {"label": "Y", "matrix": [0, 6], "x": 6.5, "y": 1},
+                {"label": "U", "matrix": [4, 6], "x": 7.5, "y": 1},
+                {"label": "I", "matrix": [4, 5], "x": 8.5, "y": 1},
+                {"label": "O", "matrix": [4, 4], "x": 9.5, "y": 1},
+                {"label": "P", "matrix": [4, 3], "x": 10.5, "y": 1},
+                {"label": "Backspace", "matrix": [5, 2], "x": 11.5, "y": 1, "w": 1.5},
 
-                {"matrix": [1, 0], "x": 0, "y": 2, "w": 1.75},
-                {"matrix": [1, 1], "x": 1.75, "y": 2},
-                {"matrix": [1, 2], "x": 2.75, "y": 2},
-                {"matrix": [1, 3], "x": 3.75, "y": 2},
-                {"matrix": [1, 4], "x": 4.75, "y": 2},
-                {"matrix": [1, 5], "x": 5.75, "y": 2},
-                {"matrix": [1, 6], "x": 6.75, "y": 2},
-                {"matrix": [5, 6], "x": 7.75, "y": 2},
-                {"matrix": [5, 5], "x": 8.75, "y": 2},
-                {"matrix": [5, 4], "x": 9.75, "y": 2},
-                {"matrix": [4, 1], "x": 10.75, "y": 2},
-                {"matrix": [5, 3], "x": 11.75, "y": 2, "w": 1.25},
+                {"label": "Fn", "matrix": [1, 0], "x": 0, "y": 2, "w": 1.75},
+                {"label": "A", "matrix": [1, 1], "x": 1.75, "y": 2},
+                {"label": "S", "matrix": [1, 2], "x": 2.75, "y": 2},
+                {"label": "D", "matrix": [1, 3], "x": 3.75, "y": 2},
+                {"label": "F", "matrix": [1, 4], "x": 4.75, "y": 2},
+                {"label": "G", "matrix": [1, 5], "x": 5.75, "y": 2},
+                {"label": "H", "matrix": [1, 6], "x": 6.75, "y": 2},
+                {"label": "J", "matrix": [5, 6], "x": 7.75, "y": 2},
+                {"label": "K", "matrix": [5, 5], "x": 8.75, "y": 2},
+                {"label": "L", "matrix": [5, 4], "x": 9.75, "y": 2},
+                {"label": "'", "matrix": [4, 1], "x": 10.75, "y": 2},
+                {"label": "Enter", "matrix": [5, 3], "x": 11.75, "y": 2, "w": 1.25},
 
-                {"matrix": [2, 0], "x": 0, "y": 3, "w": 1.25},
-                {"matrix": [2, 1], "x": 1.25, "y": 3},
-                {"matrix": [6, 1], "x": 2.25, "y": 3},
-                {"matrix": [2, 3], "x": 3.25, "y": 3},
-                {"matrix": [2, 4], "x": 4.25, "y": 3},
-                {"matrix": [2, 5], "x": 5.25, "y": 3},
-                {"matrix": [2, 6], "x": 6.25, "y": 3},
-                {"matrix": [6, 6], "x": 7.25, "y": 3},
-                {"matrix": [6, 5], "x": 8.25, "y": 3},
-                {"matrix": [6, 4], "x": 9.25, "y": 3},
-                {"matrix": [6, 3], "x": 10.25, "y": 3},
-                {"matrix": [6, 2], "x": 11.25, "y": 3, "w": 1.75},
+                {"label": "Shift", "matrix": [2, 0], "x": 0, "y": 3, "w": 1.25},
+                {"label": "/", "matrix": [2, 1], "x": 1.25, "y": 3},
+                {"label": "Z", "matrix": [6, 1], "x": 2.25, "y": 3},
+                {"label": "X", "matrix": [2, 3], "x": 3.25, "y": 3},
+                {"label": "C", "matrix": [2, 4], "x": 4.25, "y": 3},
+                {"label": "V", "matrix": [2, 5], "x": 5.25, "y": 3},
+                {"label": "B", "matrix": [2, 6], "x": 6.25, "y": 3},
+                {"label": "N", "matrix": [6, 6], "x": 7.25, "y": 3},
+                {"label": "M", "matrix": [6, 5], "x": 8.25, "y": 3},
+                {"label": ",", "matrix": [6, 4], "x": 9.25, "y": 3},
+                {"label": ".", "matrix": [6, 3], "x": 10.25, "y": 3},
+                {"label": "Shift", "matrix": [6, 2], "x": 11.25, "y": 3, "w": 1.75},
 
-                {"matrix": [3, 0], "x": 0, "y": 4, "w": 1.25},
-                {"matrix": [5, 1], "x": 1.25, "y": 4},
-                {"matrix": [3, 1], "x": 2.25, "y": 4, "w": 1.25},
-                {"matrix": [3, 4], "x": 3.5, "y": 4, "w": 2.25},
-                {"matrix": [3, 5], "x": 5.75, "y": 4},
-                {"matrix": [3, 6], "x": 6.75, "y": 4, "w": 2.75},
-                {"matrix": [3, 3], "x": 9.5, "y": 4, "w": 1.25},
-                {"matrix": [3, 2], "x": 10.75, "y": 4},
-                {"matrix": [2, 2], "x": 11.75, "y": 4, "w": 1.25}
+                {"label": "Ctrl", "matrix": [3, 0], "x": 0, "y": 4, "w": 1.25},
+                {"label": "GUI", "matrix": [5, 1], "x": 1.25, "y": 4},
+                {"label": "Alt", "matrix": [3, 1], "x": 2.25, "y": 4, "w": 1.25},
+                {"label": "Space", "matrix": [3, 4], "x": 3.5, "y": 4, "w": 2.25},
+                {"label": "Space", "matrix": [3, 5], "x": 5.75, "y": 4},
+                {"label": "Space", "matrix": [3, 6], "x": 6.75, "y": 4, "w": 2.75},
+                {"label": "Alt", "matrix": [3, 3], "x": 9.5, "y": 4, "w": 1.25},
+                {"label": "Fn2", "matrix": [3, 2], "x": 10.75, "y": 4},
+                {"label": "Ctrl", "matrix": [2, 2], "x": 11.75, "y": 4, "w": 1.25}
+            ]
+        },
+        "LAYOUT_625u_space": {
+            "layout": [
+                {"label": "Mute", "matrix": [4, 2], "x": 12, "y": 0},
+
+                {"label": "Tab", "matrix": [0, 0], "x": 0, "y": 1, "w": 1.5},
+                {"label": "Q", "matrix": [0, 1], "x": 1.5, "y": 1},
+                {"label": "W", "matrix": [0, 2], "x": 2.5, "y": 1},
+                {"label": "E", "matrix": [0, 3], "x": 3.5, "y": 1},
+                {"label": "R", "matrix": [0, 4], "x": 4.5, "y": 1},
+                {"label": "T", "matrix": [0, 5], "x": 5.5, "y": 1},
+                {"label": "Y", "matrix": [0, 6], "x": 6.5, "y": 1},
+                {"label": "U", "matrix": [4, 6], "x": 7.5, "y": 1},
+                {"label": "I", "matrix": [4, 5], "x": 8.5, "y": 1},
+                {"label": "O", "matrix": [4, 4], "x": 9.5, "y": 1},
+                {"label": "P", "matrix": [4, 3], "x": 10.5, "y": 1},
+                {"label": "Backspace", "matrix": [5, 2], "x": 11.5, "y": 1, "w": 1.5},
+
+                {"label": "Fn", "matrix": [1, 0], "x": 0, "y": 2, "w": 1.75},
+                {"label": "A", "matrix": [1, 1], "x": 1.75, "y": 2},
+                {"label": "S", "matrix": [1, 2], "x": 2.75, "y": 2},
+                {"label": "D", "matrix": [1, 3], "x": 3.75, "y": 2},
+                {"label": "F", "matrix": [1, 4], "x": 4.75, "y": 2},
+                {"label": "G", "matrix": [1, 5], "x": 5.75, "y": 2},
+                {"label": "H", "matrix": [1, 6], "x": 6.75, "y": 2},
+                {"label": "J", "matrix": [5, 6], "x": 7.75, "y": 2},
+                {"label": "K", "matrix": [5, 5], "x": 8.75, "y": 2},
+                {"label": "L", "matrix": [5, 4], "x": 9.75, "y": 2},
+                {"label": "'", "matrix": [4, 1], "x": 10.75, "y": 2},
+                {"label": "Enter", "matrix": [5, 3], "x": 11.75, "y": 2, "w": 1.25},
+
+                {"label": "Shift", "matrix": [2, 0], "x": 0, "y": 3, "w": 1.25},
+                {"label": "/", "matrix": [2, 1], "x": 1.25, "y": 3},
+                {"label": "Z", "matrix": [6, 1], "x": 2.25, "y": 3},
+                {"label": "X", "matrix": [2, 3], "x": 3.25, "y": 3},
+                {"label": "C", "matrix": [2, 4], "x": 4.25, "y": 3},
+                {"label": "V", "matrix": [2, 5], "x": 5.25, "y": 3},
+                {"label": "B", "matrix": [2, 6], "x": 6.25, "y": 3},
+                {"label": "N", "matrix": [6, 6], "x": 7.25, "y": 3},
+                {"label": "M", "matrix": [6, 5], "x": 8.25, "y": 3},
+                {"label": ",", "matrix": [6, 4], "x": 9.25, "y": 3},
+                {"label": ".", "matrix": [6, 3], "x": 10.25, "y": 3},
+                {"label": "Shift", "matrix": [6, 2], "x": 11.25, "y": 3, "w": 1.75},
+
+                {"label": "Ctrl", "matrix": [3, 0], "x": 0, "y": 4, "w": 1.25},
+                {"label": "GUI", "matrix": [5, 1], "x": 1.25, "y": 4},
+                {"label": "Alt", "matrix": [3, 1], "x": 2.25, "y": 4},
+                {"label": "Space", "matrix": [3, 5], "x": 3.25, "y": 4, "w": 6.25},
+                {"label": "Alt", "matrix": [3, 3], "x": 9.5, "y": 4, "w": 1.25},
+                {"label": "Fn2", "matrix": [3, 2], "x": 10.75, "y": 4},
+                {"label": "Ctrl", "matrix": [2, 2], "x": 11.75, "y": 4, "w": 1.25}
             ]
         }
     }
diff --git a/keyboards/mechwild/mercutio/keymaps/default_625u_space/keymap.c b/keyboards/mechwild/mercutio/keymaps/default_625u_space/keymap.c
new file mode 100644
index 0000000000..58c149f7e9
--- /dev/null
+++ b/keyboards/mechwild/mercutio/keymaps/default_625u_space/keymap.c
@@ -0,0 +1,56 @@
+/* Copyright 2021 Kyle McCreery
+ *
+ * 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/>.
+ */
+
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [0] = LAYOUT_625u_space(
+                                                                                                                    KC_MUTE,
+        KC_TAB,           KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC,
+        MO(1),            KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_QUOT, KC_ENT,
+        KC_LSFT, KC_SLSH, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,           KC_RSFT,
+        KC_LCTL, KC_LGUI, KC_LALT,                   KC_SPC,                             KC_RALT, MO(2),            KC_RCTL ),
+
+    [1] = LAYOUT_625u_space(
+                                                                                                                    _______,
+        KC_ESC,           KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_DEL,
+        _______,          _______, KC_GRV,  KC_BSLS, _______, _______, _______, KC_LBRC, KC_RBRC, KC_SCLN, _______, KC_QUOT,
+        _______, _______, _______, _______, _______, _______, _______, _______, KC_MINS, KC_EQL,  KC_SLSH,          KC_UP,
+        _______, _______, _______,                   _______,                            KC_LEFT, KC_DOWN,          KC_RGHT ),
+
+    [2] = LAYOUT_625u_space(
+                                                                                                                    _______,
+        _______,          KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  _______,
+        KC_CAPS,          _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______,
+        _______, _______, _______,                   _______,                            _______, _______,          _______ ),
+
+    [3] = LAYOUT_625u_space(
+                                                                                                                    _______,
+        _______,          _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______,          _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______,
+        _______, _______, _______,                   _______,                            _______, _______,          _______ )
+};
+
+#ifdef ENCODER_MAP_ENABLE
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][2] = {
+    [0] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU) },
+    [1] = { ENCODER_CCW_CW(_______, _______) },
+    [2] = { ENCODER_CCW_CW(_______, _______) },
+    [3] = { ENCODER_CCW_CW(_______, _______) },
+};
+#endif
diff --git a/keyboards/mechwild/mercutio/keymaps/default_625u_space/rules.mk b/keyboards/mechwild/mercutio/keymaps/default_625u_space/rules.mk
new file mode 100644
index 0000000000..ee32568148
--- /dev/null
+++ b/keyboards/mechwild/mercutio/keymaps/default_625u_space/rules.mk
@@ -0,0 +1 @@
+ENCODER_MAP_ENABLE = yes
diff --git a/keyboards/mechwild/mercutio/matrix_diagram.md b/keyboards/mechwild/mercutio/matrix_diagram.md
new file mode 100644
index 0000000000..ac65c7ef12
--- /dev/null
+++ b/keyboards/mechwild/mercutio/matrix_diagram.md
@@ -0,0 +1,22 @@
+# Matrix Diagram for MechWild Mercutio
+
+```
+                                                ┌───┐
+                                                │42 │
+                                                └───┘
+┌─────┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬─────┐
+│00   │01 │02 │03 │04 │05 │06 │46 │45 │44 │43 │52   │
+├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬────┤   ┌────────┐
+│10    │11 │12 │13 │14 │15 │16 │56 │55 │54 │41 │53  │   │53      │ 2.25u Enter
+├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────┤   └────────┘
+│20  │21 │61 │23 │24 │25 │26 │66 │65 │64 │63 │62    │
+├────┼───┼───┴┬──┴───┴─┬─┴─┬─┴───┴───┴┬──┴─┬─┴─┬────┤
+│30  │51 │31  │34      │35 │36        │33  │32 │22  │
+└────┴───┴────┴────────┴───┴──────────┴────┴───┴────┘
+┌────────┐
+│20      │ 2.25u LShift
+└────────┘
+┌────┬───┬───┬────────────────────────┐
+│30  │51 │31 │35                      │ 6.25u Spacebar
+└────┴───┴───┴────────────────────────┘
+```