{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Config",
"type": "object",
"required": [
"constant",
"dynamic"
],
"properties": {
"constant": {
"$ref": "#/definitions/ConstantConfig"
},
"dynamic": {
"$ref": "#/definitions/DynamicConfig"
}
},
"definitions": {
"BufferSizeConfig": {
"type": "object",
"properties": {
"encoder_event": {
"description": "Size of the encoder event buffer",
"default": 4,
"type": "integer",
"format": "uint",
"minimum": 0.0
},
"keyboard_event": {
"description": "Size of the keyboard event buffer",
"default": 4,
"type": "integer",
"format": "uint",
"minimum": 0.0
},
"log_channel": {
"description": "Size of the log channel buffer",
"default": 64,
"type": "integer",
"format": "uint",
"minimum": 0.0
},
"mouse_event": {
"description": "Size of the mouse event buffer",
"default": 4,
"type": "integer",
"format": "uint",
"minimum": 0.0
},
"rrp": {
"description": "Size of the buffer used by rrp",
"default": 512,
"type": "integer",
"format": "uint",
"minimum": 0.0
},
"split_channel": {
"description": "Size of the split channel buffer",
"default": 64,
"type": "integer",
"format": "uint",
"minimum": 0.0
}
},
"additionalProperties": false
},
"ComboConfig": {
"type": "object",
"properties": {
"threshold": {
"default": 50,
"type": "integer",
"format": "uint32",
"minimum": 0.0
}
},
"additionalProperties": false
},
"ConstantConfig": {
"description": "Root struct of the \"constant\" config",
"type": "object",
"required": [
"keyboard"
],
"properties": {
"buffer": {
"$ref": "#/definitions/BufferSizeConfig"
},
"key_manager": {
"$ref": "#/definitions/KeymanagerConstantConfig"
},
"keyboard": {
"$ref": "#/definitions/KeyboardConstantConfig"
}
},
"additionalProperties": false
},
"DynamicConfig": {
"description": "Root struct of the \"dynamic\" config",
"type": "object",
"required": [
"keyboard"
],
"properties": {
"key_manager": {
"$ref": "#/definitions/KeyManagerConfig"
},
"keyboard": {
"$ref": "#/definitions/KeyboardConfig"
},
"rktk": {
"$ref": "#/definitions/RktkConfig"
}
}
},
"KeyManagerConfig": {
"description": "Config for key manager.",
"type": "object",
"properties": {
"key_resolver": {
"$ref": "#/definitions/KeyResolverConfig"
},
"mouse": {
"$ref": "#/definitions/MouseConfig"
}
},
"additionalProperties": false
},
"KeyResolverConfig": {
"type": "object",
"properties": {
"combo": {
"$ref": "#/definitions/ComboConfig"
},
"tap_dance": {
"$ref": "#/definitions/TapDanceConfig"
},
"tap_hold": {
"$ref": "#/definitions/TapHoldConfig"
}
},
"additionalProperties": false
},
"KeyboardConfig": {
"description": "Keyboard layout and informations.\n\nThis struct is used to - Defines keyboard basic informations (ex: name, cols, rows, ...) - Defines keyboard physical layout which is used by remapper (layout property)\n\n# Coordination of the keyboard matrix\n\nThe rktk coordinate system has the top left as (0,0), and the coordinate values increase toward the bottom right.\n\n## Split keyboard coordinates For `col` in keyboard config, specify the coordinates of the entire keyboard. In other words, for a split keyboard with 7 columns on the left hand side and 7 columns on the right hand side, specify 14.\n\nInternally, the key scan driver returns the coordinates of \"only one hand.\" In other words, in this case, x=0-6. Therefore, it is necessary to convert the coordinates received from the key scan driver into the coordinates of both hands, and for this purpose the `split_right_shift` property is used.\n\nBelow is an example of a split keyboard with 14 columns and 4 rows. ```ignored [ Left ] [ Right ] 0 1 2 3 4 5 6 0 1 2 3 4 5 6 ← One-handed coordinates ↓ split_right_shift=7 (or None) col=14 → 0 1 2 3 4 5 6 7 8 9 10 11 12 13 ← Two-handed coordinates 0 _ Q W E R T _ _ Y U I O P _ 1 ... 2 ... 3 ... ↑ row=4 ```",
"type": "object",
"required": [
"name"
],
"properties": {
"layout": {
"description": "Defines the layout of the keyboard used in the remapper.\n\nThis is a JSON object that represents the layout of the keyboard and compatible with via's json layout format.",
"anyOf": [
{
"$ref": "#/definitions/KeyboardLayout"
},
{
"type": "null"
}
]
},
"name": {
"description": "The name of the keyboard.",
"type": "string"
},
"split_right_shift": {
"description": "A number representing the row number that the right col starts on in a split keyboard.\n\nIf not set, `cols / 2` will be automatically set, so there is no need to set it if the number of columns on the right and left sides is the same. Also, there is no need to set it in the case of a non-split keyboard, as it is not used.",
"default": null,
"type": [
"integer",
"null"
],
"format": "uint8",
"minimum": 0.0
}
},
"additionalProperties": false
},
"KeyboardConstantConfig": {
"type": "object",
"required": [
"cols",
"rows"
],
"properties": {
"cols": {
"description": "The number of columns in the keyboard matrix.",
"type": "integer",
"format": "uint8",
"minimum": 0.0
},
"encoder_count": {
"description": "The number of encoder keys.",
"default": 0,
"type": "integer",
"format": "uint8",
"minimum": 0.0
},
"left_rgb_count": {
"description": "RGB led count for left side. This is also used for non-split keyboard.",
"default": 0,
"type": "integer",
"format": "uint",
"minimum": 0.0
},
"right_rgb_count": {
"description": "RGB led count for right side",
"default": 0,
"type": "integer",
"format": "uint",
"minimum": 0.0
},
"rows": {
"description": "The number of rows in the keyboard matrix.",
"type": "integer",
"format": "uint8",
"minimum": 0.0
}
},
"additionalProperties": false
},
"KeyboardLayout": {
"type": "object",
"required": [
"keymap"
],
"properties": {
"keymap": {
"description": "Keymap json data.\n\nThis is basically kle's json but logical key location data is added as legend."
},
"labels": {
"description": "Currently, this is unused in rktk.",
"default": [],
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"KeymanagerConstantConfig": {
"type": "object",
"properties": {
"combo_key_max_definitions": {
"default": 2,
"type": "integer",
"format": "uint",
"minimum": 0.0
},
"combo_key_max_sources": {
"default": 3,
"type": "integer",
"format": "uint",
"minimum": 0.0
},
"layer_count": {
"default": 5,
"type": "integer",
"format": "uint8",
"minimum": 0.0
},
"normal_max_pressed_keys": {
"default": 8,
"type": "integer",
"format": "uint",
"minimum": 0.0
},
"oneshot_state_size": {
"default": 4,
"type": "integer",
"format": "uint",
"minimum": 0.0
},
"tap_dance_max_definitions": {
"default": 2,
"type": "integer",
"format": "uint",
"minimum": 0.0
},
"tap_dance_max_repeats": {
"default": 4,
"type": "integer",
"format": "uint",
"minimum": 0.0
}
},
"additionalProperties": false
},
"MouseConfig": {
"type": "object",
"properties": {
"auto_mouse_duration": {
"default": 500,
"type": "integer",
"format": "uint32",
"minimum": 0.0
},
"auto_mouse_layer": {
"default": 1,
"type": "integer",
"format": "uint8",
"minimum": 0.0
},
"auto_mouse_threshold": {
"default": 0,
"type": "integer",
"format": "uint8",
"minimum": 0.0
},
"scroll_divider_x": {
"default": 20,
"type": "integer",
"format": "int8"
},
"scroll_divider_y": {
"default": -12,
"type": "integer",
"format": "int8"
}
},
"additionalProperties": false
},
"RktkConfig": {
"description": "RKTK behavior config",
"type": "object",
"properties": {
"default_auto_mouse_duration": {
"description": "Default duration of auto mouse mode (ms)",
"default": 500,
"type": "integer",
"format": "uint32",
"minimum": 0.0
},
"default_cpi": {
"description": "Default CPI value for mouse",
"default": 600,
"type": "integer",
"format": "uint16",
"minimum": 0.0
},
"display_timeout": {
"description": "Time(ms) until the display is turned off if there is no activity",
"default": 20000,
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"double_tap_threshold": {
"description": "Threshold for double tap (ms).",
"default": 500,
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"scan_interval_keyboard": {
"description": "Time (ms) to wait for the next keyboard scan",
"default": 5,
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"scan_interval_mouse": {
"description": "Time (ms) to wait for the next mouse scan",
"default": 5,
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"split_usb_timeout": {
"description": "Timeout for detecting split USB connection (ms).",
"default": 1000,
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"state_update_interval": {
"description": "rktk basically updates the keyboard state only when it receives an event from the hardware. However, many states are time-dependent and can change even without an event. Polling at regular time intervals is necessary to monitor such changes.\n\nThis setting specifies that interval. (ms)",
"default": 10,
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"swap_mouse_x_y": {
"description": "Swap the x and y values obtained from the mouse driver. This also affects the scroll direction.",
"default": false,
"type": "boolean"
}
},
"additionalProperties": false
},
"TapDanceConfig": {
"type": "object",
"properties": {
"threshold": {
"default": 200,
"type": "integer",
"format": "uint32",
"minimum": 0.0
}
},
"additionalProperties": false
},
"TapHoldConfig": {
"type": "object",
"properties": {
"hold_on_other_key": {
"default": true,
"type": "boolean"
},
"threshold": {
"default": 200,
"type": "integer",
"format": "uint32",
"minimum": 0.0
}
},
"additionalProperties": false
}
}
}