qmk_userspace/keyboards/klor/readme.md
Victor 0c479c0502
Got everything working
- can't have a layout macro start with LAYOUT. Now it's just KLOR(...)
- Turn off extra features for AVR MCU in post_rules.mk. This helps
all customizations remain in the keymap.
- Updatd documentation
2024-05-15 23:07:32 -05:00

2.3 KiB

█         █    █            ▄▄▄▀▀▀▀▀▀▄▄▄        █▀▀▀▀▀▀▀▀▀▀█
█        █     █          ▄▀            ▀▄      █          █
█       █      █        ▄▀                ▀▄    █          █
█      █       █        █                  █    █          █
█     █        █       █                    █   █          █
█    █         █       █                    █   █▄▄▄▄▄▄▄▄▄▄█
█   █ █        █       █                    █   █      █
█  █   █       █        █                  █    █       █
█ █     █      █        ▀▄                ▄▀    █        █
██       █     █          ▀▄            ▄▀      █         █
█         █    █▄▄▄▄▄▄▄▄    ▀▀▀▄▄▄▄▄▄▀▀▀        █          █

KLOR split keyboard

KLOR is 42 keys column-staggered split keyboard made by @geigeigeist. It supports a per key RGB matrix, encoders, OLED displays, haptic feedback, audio, a Pixart Paw3204 trackball and four different layouts, through brake off parts. It's schematics are based on the Sofle, while the layout is based on the Yacc46.

You can use this command to compile the firmware qmk compile -kb klor -km default

and this command if you want to compile the firmware for a RP2040 based MCU qmk compile -kb klor/2040 -km default

t4corun modernization

this is my attempt at modernizing @geigeigeist's repo. It has not been updated in a few years and firmware cannot be built as-is as QMK has introduced breaking changes. @geigeigeist's repo can be found here. Should work for all KLOR variations, but I tested against Saegwerk as that is the one I have

Features

  • Can choose layout based on keymap rules.mk configuration. Before keyboard configuration would need to be changed
  • Converted as much as possible to data driven configuration: info.json
  • the build will automatically turn off audio, haptics, and rgb matrix for AVR MCU. A user can configure all rules in the keymap rules.mk for RP2040 and not have to edit code just for AVR firmware

What I did not test

  • RGBLight
  • Other variations (e.g.Polydactyl)
  • Swap Hands