Skip to content

Latest commit

 

History

History

en

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Display.md
Display.md
 
 
Getting_Started.md
Getting_Started.md
 
 
Officially_Supported_Microcontrollers.md
Officially_Supported_Microcontrollers.md
 
 
README.md
README.md
 
 
adns9800.md
adns9800.md
 
 
analogin.md
analogin.md
 
 
ble_hid.md
ble_hid.md
 
 
boot.md
boot.md
 
 
capsword.md
capsword.md
 
 
cg_swap.md
cg_swap.md
 
 
combo_layers.md
combo_layers.md
 
 
combos.md
combos.md
 
 
config_and_keymap.md
config_and_keymap.md
 
 
contributing.md
contributing.md
 
 
debugging.md
debugging.md
 
 
dynamic_sequences.md
dynamic_sequences.md
 
 
easypoint.md
easypoint.md
 
 
encoder.md
encoder.md
 
 
extension_statusled.md
extension_statusled.md
 
 
extension_stringy_keymaps.md
extension_stringy_keymaps.md
 
 
extensions.md
extensions.md
 
 
flashing.md
flashing.md
 
 
handwiring.md
handwiring.md
 
 
holdtap.md
holdtap.md
 
 
international.md
international.md
 
 
keycodes.md
keycodes.md
 
 
keys.md
keys.md
 
 
kmkpython_vs_circuitpython.md
kmkpython_vs_circuitpython.md
 
 
layers.md
layers.md
 
 
led.md
led.md
 
 
lock_status.md
lock_status.md
 
 
macros.md
macros.md
 
 
media_keys.md
media_keys.md
 
 
midi.md
midi.md
 
 
modules.md
modules.md
 
 
mouse_keys.md
mouse_keys.md
 
 
peg_rgb_matrix.md
peg_rgb_matrix.md
 
 
pimoroni_trackball.md
pimoroni_trackball.md
 
 
pins56.jpg
pins56.jpg
 
 
porting_to_kmk.md
porting_to_kmk.md
 
 
power.md
power.md
 
 
pro_micro_pinout.png
pro_micro_pinout.png
 
 
quickpin.md
quickpin.md
 
 
rapidfire.md
rapidfire.md
 
 
rgb.md
rgb.md
 
 
scanners.md
scanners.md
 
 
serialace.md
serialace.md
 
 
split_keyboards.md
split_keyboards.md
 
 
steno.md
steno.md
 
 
sticky_keys.md
sticky_keys.md
 
 
sticky_mod.md
sticky_mod.md
 
 
string_substitution.md
string_substitution.md
 
 
support.md
support.md
 
 
tapdance.md
tapdance.md
 
 

README.md

How to get it

KMK is updated often and sometimes a lot. Obtaining a fresh copy can be done by forking the main branch of this repository, or downloading a snapshot of it.

Pre-compiled version of KMK can be acquired by navigating to Actions > Build, there it can be found under artifacts for the latest build.

Documentation index

Before you look further, you probably want to start with our getting started guide.

Basics

Advanced

Modules

  • Combos: Adds chords and sequences
  • Layers: Adds layer support (Fn key) to allow many more keys to be put on your keyboard
  • HoldTap: Adds support for augmented modifier keys to act as one key when tapped, and modifier when held.
  • Macros: Adds macros.
  • Mouse keys: Adds mouse keycodes
  • Sticky keys: Adds support for sticky keys, alias one shot keys.
  • Power: Power saving features. This is mostly useful when on battery power.
  • SerialACE: [DANGER - see module README] Arbitrary Code Execution over the data serial.
  • Split: Keyboards split in two. Seems ergonomic!
  • TapDance: Different key actions depending on how often it is pressed.
  • Steno: Communicate with stenography software over serial.

Peripherals

Extensions

  • International: Adds international keycodes
  • LED: Adds backlight support. This is for monocolor backlight, not RGB
  • LockStatus: Exposes host-side locks like caps or num lock.
  • MediaKeys: Adds support for media keys such as volume
  • RGB: RGB lighting for underglow. Will work on most matrix RGB as will be treated the same as underglow.
  • Status LED: Indicates which layer you are on with an array of single leds.