karliss / kb-editor

Tool for editing layouts of custom keyboards.

kb-editor

Tool for editing layouts of custom keyboards. Try it here (might be slightly outdated) or get the latest build from CI here

It is intended for keeping track of mapping between physical layout, logical layout, wiring matrix and scanning matrix and generating configuration files from this information.

Project status

Early development - not exactly end user robust, but has enough functionality to be useful for my personal use

• Physical layout definition - mostly working
• Logical layout mapping - done
• Wiring and scan matrix - done
• Importers - mostly working
• Exporters - helps dealing with most tedious parts related to keys, rest of the config my need manual editing
  • QMK info.json matrix pins, layout (positions and matrix)
  • KLE - basic position, size, label (no advanced styling features)
  • QMK layout macro -> pretty prints taking into account key width. Somewhat redundant due to QMK data driven configuration.
  • QMK keymap.json template -> some fancy formating, for manual editing. No wey to define the content of keymap.
  • VIA json -> VIA specific values need to be filled in manually after exporting
• Key mapping configuration - missing, low priority due to plenty of existing tools doing that

Build instructions

• Install and setup haxe compiler. Should be also available from the official repositories of many Linux distributions
• Install dependencies using haxelib install html5.hxml
• Run the build haxe html5.hxml
• output should be in build/html5/ folder

Build proces for other targets like OpenFL or wxWidgets is a bit more complicated.

Comparison with other tools

• keyboard-layout-editor.com - Focuses on keyboard visual properties. Usefull when desigining look or planning what keycaps to order. Such functionality is currently out of scope for kb-editor. keyboard-layout-editor has almost no function related to configuring keyboard firwmare.

• QMK Configurator - Key mapping configuration tool for end users of existing keyboards. Can build the firmware image. Doesn't help preparing initial configuration when creating a new keyboard. Firmware compilation is out of scope for kb-editor.

• Keyboard Firmware Builder - Similar set of functionality. For limited set of platforms allows very detailed configuration including wiring matrix, pins for key and led connections, basic backlight, macro definition, custom C code snipets. Supports firmware compilation. Import and export formats are very limited. Doesn't support layout creation (needs to be done in KBLE). Almost usless if desired configurtion falls outside set of supported platforms.

kb-editor's Issues

KBLE normal json exporter

Consider introducing electrical to matrix mapping

Possible situations:

• identity mapping
• multiple electrical columns to single matrix column (space saving or non conflicting columns connected together)
• row or column reordering to pcb layout reasons
• arbitrary mapping

Update the demo build

Selecting multiple keys can cause name to be cleared

Sometimes happens when selecting multiple keys in physical tab with drag rectangle.

Slightly more consistently reproducable by selecting single key and then shift selecting second.

Need to have corresponding property section opened.

Flip the view horizontally

For simulating how the keyboard would look from bottom. Might be helpful when soldering.

Consider use of json2object or hxjsonast for more robust import

Newly created key can get stuck

• switch to add mode
• start adding a key
• keep holding mouse to drag it around
• drag the mouse outside key area
• switch to selection mode
• observe that key is stuck to cursor

Undo redo

key mapping editing

Logical keys -> action

Make travis config for running unt tests in js.

Current config runs tests in eval target. There might be some minor differences in behavior between haxe targets.

Property edit interaction with history

Support selecting multiple keys

Add screenshot to readme.

Multiselection in wiring view

Allow selecting multiple keys and assigning row or column

Wiring page

Alignment operations

• align horizontally
• align vertically
• spread evenly
• spread side by side
• round position to grid

Add demo keyboards

Make exploring the tool easier by providing builtin files demonstrating functionality.

QMK data driven configuration

import/export more data from qmk info.json https://docs.qmk.fm/#/data_driven_config

Keyboard shortcuts for non-html5 build.

Keyboard Firmware Builder format support

https://kbfirmware.com/

Layout(logical structure) to base layout

• basic gui
• add remove rename logic
• mapping assignment
• mapping visualization
• mapping statistics
• unassigned visualizer
• import
• auto connect - partially done
• refresh from this
• better rename history interaction
• mapping removal logic

Selection rectangle visualizer

Slightly problematic without custom drawn key view component.

Support formats used by other similar tools and keyboard firmwares

1. Create a list of potential candidates

Implement import/export

Implement the first unstable version for main import/export format, doesn't need to be final format.

Follows #3

Replace travis build status badge

KMK integration

Keyboard firmware written and configured using circuitpython

• keymap export
• key meaning mapping

https://github.com/KMKfw/kmk_firmware

Improve alignment logic when moving using property editor.

Figure out how undo history should interact with view switching.

Effect of some actions can be seen only in certain views.
Clicking undo and having effect on something you don't see seems bad. It is possible to accidentally go back too much.

Add file saving for js

Resize to keyboard doesn't refresh counts above tables

Use appropriate extension when exporting.

Multiselection delete

Better handle negative positions.

• Minvalue for number spinners
• don't allow going negative when dragging

Update CI to use github actions

Wiring row, column swapping

Functionality for easily swap two rows without updating each key.

Consider replacing key drawing component

Current approach of making a key displaying component based on scroll area and regular buttons has some limitations.
Drawing custom component could help with following features

• key rotation
• advanced labels (and other formatting functionality provided by KBLE)
• wire visualization
• better box selection

Led matrix configuration

• Add some properties to key for configuring key LED matrix
• QMK RGB_MATRIX export
  • x y calculation

Fix cpp/hxWidgets build

Fix hxWidgets build when haxeui/haxeui-hxwidgets is fixed.

Build for OpenFL target on CI

Commnd line tool with commands for importing and exporting files.

KBLE raw exporter

tool shortcuts in mechanical page

Layout export dialog

Upload CI builds

Layout macro export for qmk

Add help

Rainbow mode for wiring page

Add two new key coloring modes to help visualizing row column structure

• All keys in the same row with the same color
• All keys in the same column with the same color

Multiselection property edit

Add dummy importer

Configure CI

Make CI configuration for compilation and running unit tests.