qmk/qmk_firmware

[XAP Prereq] `info.json` layout options

Open

#15,599 创建于 2021年12月27日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)C (43,867 fork)batch import
awaiting changesenhancementhelp wantedin progressxap

仓库指标

Star
 (20,368 star)
PR 合并指标
 (平均合并 20天 9小时) (30 天内合并 27 个 PR)

描述

XAP Task Info

Original Issue Original spec document Current XAP Definitions Current XAP Generated Docs Placeholder PR

Description

Any work in this area needs to be discussed with QMK Collaborators first, and in this case primarily with @skullydazed due to their prior work in this area.

The info.json format needs to be modified such that rather than specifying multiple fully defined LAYOUTs, a single layout can be specified with "layout options" that are capable of removing and adding keys depending on the selection.

This enables a much smaller method of defining such layout combinations -- if a keyboard supported:

  • 2U backspace or split backspace
  • ANSI or ISO Enter
  • 6U, 6.25U, 7U, or Tsangan bottom row

Then under the current format the info.json would need to define 2x2x4=16 layouts. A "base" with "options" would significantly decrease the amount of definitions required, as well as significantly lower the size of the embedded info.json blob for XAP.

贡献者指南