Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jasonrudolph/ControlEscape.spoon
⌨ Supercharge your Control key: Tap it for Escape. Hold it for Control.
https://github.com/jasonrudolph/ControlEscape.spoon
caps-lock control emacs-pinky escape hammerspoon keyboard macos touchbar
Last synced: 3 months ago
JSON representation
⌨ Supercharge your Control key: Tap it for Escape. Hold it for Control.
- Host: GitHub
- URL: https://github.com/jasonrudolph/ControlEscape.spoon
- Owner: jasonrudolph
- License: mit
- Created: 2017-06-10T12:02:59.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2021-12-04T14:02:43.000Z (almost 3 years ago)
- Last Synced: 2024-07-21T00:35:37.901Z (4 months ago)
- Topics: caps-lock, control, emacs-pinky, escape, hammerspoon, keyboard, macos, touchbar
- Language: Lua
- Homepage:
- Size: 12.7 KB
- Stars: 156
- Watchers: 11
- Forks: 20
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ControlEscape.spoon
Supercharge your control key. Tap it for escape. Hold it for control.
### A more useful control key
As Steve Losh points out in his [Modern Space Cadet](http://stevelosh.com/blog/2012/10/a-modern-space-cadet/#control-escape) post, there are "keys you hold down to change how other keys behave, but that (usually) don’t do anything if you use them on their own" (e.g., control), and there are "keys that you press and release but don’t want to 'repeat' as you hold them" (e.g., escape). "There are two [distinctly] different ways to use [these keys] and they’re each only useful in one of those ways. This means that we can *combine* them onto a single key without losing any useful functionality!"
With that in mind, we can teach the control key to pull double duty:
- If control is pressed and released in isolation, we can interpret it as escape
- If control is held down and used in combination with another key, then we can let it provide the normal control key behavior
### Goes great with Touch Bar
If you've got one of those fancy new Touch Bar Macs, you might find yourself longing for the good ol' days of a tactile escape key. Look no further. 😅
### Optional: A more useful caps lock key
What's more useful than a "more useful control key?" A more useful *and more-easily reachable* control key, of course. By repurposing the anachronistic caps lock key, we can skip the acrobatics needed to reach the physical control key. We can use caps lock to give us control and escape right on the home row.
Say goodbye to [Emacs pinky](http://wiki.c2.com/?EmacsPinky). 👋
## Dependencies
This functionality is developed and tested with the following dependencies:
- macOS Sierra 10.12
- [Hammerspoon 0.9.54][hammerspoon]
## Installation
#### Just the basics
```sh
mkdir -p ~/.hammerspoon/Spoons
git clone https://github.com/jasonrudolph/ControlEscape.spoon.git ~/.hammerspoon/Spoons/ControlEscape.spoon
cd ~/.hammerspoon/Spoons/ControlEscape.spoon
script/setup
```
#### Optional: You're just a few seconds away from a [more useful caps lock key](#optional-a-more-useful-caps-lock-key)
With one more bit of setup, you'll be able to hold caps lock for control, and tap caps lock for escape:
Open *System Preferences*, navigate to *Keyboard > Modifier Keys*, and set the caps lock key to control. [[screenshot]](https://user-images.githubusercontent.com/2988/27111039-7f620442-507b-11e7-9bcf-93d46e14af13.png)
Now you're ready to rock. 🤘
## Where can I get this code as a Spoon?
If you prefer to roll your own Hammerspoon config, this code is also available as a [Spoon](https://github.com/Hammerspoon/hammerspoon/blob/0.9.54/SPOONS.md#how-do-i-install-a-spoon). Just look for `ControlEscape.spoon.zip` included with the [latest release](https://github.com/jasonrudolph/ControlEscape.spoon/releases/latest).
## Shout-outs
Shout-out to [@arbelt](https://github.com/arbelt) and [@jasoncodes](https://github.com/jasoncodes) for the original implementation of this functionality. ⚡️🍻🌟
This code is an adaptation of their work:
- https://gist.github.com/arbelt/b91e1f38a0880afb316dd5b5732759f1
- https://github.com/jasoncodes/dotfiles/blob/ac9f3ac/hammerspoon/control_escape.lua
## You might also like...
Still reading? Dude, you're pretty serious about your keyboard. :neckbeard:
Lucky for you, there's more where this came from. Check out [jasonrudolph/keyboard](https://github.com/jasonrudolph/keyboard#features) for even more fun. ⌨🤓
[hammerspoon]: http://www.hammerspoon.org