Skip to content

Commit 52a5959

Browse files
committed
add Karabiner configuration for macOS
1 parent 4e9d608 commit 52a5959

File tree

2 files changed

+449
-4
lines changed

2 files changed

+449
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Hotkeys
22

3-
This is an AutoHotkey script for some hotkeys I frequently use, in order to achieve a universal experience across different platforms.
3+
This repo contains the configurations for some hotkeys I frequently use, in order to achieve a universal experience across different platforms.
44

5-
This script uses the <kbd>Right Ctrl</kbd> key as the main modifier key. You can map <kbd>Caps Lock</kbd> to <kbd> Right Ctrl</kbd> for better experience with tools like [SharpKeys](https://github.com/randyrants/sharpkeys).
5+
These hotkeys use the <kbd>Right Ctrl</kbd> key as the main modifier key. You can map <kbd>Caps Lock</kbd> to <kbd>Right Ctrl</kbd> for better experience with tools like [SharpKeys](https://github.com/randyrants/sharpkeys) on Windows and [Karabiner Elements](https://pqrs.org/osx/karabiner/index.html) on macOS.
66

7-
Below is a list of hotkeys defined in this script.
7+
Below is a list of hotkeys defined in this script. Note that <kbd>Ctrl</kbd> is same to <kbd>control</kbd> in macOS, and <kbd>Alt</kbd> is same to <kbd>option</kbd>. The hotkeys modified with <kbd>Alt</kbd> are not implemented in the Karabiner JSON file.
88

99
## Hotkeys List
1010

@@ -36,7 +36,15 @@ Hotkey | Maps to | Description
3636

3737
## Usage
3838

39-
Download or clone this repo and run the script `hotkeys.ahk` with [AutoHotkey](https://www.autohotkey.com/) if you have it installed. Otherwise find a prebuilt binary from the [releases](https://github.com/beta/hotkeys/releases) page.
39+
Download or clone this repo first.
40+
41+
- For Windows, install [AutoHotkey](https://www.autohotkey.com/) and run `hotkeys.ahk` to apply the hotkeys. You can also find a prebuilt binary from the [releases](https://github.com/beta/hotkeys/releases) page.
42+
43+
- For macOS, install [Karabiner Elements](https://pqrs.org/osx/karabiner/index.html) and add the rules from `hotkeys.json`. Open the following URL in browser to add the rules directly.
44+
45+
```
46+
karabiner://karabiner/assets/complex_modifications/import?url=https%3A%2F%2Fraw.githubusercontent.com%2Fbeta%2Fhotkeys%2Fmaster%2Fhotkeys.json
47+
```
4048

4149
## License
4250

0 commit comments

Comments
 (0)