kmk_firmware/docs/extensions.md

20 lines
993 B
Markdown
Raw Normal View History

# Extensions
2022-04-29 20:21:16 +02:00
Extensions add features that change the experience, but not the core features of
the keyboard. They are meant to be easy to add, and create your own. These live in
a sandbox to help prevent any bad code from crashing your keyboard.
## Core Extensions
2022-04-29 20:21:16 +02:00
2021-06-25 19:53:58 +02:00
These extensions are provided in all builds and can be enabled. Currently offered
extensions are
- [International](international.md): Adds international keycodes
- [LED](led.md): Adds backlight support. This is for monocolor backlight, not RGB
- [LockStatus](lock_status.md): Exposes host-side locks like caps or num lock.
- [MediaKeys](media_keys.md): Adds support for media keys such as volume
- [RGB](rgb.md): RGB lighting for underglow. Will work on most matrix RGB as will
2022-04-29 20:21:16 +02:00
be treated the same as underglow.
2022-02-24 06:56:33 +01:00
- [Status LED](extension_statusled.md): Indicates which layer you are on with an array of single leds.
2022-05-05 08:55:37 +02:00
- [Stringy Keymaps](extension_stringy_keymaps): Enables referring to keys by `'NAME'` rather than `KC.NAME`