qmk/qmk_firmware

[XAP Prereq] `info.json` layout options

Open

#15,599 opened on Dec 27, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C (43,867 forks)batch import
awaiting changesenhancementhelp wantedin progressxap

Repository metrics

Stars
 (20,368 stars)
PR merge metrics
 (Avg merge 20d 9h) (27 merged PRs in 30d)

Description

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.

Contributor guide

Research direction
Examine the current info.json layout definitions in the QMK firmware repository, understand the XAP protocol and the placeholder PR. Propose a schema for layout options that can remove/add keys based on selection. Discuss with QMK collaborators before implementation.
Tech stack
c
Domain
data
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
CJSONQMK knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40