Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pqrs-org/KE-complex_modifications
Karabiner-Elements complex_modifications rules
https://github.com/pqrs-org/KE-complex_modifications
Last synced: 3 months ago
JSON representation
Karabiner-Elements complex_modifications rules
- Host: GitHub
- URL: https://github.com/pqrs-org/KE-complex_modifications
- Owner: pqrs-org
- License: unlicense
- Created: 2017-06-17T07:30:36.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T07:26:36.000Z (10 months ago)
- Last Synced: 2024-04-14T13:42:05.529Z (10 months ago)
- Language: JavaScript
- Homepage: https://ke-complex-modifications.pqrs.org/
- Size: 58.6 MB
- Stars: 1,247
- Watchers: 62
- Forks: 1,059
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-starred-test - pqrs-org/KE-complex_modifications - Karabiner-Elements complex_modifications rules (JavaScript)
- my-awesome-starred - pqrs-org/KE-complex_modifications - Karabiner-Elements complex_modifications rules (JavaScript)
- my-awesome - pqrs-org/KE-complex_modifications - 01 star:1.3k fork:1.1k Karabiner-Elements complex_modifications rules (JavaScript)
README
[](https://github.com/pqrs-org/KE-complex_modifications/actions)
[](https://github.com/pqrs-org/KE-complex_modifications/blob/main/LICENSE.md)
# KE-complex_modifications
complex_modifications for Karabiner-Elements.
## complex_modifications documents
- [karabiner.json Reference Manual](https://karabiner-elements.pqrs.org/docs/json/)
- [Typical complex_modifications examples](https://karabiner-elements.pqrs.org/docs/json/typical-complex-modifications-examples/)
- [complex_modifications manipulator definition](https://karabiner-elements.pqrs.org/docs/json/complex-modifications-manipulator-definition/)
## How to add your rules
Follow the steps below to create a PR and add your settings!
1. Fork this repository on GitHub.
2. Clone the repository in Terminal.
```shell
git clone --depth 1 https://github.com/{your_account}/KE-complex_modifications.git
cd KE-complex_modifications
git submodule update --init --recursive --depth 1
```
3. Create a git branch in Terminal.
```shell
git switch -c my-settings
```
4. Put a JSON generator file (`.js`) into [src/json](https://github.com/pqrs-org/KE-complex_modifications/tree/main/src/json).
(Or put a `.json` file directly into [public/json](https://github.com/pqrs-org/KE-complex_modifications/tree/main/public/json) directory.)
5.
(Optional) Update public/groups.json if you want to add your rules to a particular category.
Add the following entry into [public/groups.json](public/groups.json).
```json5
{
"path": "json/your_awesome_configuration.json", // required
"extra_description_path": "extra_descriptions/your_awesome_configuration.html" // optional
},
```
You can use the tag `⇧Shift` to make a nice ⇧Shift in your html.
6. Run `make` command in Terminal to validate your files.
If you placed a generator file into `src/json`, json file will be generated in the `public/json` by this command.
```shell
make all
```
If there is a problem, an error message is displayed. Fix your files until no errors are shown.
```text
"../public/json/personal_tekezo.json": `Personal rules (@tekezo) (rev 47)` error: `to` entry error: `key_code` error: unknown key_code: `"space"`
make[1]: *** [all] Error 1
make: *** [all] Error 2
```
7. Test your files
Copy a json file to `~/.config/karabiner/assets/complex_modifications`.
```shell
cp public/json/your_awesome_configuration.json ~/.config/karabiner/assets/complex_modifications
```
Import rules from `Karabiner-Elements Settings > Complex Modifications > Rules > Add rule`.
8.
(Optional) Test your files on local web server.
Run local web server by the following command in Terminal.
```shell
make preview-server
```
Then open .
9. Run `git commit` and `git push` in Terminal.
```shell
git add -A
git commit -m 'your commit message'
git push --set-upstream origin my-settings
```
10. Create a PR on GitHub.
## Sync your fork
To update your previously forked repositories, run the following command in Terminal.
### Run only once
```shell
git remote add upstream https://github.com/pqrs-org/KE-complex_modifications.git
```
### Run every time
```shell
# switch to main branch
git switch main
# fetch upstream
git fetch --all --prune --prune-tags
# update local repository
git reset --hard upstream/main
# update submodules
git submodule update --init --recursive
# clean files
git clean -x -d -f .
# update GitHub repository
git push
```
## Notes on creating your generators
The code in `src/json/*.js` is executed by [Duktape](https://duktape.org/), which is built into the Karabiner-Elements's command line interface ( `karabiner_cli`).
Unlike the latest Node.js, the basic language specification is ES5.1, so the following features cannot be used.
- `let` (`const` is specially supported)
- Arrow functions
- Default parameters
- Spread (...) syntax
- Template literals
### Examples
There are many existing codes. Here are some of the more distinctive ones among them.
- Use the predefined list of bundle identifiers in `frontmost_application_if`.
- [capslock_shift_copy_paste.json.js](https://github.com/pqrs-org/KE-complex_modifications/blob/main/src/json/capslock_shift_copy_paste.json.js)
- Generate remappings from a list of characters
- [colemak_layout.json.js](https://github.com/pqrs-org/KE-complex_modifications/blob/main/src/json/colemak_layout.json.js)
- Include file from another file
- [personal_thooams.json.js](https://github.com/pqrs-org/KE-complex_modifications/blob/main/src/json/personal_thooams.json.js)
- [control_backspace_to_function_backspace.json.js](https://github.com/pqrs-org/KE-complex_modifications/blob/main/src/json/control_backspace_to_function_backspace.json.js)
- Generate rules from key combinations
- [matias_ergo_pro.json.js](https://github.com/pqrs-org/KE-complex_modifications/blob/main/src/json/matias_ergo_pro.json.js)