info.json
This file is used by the QMK API. It contains the information QMK Configurator needs to display a representation of your keyboard. You can also set metadata here.
You can create info.json
files at every level under qmk_firmware/keyboards/<name>
to specify this metadata. These files are combined, with more specific files overriding keys in less specific files. This means you do not need to duplicate your metadata information. For example, qmk_firmware/keyboards/clueboard/info.json
specifies manufacturer
and maintainer
, while qmk_firmware/keyboards/clueboard/66/info.json
specifies more specific information about Clueboard 66%.
info.json
FormatThe info.json
file is a JSON formatted dictionary with the following keys available to be set. You do not have to set all of them, merely the keys that apply to your keyboard.
keyboard_name
Clueboard 66%
url
maintainer
qmk
for community maintained boardswidth
height
layouts
Within our info.json
file the layouts
portion of the dictionary contains several nested dictionaries. The outer layer consists of QMK layout macros, for example LAYOUT_ansi
or LAYOUT_iso
. Within each layout macro are keys for width
, height
, and key_count
, each of which should be self-explanatory.
width
height
key_count
layout
Each Key Dictionary in a layout describes the physical properties of a key. If you are familiar with the Raw Code for http://keyboard-layout-editor.com you will find many of the concepts the same. We re-use the same key names and layout choices wherever possible, but unlike keyboard-layout-editor each key is stateless, inheriting no properties from the keys that came before it.
All key positions and rotations are specified in relation to the top-left corner of the keyboard, and the top-left corner of each key.
x
y
w
ks
is provided. Default: 1
h
ks
is provided. Default: 1
r
rx
x
ry
y
ks
[ [0,0], [1.5,0], [1.5,2], [0.25,2], [0.25,1], [0,1], [0,0] ]
label
This metadata is primarily used in two ways:
make keyboard:keymap:qmk
target, which bundles this metadata up with the firmware to allow QMK Toolbox to be smarter.Configurator authors can see the QMK Compiler docs for more information on using the JSON API.