jtroo/kanata
Kanata
Kanata is a cross-platform keymap engine and keyboard firmware emulator that intercepts physical keystrokes to output modified signals on Windows, Linux, and macOS. It serves as a keyboard remapper and layer manager, allowing users to define custom key-map sequences and modal editing behaviors through a declarative configuration file.
The system implements keyboard firmware features in software, enabling advanced behaviors such as tap-hold logic, unicode output, and dynamic macros. It utilizes a state-based layer stack to manage multiple sets of key assignments that toggle dynamically and supports leader sequences to enable modal keyboard workflows.
The tool includes a mechanism for live configuration reloading to apply keymap changes without restarting the service. It also provides a network interface via a TCP server for remotely monitoring or triggering layer changes and a utility for recording key sequences to facilitate automated testing.
Features
- Keyboard Key Mappings - Associates physical keyboard keys with emulated hardware functions across multiple operating systems.
- Keyboard and Input Utilities - Provides a comprehensive toolset for remapping keys and managing functional keyboard layers.
- Input Remapping - Provides the ability to substitute and remap physical input keys across different operating systems.
- Dynamic Layering - Defines multiple sets of key assignments that toggle dynamically to change keyboard behavior.
- Software-Based Emulation - Implements keyboard firmware features in software to enable complex key-mapping logic on standard operating systems.
- Advanced Input Automation - Implements complex key behaviors including tap-hold functionality, unicode output, and dynamic macros.
- Advanced Input Behaviors - Supports assigning complex actions to keys, including tap-hold functionality, unicode output, and dynamic macros.
- Input Event Interception - Intercepts raw keyboard hardware events at the system level before they are processed by the operating system.
- Input Configuration Frameworks - Provides a system for defining custom key-map sequences and modal editing behaviors through a declarative configuration file.
- Input Layer Stacks - Manages a stack of active keymaps where the top layer overrides lower layers for dynamic input mapping.
- Input Processing Engines - Acts as a low-level input processor that intercepts physical keystrokes to output modified signals across Windows, Linux, and macOS.
- Configuration Hot-Reloaders - Implements a mechanism to monitor configuration files and update keymap state in real-time without a restart.
- Hold Duration Triggers - Uses a precise clock to distinguish between short presses and long holds to trigger different output actions.
- Leader Key Sequences - Supports leader key sequences that arm subsequent temporary key bindings for complex macro execution.
- Live Configuration Reloading - Allows active keyboard mappings to be updated at runtime without requiring a process restart.
- Modal Editing Systems - Implements an input scheme using distinct modes and leader sequences for navigation and text manipulation.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
