Skip to content

plasmadice/Capslock

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

CapsLock

δΈ­ζ–‡ζ–‡ζ‘£ | EN DOCS | Karabiner Gallery | Github Repo | Import URL

Visits Badge


CapsLock Enhancement Mac v3

Transform β‡ͺCapsLock into a powerful modifier ✱ Hyper that miraculously increases your work productivity!

control-plane-0

Control Plane 0 Layout (There are 15 more!)


Highlights

  • Powerful: Transform Capslock into a great modifier: Hyper(✱). (such as β‡§βŒƒβŒ₯⌘)
  • Useful: Navigation, mousekey, clipboard, win/term ctrl, shortcuts, etc... Redefine the keyboard!
  • Speed-Up: Optimized for developers, high-frequency move stay in hot zone.
  • Extensible: Work with existing modifiers, which introduce 16 extra control planes.
  • MouseKey: Manipulate mouse cursor and wheels with keyboard
  • Cross-Platform: MacOS and Windows. Light-Weight and portable


Features

  • Basic : Press β‡ͺ Capslock emit an βŽ‹ Escape. Hold it enabling the ✱ Hyper Modifier.
  • Navigation : Vim style navigation. Cursor move, text selection, switch desktop/window/tab, mouse move/wheel,etc...
  • Deletion : Maps BNM, to deletion operation to perform fast char/word/line deletion without hand move.
  • MouseKey : Maps keypad to fully functional mouse
  • Window : Close app/win/tab, Switch app/win/tab/desktop, integration with win-manager app such as Moom,Slate,Magnet
  • Application : Shortcuts for launching or switching frequently used applications
  • Terminal : Sending high-freq signals (Ctrl-Z, Ctrl-D, Ctrl-C) and vim/tmux prefix meta key via ✱
  • Clipboard : Turn numkeys into 10 different text clipboard. ✱⌘n copy and ✱n paste.
  • Shifter : Turn some keys into common code symbols.
  • Functional : Screenshtots. Fine-grained light/volume control. Take function keys' function back!


Install

It only takes two steps to enable Capslock on your Mac: Download & Enable

  1. Download

    Download & Install Karabiner-Elements.

    Following the wizard and grant required permissions (Settings - Security - Privacy)

  2. Enable

    Open this link with Safari. It will launch Karabiner-Elements and load configuration.

    karabiner://karabiner/assets/complex_modifications/import?url=https://raw.githubusercontent.com/Vonng/Capslock/master/mac_v3/capslock.json

    Alternative Links

    Click Enable All for Capslock Enhancement on pop-up dialog. It will affect immediately.

    You can now try moving cursor with β‡ͺ + h,j,k,l , And exploring more features below.


Usage

Capslock works on ANSI keyboards and similar layouts. It literally remaps every keys on the keyboard. Including 10 categories.

Control Planes are defined by combination of four extra left modifiers: ⌘βŒ₯βŒƒβ‡§.This image shows the layout of control plane 0.

Category Color Description
Basic Blue Press β‡ͺ Capslock emit an βŽ‹ Escape. Hold it enabling the ✱ Hyper Modifier.
Navigation Pink Vim style navigation. Cursor move, text selection, switch desktop/window/tab, mouse move/wheel,etc...
Deletion Brown Maps BNM, to deletion operation to perform fast char/word/line deletion without hand move.
MouseKey Keypad Maps keypad to fully functional mouse
Window Azure Close app/win/tab, Switch app/win/tab/desktop, intergration with win-manager app such as Moom,Slate,Magnet
Application Yellow Shortcuts for launching or switching frequently used applications
Terminal Green Sending high-freq signals (Ctrl-Z, Ctrl-D, Ctrl-C) and vim/tmux prefix meta key via ✱
Clipboard Purple Turn numkeys into 10 different text clipboard. ✱⌘n copy and ✱n paste.
Shifter Orange Turn some keys into common code symbols.
Functional Cyan Screenshtots. Fine-grained light/volume control. Take function keys' function back!

Basic

Key MapsTo Comment
β‡ͺ Press βŽ‹ Escape Click Capslock to emit Escape
β‡ͺ Hold ✱ Hyper Hold Capslock to enable Hyper modifier.
βœ±βŽ‹ β‡ͺ Capslock Press to switch Capslock status
✱␣ βŒƒβ£ Switch input source, +⌘ to emoji

Note that ✱ is implemented as combination of ALL RIGHT MODIFIERS: ⌘βŒ₯βŒƒβ‡§.

Hold ✱ Hyper to enable hyper functionalities. We will assume and omit that in subsequent document.

