https://github.com/unclechu/hakey
Software-level advanced keyboard customization tool
https://github.com/unclechu/hakey
dhall evdev haskell keyboard keyboard-emulation keyboard-layout linux
Last synced: 7 months ago
JSON representation
Software-level advanced keyboard customization tool
- Host: GitHub
- URL: https://github.com/unclechu/hakey
- Owner: unclechu
- License: agpl-3.0
- Created: 2019-12-28T17:56:53.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-01-01T03:49:09.000Z (about 6 years ago)
- Last Synced: 2025-05-18T15:44:39.670Z (8 months ago)
- Topics: dhall, evdev, haskell, keyboard, keyboard-emulation, keyboard-layout, linux
- Size: 66.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HaKey
Software-level advanced keyboard customization tool.
---
**WARNING!** This project is in very early development stage!
Mostly documenting stuff…
**HaKey** is **Ha**skell + **Key**board.
The round key cap on the logo is an allusion to a hockey puck,
just because _“HaKey”_ and _“hockey”_ seem to sound similar.
This program (or a set of programs) is a continuation of
[my another project][xlib-keys-hack].
## Goals & Motivation
The general goal is to fix some issues of [xlib-keys-hack] project and to add
new features. [xlib-keys-hack] is very tied to my own requirements and in some
parts not flexible enough so I want this tool to satisfy almost everyone else’s
needs.
The goals are (to make it to be…):
- Relatively easy to use for almost any advanced user
- Very flexible and configurable
- Robust and stable
The motivation is to satisfy my own needs and requirements in a customizable
generic way so this would be useful not only for me (as [xlib-keys-hack] project
seems to be) but for everyone else.
## Features
These features this tool is supposed to provide for everyone:
- [ ] Input
- [ ] GNU/Linux & FreeBSD [evdev] devices
- [ ] Automated disabling input devices for [X Window System][X11]
(those which attached to [evdev] devices we’re reading raw
events from)
- [ ] Automated enabling back those input [X11] devices which have
been occupied by **HaKey** after its termination
- [ ] Output
- [ ] [X11] [XTEST]
- [ ] [Wayland] libinput? (I don’t know how to deal with [Wayland] yet)
- [ ] Input layer configurable layout
- [ ] Customizable mapping between raw [evdev] key numbers to virtual
source keys (like `16` is a `Q` key)
- [ ] Independent input layer mappings for different keyboards/[evdev]
devices
- [ ] Output configurable layout
- [ ] Mapping between source keys and [X11] keys (for [XTEST] output)
- [ ] Mapping between source keys and [Wayland] keys (for [Wayland]
output)
- [ ] Independent output mappings for different keyboards/[evdev]
devices
- [ ] Switchable layers (switchable by modifiers, togglers, whatever, in
[xlib-keys-hack] you can see two additional layers of so called
_alternative mode_), any amount of layers you want or just a single main
one
- [ ] Shifted modifiers (being able to type `!` for instance by pressing a
single key, the tool would automatically trigger `Shift`+`1`)
- [ ] Basic predefined output layouts
- [ ] [QWERTY]
- [ ] [Dvorak]
- [ ] [Programmer Dvorak]
- [ ] Layer switch modes
- [ ] Toggle: key shared between to layers, toggle from one to another
- [ ] Switch: when you press a key layer switches to another layer
- [ ] Hold: layer is on as long as you hold a modifier key
- [ ] Tap toggle: you either hold a key for temporary switch or tap it to
switch to that layer permanently
- [ ] Hold/Tap: independently configure tap and hold behavior
- [ ] Single: trigger a key from another layer only once after you tap a layer
switch key and than go back to layer you switched from
- [ ] First * (first toggle, first hold, first etc.):
It it's a first key pressed after all keys being released then it do a
layer switch action, if it's pressed after some other modifier being
held it could trigger another key (consider holding alt key first for
temporarily switching to alternative mode in [xlib-keys-hack] otherwise
it triggers regular alt key)
- [ ] Combo/tap key mode, probably _"Layer switch modes"_ can be generalized for
this too, like to trigger Ctrl when you press Caps Lock with some another
key (when you press a key while holding Caps Lock) but when you tap Caps
Lock it may trigger Escape key or even original Caps Lock but until this
resolves to either combo or tap it triggers nothing, and when it resolves
to tap it immediately triggers _press_ and _release_ events sequently
- [ ] Writing and playing macroses
- [ ] Play with intervals as you really typed
- [ ] Play with fixed interval
- [ ] Play without intervals (as fast as possible)
- [ ] Store state of some modes
- [ ] Store _Num Lock_ state
- [ ] Store _Caps Lock_ state
- [ ] Store _Scroll Lock_ state
- [ ] Store _[XKB]_ layout state
- [ ] Reset modes to _default state_
- [ ] Reset _Num Lock_ state
- [ ] Reset _Caps Lock_ state
- [ ] Reset _Scroll Lock_ state
- [ ] Reset _[XKB]_ layout state
- [ ] DBus IPC
- [ ] Notify other clients about some modes
- [ ] _Num Lock_ state
- [ ] _Caps Lock_ state
- [ ] _Scroll Lock_ state
- [ ] _[XKB]_ layout state
- [ ] Reset modes (incoming API)
- [ ] Switch output layout layer to specific one (incoming API)
- [ ] Switch some modes to specific state (incoming API)
- [ ] _Num Lock_
- [ ] _Caps Lock_
- [ ] _Scroll Lock_
- [ ] _[XKB]_ layout
- [ ] Send and receive events over network
- [ ] Support encryption to prevent key-logger attacks
- [ ] Warn user about unencrypted connection
- [ ] Hot connect/reconnect interface
- [ ] Deliver raw [evdev] events (map on receiver side)
- [ ] Deliver premapped keys (map on sender side)
- [ ] Safe hot plug/unplug of devices
- [ ] Automatically (re)connect to just plugged in device
- [ ] Web-interface for configuring layouts and other parameters
- [ ] Optional export of your **HaKey** config as a [QMK] firmware setup
(to apply that config on hardware/firmware level, at least what's
possible, like layout with layers and modifiers/togglers)
- [ ] Test on ErgoDox EZ
**WARNING!** This list is incomplete yet,
there will be more features described here!
[evdev]: https://en.wikipedia.org/wiki/Evdev
[X11]: https://en.wikipedia.org/wiki/X_Window_System
[XTEST]: https://www.x.org/releases/X11R7.7/doc/libXtst/xtestlib.html
[XKB]: https://en.wikipedia.org/wiki/X_keyboard_extension
[Wayland]: https://en.wikipedia.org/wiki/Wayland_(display_server_protocol)
[QWERTY]: https://en.wikipedia.org/wiki/QWERTY
[Dvorak]: https://en.wikipedia.org/wiki/Dvorak_keyboard_layout
[Programmer Dvorak]: https://en.wikipedia.org/wiki/Dvorak_keyboard_layout#Programmer_Dvorak
[QMK]: https://github.com/qmk/qmk_firmware
## Author
Viacheslav Lotsmanov
### Creator of the logo
Viacheslav Lotsmanov
## License
### License for the code
[GNU AGPLv3](LICENSE)
GNU Affero General Public License
Version 3, 19 November 2007
#### Why this one
Using **AGPLv3** instead of just **GPLv3** because this tool may have web
interface for configuring keyboard layout in the future.
### License for the logo
[CC BY-SA 4.0]
Creative Commons — Attribution-ShareAlike 4.0 International
[CC BY-SA 4.0]: https://creativecommons.org/licenses/by-sa/4.0/
[xlib-keys-hack]: https://github.com/unclechu/xlib-keys-hack