afiqzudinhadi/zmk-steno-engine
1
0
Fork 0
Code Issues 3 Pull requests Projects Releases Packages Wiki Activity Actions
Clean-room ZMK steno engine with trie/DAWG dictionary
6 commits 2 branches 0 tags 181 KiB
Find a file
afiqzudinhadi 20218fa2ab True split-dict: partition dictionary across both halves 
Importance-based partitioning — highest-importance entries on left
(central) for zero-latency local lookup, remainder on right
(peripheral) queried over BLE on miss. Both halves embed their own
MPHF binary. Configurable block size for tighter compression.
2026-07-02 14:27:37 +08:00
dicts Scaffolding: ZMK module structure, Kconfig, DTS, behavior driver 2026-07-02 02:04:28 +08:00
dts Scaffolding: ZMK module structure, Kconfig, DTS, behavior driver 2026-07-02 02:04:28 +08:00
include/dt-bindings/zmk Scaffolding: ZMK module structure, Kconfig, DTS, behavior driver 2026-07-02 02:04:28 +08:00
src True split-dict: partition dictionary across both halves 2026-07-02 14:27:37 +08:00
tests Scaffolding: ZMK module structure, Kconfig, DTS, behavior driver 2026-07-02 02:04:28 +08:00
tools True split-dict: partition dictionary across both halves 2026-07-02 14:27:37 +08:00
zephyr Scaffolding: ZMK module structure, Kconfig, DTS, behavior driver 2026-07-02 02:04:28 +08:00
.gitignore Scaffolding: ZMK module structure, Kconfig, DTS, behavior driver 2026-07-02 02:04:28 +08:00
CMakeLists.txt True split-dict: partition dictionary across both halves 2026-07-02 14:27:37 +08:00
Kconfig True split-dict: partition dictionary across both halves 2026-07-02 14:27:37 +08:00
LICENSE Scaffolding: ZMK module structure, Kconfig, DTS, behavior driver 2026-07-02 02:04:28 +08:00
README.md Scaffolding: ZMK module structure, Kconfig, DTS, behavior driver 2026-07-02 02:04:28 +08:00

README.md

zmk-steno-engine

Clean-room stenography engine for ZMK Firmware. Dictionary-based lookup with multi-stroke support, optimized for nRF52840 flash constraints.

Status: Early development — basic single/multi-stroke lookup works, formatter not yet implemented.

Features

  • Standard 23-key steno layout
  • Sorted-array dictionary with binary search lookup
  • Multi-stroke support with configurable timeout
  • All-up chord detection
  • HID keyboard output (ASCII)
  • Build-time dictionary compilation from Plover JSON
  • Test dictionary included for development

Building

Add as a ZMK module in your west.yml:

manifest:
  remotes:
    - name: zmk-steno-engine
      url-base: https://github.com/afiqzudinhadi
  projects:
    - name: zmk-steno-engine
      remote: zmk-steno-engine
      revision: optimize-dict

Enable in your .conf:

CONFIG_STENO_ENGINE=y

Use in your keymap:

#include <dt-bindings/zmk/steno_keys.h>

/ {
    keymap {
        steno_layer {
            bindings = <
                &steno STENO_SL  &steno STENO_TL  &steno STENO_PL  ...
            >;
        };
    };
};

Dictionary Compiler

# Compile test dictionary
python3 tools/compile_simple.py dicts/test.json -o steno_dict.bin --stats

# Compile Plover dictionary (trimmed)
python3 tools/compile_simple.py plover-main.json -o steno_dict.bin --max-entries 120000 --stats

License

PolyForm Noncommercial 1.0.0