afiqzudinhadi/zmk
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions
ZMK Firmware Repository https://zmk.dev/
2843 commits 23 branches 7 tags 30 MiB
Find a file
afiqzudinhadi a36c7f26f8 feat: expose persistent effect lifecycle, wakeup, fade-delay, idle hooks 
Core API additions for full parity with darknao fork behaviors:

- ZMK_RGB_EFFECT_PERSISTENT flag: effect persists across RGB on/off
- on_idle(bool awake) callback: effect controls sleep/wake behavior
- is_active() callback: get_state returns on || effect->is_active()
- zmk_rgb_request_refresh_wakeup(bool): conditional wake from sleep
- zmk_rgb_set_tick_delay(int): delayed tick restart for fade-delay
- zmk_rgb_is_on(): exposed state query for modules
- state.layer_enabled restored: persistent effects survive RGB toggle
- auto_state delegates to on_idle for effects that implement it
- select_effect sets layer_enabled for PERSISTENT effects
- transient_off no longer calls on_deselect (only true deselect does)
2026-07-01 15:16:52 +08:00
.devcontainer docs: Devcontainers-cli enhancement (#2548) 2024-10-27 20:17:41 +01:00
.github chore(ci): Automatically bump version in user config template when releasing a new version (#3016) 2025-08-01 18:27:45 -04:00
.vscode Improve VS Code Python settings (#2860) 2025-04-20 04:34:15 -04:00
app feat: expose persistent effect lifecycle, wakeup, fade-delay, idle hooks 2026-07-01 15:16:52 +08:00
docs fix(split): Enable wired split by default if DTS is set (#3010) 2025-07-30 13:43:46 -04:00
schema feat: Add studio as a feature option in metadata 2024-10-17 10:20:30 -06:00
.clang-format feat(ci): Run clang-format to check files. 2020-09-14 00:08:13 -04:00
.gitattributes fix: check out Bash scripts with LF 2020-10-10 17:43:52 -05:00
.gitignore feat(gitignore): add clangd cache folder 2024-03-27 14:41:26 -07:00
.gitlint ci: Add gitlint and document commit conventions 2024-11-12 18:39:27 -07:00
.pre-commit-config.yaml chore(docs): Fix prettier warnings (#2952) 2025-06-01 12:02:39 -07:00
.release-please-manifest.json chore(main): release 0.3.0 (#2858) 2025-08-01 18:44:20 -04:00
AUTHORS Add KemoNine to authors per PeteJohnson 2020-12-07 07:07:45 -05:00
CHANGELOG.md chore(main): release 0.3.0 (#2858) 2025-08-01 18:44:20 -04:00
CODE_OF_CONDUCT.md refactor: Move to new zmk.dev domain name. 2021-06-10 09:27:57 -04:00
CODEOWNERS chore: Initial simple CODEOWNERS. 2021-01-13 20:59:11 -05:00
CONTRIBUTING.md feat(CONTRIBUTING.md): Add info regarding ESLint 2024-03-04 20:08:52 -08:00
LICENSE Updated copyright line. 2020-06-22 05:47:20 -04:00
README.md fix(docs): Fix README punctuation and add license link 2023-07-17 15:23:22 -07:00
release-please-config.json feat(ci): Add release-please automation with VERSION (#2622) 2024-11-18 16:46:26 -05:00

README.md

Zephyr™ Mechanical Keyboard (ZMK) Firmware

Discord Build Contributor Covenant

ZMK Firmware is an open source (MIT) keyboard firmware built on the Zephyr™ Project Real Time Operating System (RTOS). ZMK's goal is to provide a modern, wireless, and powerful firmware free of licensing issues.

Check out the website to learn more: https://zmk.dev/.

You can also come join our ZMK Discord Server.

To review features, check out the feature overview. ZMK is under active development, and new features are listed with the enhancement label in GitHub. Please feel free to add 👍 to the issue description of any requests to upvote the feature.