https://github.com/centuryglass/KeyChord

A chorded keyboard for the ClockworkPi Gameshell
https://github.com/centuryglass/KeyChord

Last synced: 16 days ago
JSON representation

A chorded keyboard for the ClockworkPi Gameshell

• Host: GitHub
• URL: https://github.com/centuryglass/KeyChord
• Owner: centuryglass
• Created: 2019-06-06T19:03:31.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-10-15T17:58:34.000Z (about 5 years ago)
• Last Synced: 2024-07-31T07:16:09.373Z (4 months ago)
• Language: C++
• Size: 878 KB
• Stars: 11
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# KeyChord

A chorded software keyboard for the ClockworkPi GameShell and similar devices. It allows quick and easy typing using the GameShell's light keys and face buttons. Controls can be easily reconfigured to work with alternate key bindings.

![Keyboard Preview](./docs/screenshots/typing.png?raw=true "typing with KeyChord")

[Installation instructions](./docs/BuildAndInstall)

## How it Works

After installation, use a program like XBindKeys to setup a shortcut key to launch KeyChord (The installation instructions explain one way to do this). Whenever you need to enter text into a window, use the shortcut key to launch KeyChord, and it will automatically target whatever window was last active. All text entered into KeyChord will be forwarded to that window, either when you press the "send text" key, or immediately, if you use the "immediate input" key to turn on immediate input mode.

With a chorded keyboard, rather than mapping each key to a different character, you have a small number of chord keys you use to type all characters. Each character uses a different combination of chord keys, and you type that character by holding down its chord key combination and releasing them all at once.

The KeyChord keyboard displays all the chord mappings on screen. As you hold down chord keys, it marks which character would be entered if you released the keys, and highlights the characters that you could select by holding down additional keys. Other button mappings handle switching between character sets, moving the keyboard window, and sending input from the keyboard to the target window.

| ![Default controls](./docs/screenshots/controls.png?raw=true "default controls") |

| :---: |

| Default keyboard controls. |

KeyChord is highly configurable. Some supported customizations:

| [![Custom controls](./docs/screenshots/altControls.png?raw=true "alternate control example")](./assets/configuration/keyBindings_alt.json)  | [![Alternate character sets](./docs/screenshots/altCharSet.png?raw=true "Danish/Norwegian alphabet example")](./assets/configuration/charSets_alt.json) | ![Custom colors](./docs/screenshots/altColors.png?raw=true "Custom color example") |

|:---:|:---:|:---:|

| Custom controls| Alternate character sets | Custom colors |