configurator_default_keymaps.md - # Adding Default Keymaps...

This preview shows page 1 - 2 out of 5 pages.

# Adding Default Keymaps to QMK Configurator :id=adding-default-keymapsThis page covers how to add a default keymap for a keyboard to QMK Configurator.## Technical Information :id=technical-informationQMK Configurator uses JSON as its native file format for keymaps. As much aspossible, these should be kept such that they behave the same as running `make<keyboard>:default` from `qmk_firmware`.Keymaps in this directory require four key-value pairs:* `keyboard` (string)* This is the name of the keyboard, the same as would be used when running acompile job through `make` (e.g. `make 1upkeyboards/1up60rgb:default`).* `keymap` (string)* Should be set to `default`.* `layout` (string)* This is the layout macro used by the default keymap.* `layers` (array)* The keymap itself. This key should contain one array per layer, whichthemselves should contain the keycodes that make up that layer.Additionally, most keymaps contain a `commit` key. This key is not consumed bythe API that back-stops QMK Configurator, but is used by Configurator'smaintainers to tell which version of a keymap was used to create the JSON keymapin this repository. The value is the SHA of the last commit to modify a board'sdefault `keymap.c` in the `qmk_firmware` repository. The SHA is found bychecking out [the `master` branch of the `qmk/qmk_firmware` repository]() and running `git log -1--pretty=oneline -- keyboards/<keyboard>/keymaps/default/keymap.c` (use`keymap.json` if the keyboard in question has this file instead), which shouldreturn something similar to:```shellf14629ed1cd7c7ec9089604d64f29a99981558e8 Remove/migrate action_get_macro()s fromdefault keymaps (#5625)```In this example, `f14629ed1cd7c7ec9089604d64f29a99981558e8` is the value thatshould be used for `commit`.## Example :id=exampleIf one wished to add a default keymap for the H87a by Hineybush, one would runthe `git log` command above against the H87a's default keymap in `qmk_firmware`:```shelluser ~/qmk_firmware (master)$ git log -1 --pretty=oneline master --

Upload your study docs or become a

Course Hero member to access this document

Upload your study docs or become a

Course Hero member to access this document

End of preview. Want to read all 5 pages?

Upload your study docs or become a

Course Hero member to access this document

Term
Fall
Professor
N/A
Tags
Keyboard layout, Apple Keyboard, QMK Configurator

  • Left Quote Icon

    Student Picture

  • Left Quote Icon

    Student Picture

  • Left Quote Icon

    Student Picture