Navigation

  • H, J, K, L, U, I, O, P are used as Navigators. Maps to β†β†“β†‘β†’β‡žβ†–β†˜β‡Ÿ by default. (pink area).
  • 9 control planes has already been allocated for navigators.
  • Hold additional ⌘ Command for selection. (like holding ⇧shift in normal), additional βŒ₯ Option for word/para selection.
  • Hold additional ⇧ Shift for app/win/tab switching. Hold additional βŒƒ Control for desktop management .
  • Hold additional βŒ₯ Option for πŸ–±οΈ mouse move. Add ⇧shift to ⏫ accelerate. (U, I, O, P maps to mouse buttons) .
  • ⇧βŒ₯ turns navigator to πŸ–²οΈ mouse wheel, and β‡§βŒ˜ is the ⏫ accelerated version . HJKL for wheel, wihle UIOP for reversed wheel move.
Feature Move Select WordSel Window Desktop πŸ–±οΈ πŸ–±οΈβ« πŸ–²οΈ πŸ–²οΈβ«
Key\Mod ✱ ⌘ ⌘βŒ₯ ⇧ βŒƒ βŒ₯ ⇧βŒ₯ β‡§βŒƒ β‡§βŒ˜
H Left word left word left prev tab prev desk ⬅️ ⬅️⏫ ⬅️ ⬅️⏫
J Down line down 3 line down next app focus ⬇️ ⬇️⏫ ⬇️ ⬇️⏫
K Up line up 3 line up prev app expose all ⬆️ ⬆️⏫ ⬆️ ⬆️⏫
L Right word right word right next tab next desk ➑️ ➑️⏫ ➑️ ➑️⏫
U PgUp prev page prev page zoom- fullscreen πŸ–±οΈL πŸ–±οΈL ➑️ ➑️⏫
I Home line head end2head prev win hide πŸ–±οΈR πŸ–±οΈR ⬆️ ⬆️⏫
O End line end head2end next win hide all πŸ–±οΈB πŸ–±οΈB ⬇️ ⬇️⏫
P PgDn next page next page zoom+ Launchpad πŸ–±οΈF πŸ–±οΈF ⬅️ ⬅️⏫

Arrow Navigation

  • Arrows ←↓↑→ to πŸ–±οΈ mouse actions too. Hold βŒ₯ Option to ⏬ slow down, hold ⌘ Command to ⏫ speed up.
  • Hold ⇧ Shift turns to πŸ–²οΈ wheel move. Extra βŒ₯ Option to ⏬ slow down, extra ⌘ Command to ⏫ speed up.
  • ↩ Return maps to left click. And additional ⌘βŒ₯βŒƒβ‡§ turns into right click, middle click, backward, forward.
Feature πŸ–±οΈ πŸ–±οΈβ¬ πŸ–±οΈβ« πŸ–²οΈ πŸ–²οΈβ¬ πŸ–²οΈβ«
Key\Mod ✱ βŒ₯ ⌘ ⇧ ⇧βŒ₯ β‡§βŒ˜
←↓↑→ speed = 1600 speed Γ· 2 speed Γ— 2 speed = 32 speed Γ· 2 speed Γ— 2
↩ πŸ–±οΈL πŸ–±οΈM πŸ–±οΈR πŸ–±οΈL πŸ–±οΈB πŸ–±οΈF

Deletion

N M , . are used as Deletor keys. Right below the navigators for fast access (brown area).

Key\Mod ✱ ⌘ βŒ₯
N del a word ahead del till line head del the whole line
M del a char ahead del a word ahead move line below
, del a char after del a word after move line above
. del a word after del till line end del the whole line
⌫ del file purge file

MouseKey

  • Turn Keypad into a fully funcional πŸ–±οΈ mouse.
  • Numbers maps to 8 direction πŸ–±οΈ mouse move. Hold βŒ₯ Option to ⏬ slow down, hold ⌘ Command to ⏫ speed up.
  • Hold additional ⇧ Shift turns to πŸ–²οΈ wheel move. Extra βŒ₯ Option to ⏬ slow down, and extra ⌘ Command to ⏫ speed up.
  • First line maps to wheel move and 0, ., ⌀, +, - maps to five mouse buttons.
β‡­ πŸ–²οΈβ¬…οΈ = πŸ–²οΈβ¬‡οΈ / πŸ–²οΈβ¬†οΈ * πŸ–²οΈβž‘οΈ
7πŸ–±οΈ ↖️ 8 πŸ–±οΈβ¬†οΈ 9 πŸ–±οΈβ†—οΈ - πŸ–±οΈB
4πŸ–±οΈ ⬅️ 5πŸ–±οΈ 6 πŸ–±οΈβž‘οΈ + πŸ–±οΈF
1πŸ–±οΈβ†™οΈ 2 πŸ–±οΈβ¬‡οΈ 3 πŸ–±οΈβ†˜οΈ
0 πŸ–±οΈL . πŸ–±οΈM ⌀ πŸ–±οΈR

