diff options
Diffstat (limited to 'docs/reference_configurator_support.md')
| -rw-r--r-- | docs/reference_configurator_support.md | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/docs/reference_configurator_support.md b/docs/reference_configurator_support.md index 58c1a2d20..88676ba97 100644 --- a/docs/reference_configurator_support.md +++ b/docs/reference_configurator_support.md | |||
| @@ -10,11 +10,11 @@ To understand how the Configurator understands keyboards, first one must underst | |||
| 10 | ``` | 10 | ``` |
| 11 | |---------------| | 11 | |---------------| |
| 12 | |NLk| / | * | - | | 12 | |NLk| / | * | - | |
| 13 | |---+---+-------| | 13 | |---+---+---+---| |
| 14 | |7 |8 |9 | + | | 14 | |7 |8 |9 | + | |
| 15 | |---+---+---| │ | 15 | |---+---+---| | |
| 16 | |4 |5 |6 | | | 16 | |4 |5 |6 | | |
| 17 | |---+---+-------| | 17 | |---+---+---+---| |
| 18 | |1 |2 |3 |Ent| | 18 | |1 |2 |3 |Ent| |
| 19 | |-------+---| | | 19 | |-------+---| | |
| 20 | |0 | . | | | 20 | |0 | . | | |
| @@ -130,18 +130,20 @@ Use the `keyboard_name` object to set the name of the keyboard. For instruction | |||
| 130 | The `layouts` object contains the data that represents the physical layout of the keyboard. It has an object `LAYOUT`, which needs to match the name of our layout macro from `numpad.h`. The `LAYOUT` object itself has an object named `layout`, which contains one JSON object for each physical key on our keyboard, formatted as follows: | 130 | The `layouts` object contains the data that represents the physical layout of the keyboard. It has an object `LAYOUT`, which needs to match the name of our layout macro from `numpad.h`. The `LAYOUT` object itself has an object named `layout`, which contains one JSON object for each physical key on our keyboard, formatted as follows: |
| 131 | 131 | ||
| 132 | ``` | 132 | ``` |
| 133 | ┌ The name of the key. Not displayed in the Configurator. | 133 | The name of the key. Not displayed in the Configurator. |
| 134 | │ ┌ The key's X-axis location, in key units from the | 134 | | |
| 135 | │ │ keyboard's left edge. | 135 | | The key's X-axis location, in key units from the |
| 136 | │ │ ┌ The key's Y-axis location, in key units from | 136 | | | keyboard's left edge. |
| 137 | │ │ │ the keyboard's top (rear-facing) edge. | 137 | | | |
| 138 | | | The key's Y-axis location, in key units from | ||
| 139 | | | | the keyboard's top (rear-facing) edge. | ||
| 138 | ↓ ↓ ↓ | 140 | ↓ ↓ ↓ |
| 139 | {"label":"Num Lock", "x":0, "y":0}, | 141 | {"label":"Num Lock", "x":0, "y":0}, |
| 140 | ``` | 142 | ``` |
| 141 | 143 | ||
| 142 | Some objects will also have `"w"` and `"h"` keys, which represent a key's width and height, respectively. | 144 | Some objects will also have `"w"` and `"h"` keys, which represent a key's width and height, respectively. |
| 143 | 145 | ||
| 144 | ?> For more on the `info.json` files, see [QMK Keyboard Guidelines: Keyboard Metadata](hardware_keyboard_guidelines.md?id=keyboard-metadata) | 146 | ?> For more on the `info.json` files, see [`info.json` Format](reference_info_json.md). |
| 145 | 147 | ||
| 146 | 148 | ||
| 147 | ## How the Configurator Programs Keys | 149 | ## How the Configurator Programs Keys |