From 78eb69ead5a654179692d980175ea0013837854c Mon Sep 17 00:00:00 2001
From: James Young <18669334+noroadsleft@users.noreply.github.com>
Date: Thu, 14 Sep 2023 02:48:09 -0700
Subject: [PATCH] Linworks Fave60a Community Layout Support (#22015)

* Friendly-format `info.json`

[style]

* Correct layout data

[chore]

* Add layout/matrix diagram

[docs]

* Rename `LAYOUT` to `LAYOUT_60_tsangan_hhkb`

[refactor]

* Add `LAYOUT_60_ansi_tsangan`

[enhancement]

* Enable Community Layout support

[enhancement]
---
 keyboards/linworks/fave60a/info.json          | 105 +++++++++++++++---
 .../linworks/fave60a/keymaps/default/keymap.c |   4 +-
 .../linworks/fave60a/keymaps/via/keymap.c     |   4 +-
 keyboards/linworks/fave60a/matrix_diagram.md  |  21 ++++
 4 files changed, 117 insertions(+), 17 deletions(-)
 create mode 100644 keyboards/linworks/fave60a/matrix_diagram.md

diff --git a/keyboards/linworks/fave60a/info.json b/keyboards/linworks/fave60a/info.json
index b7753c2fce..97b50f7e82 100644
--- a/keyboards/linworks/fave60a/info.json
+++ b/keyboards/linworks/fave60a/info.json
@@ -121,8 +121,15 @@
         "pid": "0x000C",
         "vid": "0x4C58"
     },