Window Control

  • Tab, Q, W, A, s used as window control keys. Focuing on close/switch applications / windows / tabs / desktops. (azure area)
  • Windows management (resize, layout) leaves to external application such as Moom, Magnet, and Slate. Bind βŒƒβŒ₯β‡§βŒ˜A manually.
Key\Mod ✱ ⌘ βŒ₯ βŒƒ ⇧
β‡₯ next app prev app switch desktop switch tab
Q close app close app Lock Screen Logout
W close tab close all win Display Sleep Sleep
A win app expose all show desktop LaunchPad
S next tab prev tab next win prev win

App Shortcuts

  • E R T Y F G are used as application shortcuts. (yellow area)
  • Popular apps and dev tools are registed to 3 default planes: ✱/⌘/βŒ₯. Assign these shortcuts according to your own needs.
Key\Mod ✱ ⌘ βŒ₯
E Safari Finder Mail
R iTerm2 Preview Terminal
T Visual Studio Code Typora Note
Y Siri Karabiner Amphetamine
F Alfred 4 Dash Dictionary
G Intellij IDEA Chrome Calender

Terminal Control

D, Z, X, C, V, B are used as terminal control keys. Sending singals and IDE commands. (green area)

Key\Mod ✱ ⌘
D βŒƒD Ctrl+D (Send EOF) Define (Force touch)
Z βŒƒZ Ctrl+Z (SIGTSTP) F5 (VS Code Debug)
X βŒƒR Ctrl+R (IDE Run) βŒƒF5 (VS Code Run)
C βŒƒC Ctrl+C (SIGINT) ⇧>F5(VS Code StopοΌ‰
V βŒƒVCtrl+V (Vim Prefix)
B βŒƒBCtrl+B (Tmux Prefix)

Clipboard

Number keys 1, 2, …, 9, 0 are used as (text) clipboard. Hold ⌘ to copy, and press to paste. (purple area)

Key\Mod ✱ ⌘
1 Paste from clip 1 Copy to clip 1
2 Paste from clip 2 Copy to clip 2
…… …… ……
0 Paste from clip 0 Copy to clip 10

Shifter

  • Trivial transformation for misc characters. (orange area)
  • Some special tricks for developers. Such as ;' maps to := or != (⌘)
Key\Mod ✱ ⌘ βŒ₯
- _ Zoom Out
= + Zoom In
[ ( { <
] ) } >
; ! :
' = =
/ ⌘/
\ ⌘/

Functional

  • Use F1,…F12 as standard functional keys, while hold ✱ Hyper to turn them back. (cyan area)

  • ⌘Command + F1 / F2 / F3 are used as desktop switcher. Enable shortcuts in system preference first:

    Preference β†’ Keyboard β†’ Shortcuts β†’ MissionControl β†’ Switch to Desktop 1/2/3

  • If you are using RMBP with Bar, consider changing your bar back to function keys with:

    Karabiner-Elements β†’ Function Keys β†’ Use all F1, F2, etc. keys as standard function keys

Key\Mod ✱ ⌘ Comment
` βŒƒβ‡§βŒ˜4 β‡§βŒ˜4 Area selection screenshot(⌘ to file)
F1 display_brightness_decrement | βŒƒ1 βŒƒ1 Brightness Down / Desktop 1
F2 display_brightness_increment | βŒƒ2 βŒƒ2 Brightness Up / Desktop 2
F3 βŒƒβ†‘ | βŒƒ3 βŒƒ3 Expose All / Desktop 3
F4 Launchpad Launchpad
F5 illumination_decrement Keyboard Light Down
F6 illumination_increment Keyboard Light Up
F7 rewind Music Prev
F8 play_or_pause Play / Pause
F9 fastforward Music Next
F10 mute Mute
F11 volume_decrement Volume Down
F12 volume_increment Volume Up
F13 βŒƒβ‡§βŒ˜3 β‡§βŒ˜3 Full Screentshot (⌘ to file)
F14 β‡§βŒ˜5 β‡§βŒ˜6 Screenshot menu (⌘ touchbar snap)
F15 play_or_pause Play / Pause
Insert ⇧βŒ₯ display_brightness_increment Fine-Grained Brightness Up
Delete ⌦ ⇧βŒ₯ display_brightness_decrement Fine-Grained Brightness Down
Home β†– ⇧βŒ₯ illumination_increment Fine-GrainedKeyboard Light Up
End β†˜ ⇧βŒ₯ illumination_decrement Fine-Grained Keyboard Light Down
PgUp β‡ž ⇧βŒ₯ volume_increment Fine-Grained Volume Up
PgDn β‡Ÿ ⇧βŒ₯ volume_decrement Fine-Grained Volume Down

References

Symbols

Glyph Name Glyph Name
β‡ͺ Capslock ✱ Hyper
βŽ‹ Escape ␣ Space
⌘ Command (Mac) βŽ‡ Alter (Win)
βŒ₯ Option (Mac) ⊞ Win (Win)
βŒƒ Control ⇧ Shift
↩ Return ⌀ Enter
←↓↑→ Arrow Cursor β†–β†˜ Home/End
β‡₯⇀ Tab ⌫⌦ Delete / ForwardDelete
β‡­ Numlock ⏫⏬ Fast / Slow
πŸ–±οΈL Mouse Left Click (Button1) πŸ–±οΈB Mouse Backward (Button4)
πŸ–±οΈR Mouse Right Click (Button2) πŸ–±οΈF Mouse Forward (Button5)
πŸ–±οΈM Mouse Middle Click (Button3) πŸ–²οΈ Mouse Wheel

Control Planes

control planes
Plane Modifiers Plane Modifiers Plane Modifiers
0 ✱ 3 ✱⌘βŒ₯ 7 ✱⌘βŒ₯βŒƒ
1 ✱⌘ 5 βœ±βŒ˜βŒƒ 11 ✱⌘βŒ₯⇧
2 ✱βŒ₯ 6 ✱βŒ₯βŒƒ 13 βœ±βŒ˜βŒƒβ‡§
4 βœ±βŒƒ 9 βœ±βŒ˜β‡§ 14 ✱βŒ₯βŒƒβ‡§
8 βœ±β‡§ 10 ✱βŒ₯⇧ 15 ✱⌘βŒ₯βŒƒβ‡§
12 βœ±βŒƒβ‡§

Version

MacOS Supported Win Supported
MacOS Big Sur (11.0 ) Windows 10
MacOS Catalina (10.15) Windows 8
MacOS High Sierra (10.13) Windows 7
MacOS Sierra (10.12) Windows Vista
MacOS EI Capitan (10.11) Windows XP
MacOS Yosemite (10.10) or lower
(via Capslock Mac v1
(via Capslock Win)

MacOS v3 is actively maintained, available on MacOS 10.11 - 11.x. Yosemite (10.10) or lower are supported via Capslock Mac v1

Windows version is already archived. You can use pre-compiled binary or install AutoHotKey and load capslock.ahk manually


FAQ

Q: Why using ✱ as the symbol for Hyper?

A: Because the ASCII code for * is exactly 42, which is the ultimate answer to life, universe, and everything. ✱ (Heavy-Asterisk) is a pretty version of *.

Q: What's new in v3?

A: The original v2 only use 1 ~ 3 control planes. While v3 uses up to 9 control planes. A large number of functions have been added to make the additional modifier ⌘βŒ₯βŒƒβ‡§ functioning in a reasonable way.

Q: Is there any incompatible changes in V3 compare to V2 ?

A: There are three minor incompatible changes:

  • F13/F4 from music prev/next to screenshot;

  • Number keys are used as clipboard instead of shifter

  • ⌘D now perform define(force touch) instead of opening dictionary app.

Q: Why is there no Linux OS support?

A: I'm using Linux through MacOS terminal. It actually feels much better than raw Linux πŸ˜†. This feature can be achieved via xmodmap, contribution are welcome!

Q: Why is there an older version in MacOS?

A: There was an older version of Karabiner that used XML config. Apple modified it's kernel architecture in MacOS Sierra (10.12) and many programs had to be overhauled. So then there was a new version of Karabiner, the Karabiner-Elements, which is still in use today.

Q: How can I customize it to my needs?

A: Just fork this repo and make modification to mac_v3/capslock.json according to documentation You can edit the more human-readable format mac_v3/capslock.yml then compile it into capslock.json format with make compile.

Q: Is this original?

A: I'm the first one to make a capslock overhaul schema as far as I know. The original win AHK version was wrote in 2013. The first mac version was wrote in 2015. It is the first capslock emulation schema in karabiner's gallery.


Feedbacks


About

Author: Vonng (rh@vonng.com)

License: Apache 2.0 License

Beian: ζ΅™ICP倇15016890-3号

Releases

No releases published

Packages

No packages published

Languages

  • HTML 58.9%
  • AutoHotkey 39.6%
  • Makefile 1.3%
  • Shell 0.2%