Repository files navigation

Chrysalis is a graphical configuration tool forKaleidoscope-powered keyboards.

• Layout editor to edit the keymap on-the-fly, with the ability to copy onelayer to another, and to set a default one.
• Colormap editor to edit the per-key LED colormap on boards that support it.
• Firmware upgrade to upload either the default, Chrysalis-enabled firmware that ships with the application, or acustom one.

Chrysalis supports theKeyboardio Model01, theKeyboardioModel100 and theKeyboardio Atreus.

Chrysalis is a web based application that runs online athttps://chrysalis.keyboard.io

Your browser needs to support the WebSerial and WebUSB standards. As of this writing, that includesChrome, Edge, Arc, Opera, Brave, and other browsers built on the Chromium engine.

Reporting bugs and feature requests help us make the softwarebetter, please feel free toopen issues liberally!

While Chrysalis comes bundled with supported firmware files, it also supportscustom firmware, as long as it has a few Kaleidoscope plugins enabled:FocusSerial to make it possible to communicate with the keyboard inthe first place,EEPROM-Settings to be able to storeconfiguration in EEPROM. TheFocusSerial plugin provides multiple plugins, andChrysalis needsFocus,FocusEEPROMCommand, andFocusSettingsCommand allenabled in the custom firmware'sKALEIDOSCOPE_INIT_PLUGINS().

Additionally, for Chrysalis to be able to edit the keymap, theEEPROM-Keymap plugin is also required. Similarly, toconfigure the colormap, the custom firmware will need to have theColormap plugin enabled.

If none of the bundled firmwares suit you, and you wish to customise them, orbuild one from scratch, you can do that, and doing so is fully supported!

To launch the development environment, simply typeyarn && yarn start.

We're usingWeblate to manage and maintain translations.