Keyfile is a DSL for defining a keyboard and how it will opperate.

This could directly compile to binary, however, that is more complicated then I want to deal with so it goes to C and then you can utilize QMK to compile it to binary.

There are three goals targeted in the creation of this format.

1. It must be clear to understand.
2. It must be easy to modify.
3. It must be as verbose as pure C and as easy to use as a GUI.

All instructions start with a token. The parser will read subsequent lines as belonging to the last used token until a new token is encountered. This allows commands to span multiple lines as long as they do not begin with a new token.

INJECT colors.kf
INJECT keys.kf

KEYBOARD LAYOUT_planck_grid MATRIX_ROWS MATRIX_COLS RGB_MATRIX_LED_COUNT _base _syms _nums _delete _mouse _fn _macro

KEY fn MO _fn c_yellow
KEY syms MO _syms c_yellow
KEY nums MO _nums c_yellow
KEY mouse MO _mouse c_yellow

COLOR c_macro 0 51 200
STRING s_macro Hello World!
KEY MACRO hi s_macro c_macro

KEY DUAL _syms _nums _delete

LAYER _base
q       w       e       r       t       del     bac      y       u       i       o       p
a       s       d       f       g       '       enter    h       j       k       l       ;
z       x       c       v       b       esc     tab      n       m       ,       .       /
ctl     alt     fn      sft     syms    space   SKIP     nums    mouse   hi      os      alt

More Examples: https://github.com/lewibs/keyfile/blob/main/examples

• Sentence: A sequence of one of the following elements:

  sentence ::= (inject | comment | keyboard | key | string | color | layer)

• Inject: Includes an external file or path.

  inject ::= INJECT file_path

• Keyboard: Defines the keyboard configuration, including macros, rows, columns, LEDs, and layer names.

  keyboard ::= KEYBOARD macro macro macro layer_ref+

• Key: Defines different types of keys.

  key ::= KEY MACRO identifier string_ref color_ref
  key ::= KEY DUAL layer_ref layer_ref layer_ref
  key ::= KEY TRANS
  key ::= KEY SKIP
  key ::= KEY identifier modifier key_ref color_ref

• String: A string that is stored as a variable

  string ::= STRING word+

• Comment: A string that is not read by the machine at runtime

  comment ::= COMMENT word+

• Color: A color in HSV

  color ::= COLOR identifier number number number

• Layer: A layer on the keyboard that can be accessed

  layer ::= LAYER identifier key_ref+

• Modifier: Includes both key modifiers and layer modifiers.

  modifier ::= (key_modifier | layer_modifier)

• Key Modifier: A modifier that can be included onto a key such as Alt

  key_modifier ::= (LSFT | RSFT | LCTL | RCTL | LALT | RALT)*

• Layer Modifier: A modifier that will define how a layer is accessed

  layer_modifier ::= (MO | TG | TT)?

• Key Reference: An identifier that is reffering to a key

  key_ref ::= (identifier | keycode)

• String Reference: An identifier that is reffering to a string

  string_ref ::= identifier

• Layer Reference: An identifier that is reffering to a layer

  layer_ref ::= identifier

• Color Reference: An identifier that is reffering to a color

  color_ref ::= identifier

• File Path: A path to a file on the machine

  file_path ::= non_whitespace

• Identifier: An identifier that is reffering to some saved variable

  identifier ::= non_whitespace

• Key Code: A code macro that is native to QMK

  keycode ::= word

• Macro: A macro that is native to QMK

  macro ::= word

• Word: A sequence of non-whitespace characters.

  word ::= (non_whitespace)+

• Non-Whitespace: Represents any character except whitespace.

  non_whitespace ::= ? [^\s]+ ?

• Number: Can be an integer or a floating-point number.

  number ::= integer | float

• Integer: A sequence of digits.

  integer ::= digit+

• Float: A sequence of digits with a decimal point.

  float ::= digit+ "." digit+

• Digit: Any single digit from 0 to 9.

  digit ::= "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"

• set it up to run with QMK so it can make the .bin right away and delete the keymap files
• need to make config.h generate
• rules.mk!!!!

python ./src/keyfile.py -i C:\Users\lewibs\github\keyfile\examples\lewibs.planck.ez.glow.kf -n keyboard -o ./examples/output