This is a small utility for my lovely keyboard – Model01 Keyboard - it basically allows you to design your own color layout and then store it EEPROM thus it will be persisted in your keyboard.
To install this application just grab a precompiled binary in releases (I'm supporting only Mac and Windows for now, with an experimental support of Linux/Debian).
The other way is to build the application by your own – see Contributing.
For the deprecated version 1.0.x you have to enhance your Model01's firmware with Kaleidoscope-LEDCustomPalette. See the documentation for more information and example.
First thing you have to do is prepare you firmware. Namely you have to initialize those plugin Focus, EEPROMSettings, LEDPaletteTheme ColormapEffect, good thing is that all of them are pre-installed. That means you have to edit #includes, KALEIDOSCOPE_INIT_PLUGINS, and setup phase of you firmware. It might sound difficult especially if you are not familiar with it, the easiest should be just check it out the example firmware. It's fully configured for easy start with LED Custom Palette.
Once you successfully flash your keyboard's firmware you should be able to run the application successfully. The LED Custom Palette then automatically find the serial port of your keyboard and if you have configured the plugin correctly you will be welcomed with a default state of the application with Palette, Layout and Status Bar component.
Left mouse click to select the active color. Signalized by small arrow pointing to it.
Right mouse click to change the color itself.
You can switch the layer you are creating color layout for.
Left mouse click to set the specific keycap with the currently selected color.
On left you have a information if your design is in sync with Model01's one. On right you have the sync button – once you click on it, the design will be uploaded into your keyboard and will be persisted across the runs.
There is a little "reset color palette" button to reset the palette with An Optimum 16 Color Palette.
Required Node.js (8+) stack.
You should be able to build the project pretty easily by your own. Just yarn to install all dependencies.
On Windows you would need a properly configured stack, I'd recommend windows-build-tools.
# run application in development mode
yarn start
# compile source code and create webpack output
yarn compile
# `yarn compile` & create build with electron-builder for macOS
yarn build:mac
# ... Win32
yarn build:win
# ... Linux
yarn build:linux
# run Jest's unit tests
yarn testDo you miss something? Open an issue, I'd like to hear more about your use case. You can also fork this repository run yarn and send a PR! ❤️
To my lovely @nataliesimcik for a great app icon. ❤️
The MIT License (MIT) 2018 - Jakub Beneš
