Config File
The config file contains most of the details for building and modifying a keyboard. It is based on the keyd mapping config file format with a some missing features, some extra features and configuration options needed for a mechanical keyboard. Notably the firmware section defines most of the parameters needed to convert key switch presses in to sending USB HID messages to the host computer. The config file can be used in two places:
- as part of the rust project that builds the firmware;
- as input to the
rpk-config
command line tool to instantly change the behavior of a running keyboard.
Configuration files loosely follow a INI style format consisting of headers of the form
[section_name]
followed by a set of bindings. Lines beginning with a hash #
are ignored.
A valid config file must at least have a matrix section.
Special characters like brackets [
can be escaped with a backslash \[
.