ZMK Firmware Repository
Go to file
Grigory Pavlichenko 769d6121d2 feat(behaviors): add universal snap tap behavior for gaming SOCD
Implements SOCD (Simultaneous Opposing Cardinal Directions) functionality
that provides competitive gaming advantages through "last key wins" behavior
for opposing directional keys.

Features:
- Universal syntax: &st <key> <opposing_key> works with any key pair
- Dynamic state management supports up to 16 key pairs simultaneously
- Memory efficient: only stores state for active pairs
- Gaming optimized: perfect for FPS strafing, platformer movement, MOBA control
- Zero performance impact when behavior is not used

Usage example:
&st A D    // A key with D as opposing key
&st W S    // W key with S as opposing key

The behavior solves the problem where pressing opposing keys (like A+D)
causes character to stop moving by automatically releasing the previous
key when its opposing key is pressed, enabling instant direction changes
without dead zones
2025-06-16 14:20:19 +03:00
.devcontainer docs: Devcontainers-cli enhancement (#2548) 2024-10-27 20:17:41 +01:00
.github fix(ci): pin tj-actions/changed-files due to compromise (#2874) 2025-03-15 02:25:01 -04:00
.vscode Improve VS Code Python settings (#2860) 2025-04-20 04:34:15 -04:00
app feat(behaviors): add universal snap tap behavior for gaming SOCD 2025-06-16 14:20:19 +03:00
docs feat(split): Runtime selection of split transport (#2886) 2025-06-16 03:45:25 -04:00
schema feat: Add `studio` as a feature option in metadata 2024-10-17 10:20:30 -06:00
.clang-format
.gitattributes
.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.2.1 (#2851) 2025-03-02 07:45:12 -07:00
AUTHORS
CHANGELOG.md chore(main): release 0.2.1 (#2851) 2025-03-02 07:45:12 -07:00
CODEOWNERS chore: Initial simple CODEOWNERS. 2021-01-13 20:59:11 -05:00
CODE_OF_CONDUCT.md refactor: Move to new zmk.dev domain name. 2021-06-10 09:27:57 -04:00
CONTRIBUTING.md feat(CONTRIBUTING.md): Add info regarding ESLint 2024-03-04 20:08:52 -08:00
LICENSE
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.