+    "layout_aliases": {
+        "LAYOUT": "LAYOUT_60_tsangan_hhkb"
+    },
+    "community_layouts": [
+        "60_tsangan_hhkb",
+        "60_ansi_tsangan"
+    ],
     "layouts": {
-        "LAYOUT": {
+        "LAYOUT_60_tsangan_hhkb": {
             "layout": [
                 { "label": "Esc", "matrix": [0, 0], "x": 0, "y": 0 },
                 { "label": "!", "matrix": [0, 1], "x": 1, "y": 0 },
@@ -139,7 +146,8 @@
                 { "label": "+", "matrix": [0, 12], "x": 12, "y": 0 },
                 { "label": "Bksp", "matrix": [0, 13], "x": 13, "y": 0 },
                 { "label": "K14", "matrix": [0, 14], "x": 14, "y": 0 },
-                { "label": "Tab", "matrix": [1, 0], "w": 1.5, "x": 0, "y": 1 },
+
+                { "label": "Tab", "matrix": [1, 0], "x": 0, "y": 1, "w": 1.5 },
                 { "label": "Q", "matrix": [1, 1], "x": 1.5, "y": 1 },
                 { "label": "W", "matrix": [1, 2], "x": 2.5, "y": 1 },
                 { "label": "E", "matrix": [1, 3], "x": 3.5, "y": 1 },
@@ -152,8 +160,9 @@
                 { "label": "P", "matrix": [1, 10], "x": 10.5, "y": 1 },
                 { "label": "{", "matrix": [1, 11], "x": 11.5, "y": 1 },
                 { "label": "}", "matrix": [1, 12], "x": 12.5, "y": 1 },
-                { "label": "|", "matrix": [1, 13], "w": 1.5, "x": 13.5, "y": 1 },
-                { "label": "Caps Lock", "matrix": [2, 0], "w": 1.75, "x": 0, "y": 2 },
+                { "label": "|", "matrix": [1, 13], "x": 13.5, "y": 1, "w": 1.5 },
+
+                { "label": "Caps Lock", "matrix": [2, 0], "x": 0, "y": 2, "w": 1.75 },
                 { "label": "A", "matrix": [2, 1], "x": 1.75, "y": 2 },
                 { "label": "S", "matrix": [2, 2], "x": 2.75, "y": 2 },
                 { "label": "D", "matrix": [2, 3], "x": 3.75, "y": 2 },
@@ -165,11 +174,12 @@
                 { "label": "L", "matrix": [2, 9], "x": 9.75, "y": 2 },
                 { "label": ":", "matrix": [2, 10], "x": 10.75, "y": 2 },
                 { "label": "\"", "matrix": [2, 11], "x": 11.75, "y": 2 },
-                { "label": "Enter", "matrix": [2, 13], "w": 2.25, "x": 12.75, "y": 2 },
-                { "label": "Shift", "matrix": [3, 0], "w": 2.25, "x": 0, "y": 3 },
+                { "label": "Enter", "matrix": [2, 13], "x": 12.75, "y": 2, "w": 2.25 },
+
+                { "label": "Shift", "matrix": [3, 0], "x": 0, "y": 3, "w": 2.25 },
                 { "label": "Z", "matrix": [3, 2], "x": 2.25, "y": 3 },
                 { "label": "X", "matrix": [3, 3], "x": 3.25, "y": 3 },
-                { "label": "C", "matrix": [3, 4], "x": 3, "y": 3 },
+                { "label": "C", "matrix": [3, 4], "x": 4.25, "y": 3 },
                 { "label": "V", "matrix": [3, 5], "x": 5.25, "y": 3 },
                 { "label": "B", "matrix": [3, 6], "x": 6.25, "y": 3 },
                 { "label": "N", "matrix": [3, 7], "x": 7.25, "y": 3 },
@@ -177,15 +187,84 @@
                 { "label": "<", "matrix": [3, 9], "x": 9.25, "y": 3 },
                 { "label": ">", "matrix": [3, 10], "x": 10.25, "y": 3 },
                 { "label": "?", "matrix": [3, 11], "x": 11.25, "y": 3 },
-                { "label": "Shift", "matrix": [3, 13], "w": 1.75, "x": 12.25, "y": 3 },
+                { "label": "Shift", "matrix": [3, 13], "x": 12.25, "y": 3, "w": 1.75 },
                 { "label": "K54", "matrix": [3, 14], "x": 14, "y": 3 },
-                { "label": "Ctrl", "matrix": [4, 0], "w": 1.5, "x": 0, "y": 4 },
+
+                { "label": "Ctrl", "matrix": [4, 0], "x": 0, "y": 4, "w": 1.5 },
                 { "label": "Win", "matrix": [4, 1], "x": 1.5, "y": 4 },
-                { "label": "Alt", "matrix": [4, 2], "w": 1.5, "x": 2.5, "y": 4 },
-                { "label": "K58", "matrix": [4, 6], "w": 7, "x": 4, "y": 4 },
-                { "label": "Alt", "matrix": [4, 11], "w": 1.5, "x": 11, "y": 4 },
+                { "label": "Alt", "matrix": [4, 2], "x": 2.5, "y": 4, "w": 1.5 },
+                { "label": "K58", "matrix": [4, 6], "x": 4, "y": 4, "w": 7 },
+                { "label": "Alt", "matrix": [4, 11], "x": 11, "y": 4, "w": 1.5 },
                 { "label": "Fn", "matrix": [4, 12], "x": 12.5, "y": 4 },
-                { "label": "Ctrl", "matrix": [4, 13], "w": 1.5, "x": 13.5, "y": 4 }
+                { "label": "Ctrl", "matrix": [4, 13], "x": 13.5, "y": 4, "w": 1.5 }
+            ]
+        },
+        "LAYOUT_60_ansi_tsangan": {
+            "layout": [
+                { "label": "Esc", "matrix": [0, 0], "x": 0, "y": 0 },
+                { "label": "!", "matrix": [0, 1], "x": 1, "y": 0 },
+                { "label": "@", "matrix": [0, 2], "x": 2, "y": 0 },
+                { "label": "#", "matrix": [0, 3], "x": 3, "y": 0 },
+                { "label": "$", "matrix": [0, 4], "x": 4, "y": 0 },
+                { "label": "%", "matrix": [0, 5], "x": 5, "y": 0 },
+                { "label": "^", "matrix": [0, 6], "x": 6, "y": 0 },
+                { "label": "&", "matrix": [0, 7], "x": 7, "y": 0 },
+                { "label": "*", "matrix": [0, 8], "x": 8, "y": 0 },
+                { "label": "(", "matrix": [0, 9], "x": 9, "y": 0 },
+                { "label": ")", "matrix": [0, 10], "x": 10, "y": 0 },
+                { "label": "_", "matrix": [0, 11], "x": 11, "y": 0 },
+                { "label": "+", "matrix": [0, 12], "x": 12, "y": 0 },
+                { "label": "Bksp", "matrix": [0, 13], "x": 13, "y": 0, "w": 2 },
+
+                { "label": "Tab", "matrix": [1, 0], "x": 0, "y": 1, "w": 1.5 },
+                { "label": "Q", "matrix": [1, 1], "x": 1.5, "y": 1 },
+                { "label": "W", "matrix": [1, 2], "x": 2.5, "y": 1 },
+                { "label": "E", "matrix": [1, 3], "x": 3.5, "y": 1 },
+                { "label": "R", "matrix": [1, 4], "x": 4.5, "y": 1 },
+                { "label": "T", "matrix": [1, 5], "x": 5.5, "y": 1 },
+                { "label": "Y", "matrix": [1, 6], "x": 6.5, "y": 1 },
+                { "label": "U", "matrix": [1, 7], "x": 7.5, "y": 1 },
+                { "label": "I", "matrix": [1, 8], "x": 8.5, "y": 1 },
+                { "label": "O", "matrix": [1, 9], "x": 9.5, "y": 1 },
+                { "label": "P", "matrix": [1, 10], "x": 10.5, "y": 1 },
+                { "label": "{", "matrix": [1, 11], "x": 11.5, "y": 1 },
+                { "label": "}", "matrix": [1, 12], "x": 12.5, "y": 1 },
+                { "label": "|", "matrix": [1, 13], "x": 13.5, "y": 1, "w": 1.5 },
+
+                { "label": "Caps Lock", "matrix": [2, 0], "x": 0, "y": 2, "w": 1.75 },
+                { "label": "A", "matrix": [2, 1], "x": 1.75, "y": 2 },
+                { "label": "S", "matrix": [2, 2], "x": 2.75, "y": 2 },
+                { "label": "D", "matrix": [2, 3], "x": 3.75, "y": 2 },
+                { "label": "F", "matrix": [2, 4], "x": 4.75, "y": 2 },
+                { "label": "G", "matrix": [2, 5], "x": 5.75, "y": 2 },
+                { "label": "H", "matrix": [2, 6], "x": 6.75, "y": 2 },
+                { "label": "J", "matrix": [2, 7], "x": 7.75, "y": 2 },
+                { "label": "K", "matrix": [2, 8], "x": 8.75, "y": 2 },
+                { "label": "L", "matrix": [2, 9], "x": 9.75, "y": 2 },
+                { "label": ":", "matrix": [2, 10], "x": 10.75, "y": 2 },
+                { "label": "\"", "matrix": [2, 11], "x": 11.75, "y": 2 },
+                { "label": "Enter", "matrix": [2, 13], "x": 12.75, "y": 2, "w": 2.25 },
+
+                { "label": "Shift", "matrix": [3, 0], "x": 0, "y": 3, "w": 2.25 },
+                { "label": "Z", "matrix": [3, 2], "x": 2.25, "y": 3 },
+                { "label": "X", "matrix": [3, 3], "x": 3.25, "y": 3 },
+                { "label": "C", "matrix": [3, 4], "x": 4.25, "y": 3 },
+                { "label": "V", "matrix": [3, 5], "x": 5.25, "y": 3 },
+                { "label": "B", "matrix": [3, 6], "x": 6.25, "y": 3 },
+                { "label": "N", "matrix": [3, 7], "x": 7.25, "y": 3 },
+                { "label": "M", "matrix": [3, 8], "x": 8.25, "y": 3 },
+                { "label": "<", "matrix": [3, 9], "x": 9.25, "y": 3 },
+                { "label": ">", "matrix": [3, 10], "x": 10.25, "y": 3 },
+                { "label": "?", "matrix": [3, 11], "x": 11.25, "y": 3 },
+                { "label": "Shift", "matrix": [3, 13], "x": 12.25, "y": 3, "w": 2.75 },
+
+                { "label": "Ctrl", "matrix": [4, 0], "x": 0, "y": 4, "w": 1.5 },
+                { "label": "Win", "matrix": [4, 1], "x": 1.5, "y": 4 },
+                { "label": "Alt", "matrix": [4, 2], "x": 2.5, "y": 4, "w": 1.5 },
+                { "label": "K58", "matrix": [4, 6], "x": 4, "y": 4, "w": 7 },
+                { "label": "Alt", "matrix": [4, 11], "x": 11, "y": 4, "w": 1.5 },
+                { "label": "Fn", "matrix": [4, 12], "x": 12.5, "y": 4 },
+                { "label": "Ctrl", "matrix": [4, 13], "x": 13.5, "y": 4, "w": 1.5 }
             ]
         }
     }
diff --git a/keyboards/linworks/fave60a/keymaps/default/keymap.c b/keyboards/linworks/fave60a/keymaps/default/keymap.c
index 22e9c5f782..c77f1b4143 100644
--- a/keyboards/linworks/fave60a/keymaps/default/keymap.c
+++ b/keyboards/linworks/fave60a/keymaps/default/keymap.c
@@ -16,14 +16,14 @@
 #include QMK_KEYBOARD_H
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
-    [0] = LAYOUT(
+    [0] = LAYOUT_60_tsangan_hhkb(
         KC_ESC,     KC_1,    KC_2, KC_3, KC_4, KC_5,   KC_6, KC_7, KC_8, KC_9,    KC_0,    KC_MINS,  KC_EQL,  KC_BSPC, KC_TRNS,
         KC_TAB,     KC_Q,    KC_W, KC_E, KC_R, KC_T,   KC_Y, KC_U, KC_I, KC_O,    KC_P,    KC_LBRC, KC_RBRC,  KC_BSLS,
         KC_CAPS,    KC_A,    KC_S, KC_D, KC_F, KC_G,   KC_H, KC_J, KC_K, KC_L,    KC_SCLN, KC_QUOT,           KC_ENT,
         KC_LSFT,             KC_Z, KC_X, KC_C, KC_V,   KC_B, KC_N, KC_M, KC_COMM, KC_DOT,  KC_SLSH,           KC_RSFT, KC_TRNS,
         KC_LCTL, KC_LGUI, KC_LALT,                   KC_SPC,                               KC_RALT,   MO(1),  KC_RCTL
     ),
-    [1] = LAYOUT(
+    [1] = LAYOUT_60_tsangan_hhkb(
         KC_TRNS,    KC_F1,    KC_F2,    KC_F3,    KC_F4,    KC_F5,    KC_F6,    KC_F7,    KC_F8,    KC_F9,   KC_F10,   KC_F11,    KC_F12,   KC_DEL,   KC_DEL,
         KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_PGUP,    KC_UP,  KC_PGDN,  KC_PSCR,  KC_SCRL,   KC_PAUS,  KC_TRNS,
         KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_LEFT,  KC_DOWN,  KC_RGHT,   KC_INS,   KC_DEL,             KC_TRNS,
diff --git a/keyboards/linworks/fave60a/keymaps/via/keymap.c b/keyboards/linworks/fave60a/keymaps/via/keymap.c
index 22e9c5f782..c77f1b4143 100644
--- a/keyboards/linworks/fave60a/keymaps/via/keymap.c
+++ b/keyboards/linworks/fave60a/keymaps/via/keymap.c
@@ -16,14 +16,14 @@
 #include QMK_KEYBOARD_H
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
-    [0] = LAYOUT(
+    [0] = LAYOUT_60_tsangan_hhkb(
         KC_ESC,     KC_1,    KC_2, KC_3, KC_4, KC_5,   KC_6, KC_7, KC_8, KC_9,    KC_0,    KC_MINS,  KC_EQL,  KC_BSPC, KC_TRNS,
         KC_TAB,     KC_Q,    KC_W, KC_E, KC_R, KC_T,   KC_Y, KC_U, KC_I, KC_O,    KC_P,    KC_LBRC, KC_RBRC,  KC_BSLS,
         KC_CAPS,    KC_A,    KC_S, KC_D, KC_F, KC_G,   KC_H, KC_J, KC_K, KC_L,    KC_SCLN, KC_QUOT,           KC_ENT,
         KC_LSFT,             KC_Z, KC_X, KC_C, KC_V,   KC_B, KC_N, KC_M, KC_COMM, KC_DOT,  KC_SLSH,           KC_RSFT, KC_TRNS,
         KC_LCTL, KC_LGUI, KC_LALT,                   KC_SPC,                               KC_RALT,   MO(1),  KC_RCTL
     ),
-    [1] = LAYOUT(
+    [1] = LAYOUT_60_tsangan_hhkb(
         KC_TRNS,    KC_F1,    KC_F2,    KC_F3,    KC_F4,    KC_F5,    KC_F6,    KC_F7,    KC_F8,    KC_F9,   KC_F10,   KC_F11,    KC_F12,   KC_DEL,   KC_DEL,
         KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_PGUP,    KC_UP,  KC_PGDN,  KC_PSCR,  KC_SCRL,   KC_PAUS,  KC_TRNS,
         KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_LEFT,  KC_DOWN,  KC_RGHT,   KC_INS,   KC_DEL,             KC_TRNS,
diff --git a/keyboards/linworks/fave60a/matrix_diagram.md b/keyboards/linworks/fave60a/matrix_diagram.md
new file mode 100644
index 0000000000..ccf0002be3
--- /dev/null
+++ b/keyboards/linworks/fave60a/matrix_diagram.md
@@ -0,0 +1,21 @@
+# Matrix Diagram for Lx3 fave60a
+
+```
+                                                    ┌───────┐
+                                       2u Backspace │0D     │
+                                                    └───────┘
+┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┐
+│00 │01 │02 │03 │04 │05 │06 │07 │08 │09 │0A │0B │0C │0D │0E │
+├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┤
+│10   │11 │12 │13 │14 │15 │16 │17 │18 │19 │1A │1B │1C │1D   │
+├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
+│20    │21 │22 │23 │24 │25 │26 │27 │28 │29 │2A │2B │2D      │
+├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────┬───┤
+│30      │32 │33 │34 │35 │36 │37 │38 │39 │3A │3B │3D    │3E │
+├─────┬──┴┬──┴──┬┴───┴───┴───┴───┴───┴───┴──┬┴───┴┬───┬─┴───┤
+│40   │41 │42   │46                         │4B   │4C │4D   │
+└─────┴───┴─────┴───────────────────────────┴─────┴───┴─────┘
+                                                 ┌──────────┐
+                                    2.75u RShift │3D        │
+                                                 └──────────┘
+```