Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds layer implementations to examples.md #804

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions readme/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,3 +177,41 @@ xmodmap keyboard_layout

again for the injection to use that xmodmap as well. It should be possible
to write "ヤ" now when pressing the key.

## Implementing Layers

We can implement layer functionality (similar to QMK) using the `set` and `if_eq` macros.

- `A`: `set(foo, 0)`
- `B`: `set(foo, 1)`
- `X`: `if_eq(foo, 1, hold_keys(Y), hold_keys(X))`
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `X`: `if_eq(foo, 1, hold_keys(Y), hold_keys(X))`
- `X`: `if_eq($foo, 1, hold_keys(Y), hold_keys(X))`


Pressing `A` sets `$foo=0`, pressing `B` sets `$foo=1`. `X` is `Y` if `$foo=1`, otherwise `X` is `X`. Pressing `A` > `X` > `B` > `X` will output `XY`.



We can implement a single macro to toggle back and forth betwixt layers.

- `A`:`if_eq(foo, 1, set(foo, 0), set(foo, 1))`
- `X`:`if_eq(foo, 1, hold_keys(Y), hold_keys(X))`
Comment on lines +195 to +196
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `A`:`if_eq(foo, 1, set(foo, 0), set(foo, 1))`
- `X`:`if_eq(foo, 1, hold_keys(Y), hold_keys(X))`
- `A`:`if_eq($foo, 1, set(foo, 0), set(foo, 1))`
- `X`:`if_eq($foo, 1, hold_keys(Y), hold_keys(X))`


Pressing `A` toggles between `$foo=0` and `$foo=1`. So pressing `X` > `A` > `X` will output `XY` (or `YX` if you start from `$foo=1`).


We can create layer-shift macros that will enable the layer only while being held.

- `A`:`set(foo, 1).hold().set(foo, 0)`
- `X`:`if_eq(foo, 1, hold_keys(Y), hold_keys(X))`
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `X`:`if_eq(foo, 1, hold_keys(Y), hold_keys(X))`
- `X`:`if_eq($foo, 1, hold_keys(Y), hold_keys(X))`


This will set `$foo=1` only while `A` is held down. Pressing `X` will output `X` but holding `A` while pressing `X` will output `Y`.

We can extend this further to create second (and third, fourth, etc...) layer macros for the entire keyboard.

For example creating a Vim HJKL movement layer when `left Alt` is held down.

- `Alt_L`:`set(layer, 1).hold().set(layer, 0)`
- `H`:`ifeq(layer, 1, hold_keys(Left), hold_keys(H))`
- `J`:`ifeq(layer, 1, hold_keys(Down), hold_keys(J))`
- `K`:`ifeq(layer, 1, hold_keys(Up), hold_keys(K))`
- `L`:`ifeq(layer, 1, hold_keys(Right), hold_keys(L))`
Comment on lines +213 to +216
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `H`:`ifeq(layer, 1, hold_keys(Left), hold_keys(H))`
- `J`:`ifeq(layer, 1, hold_keys(Down), hold_keys(J))`
- `K`:`ifeq(layer, 1, hold_keys(Up), hold_keys(K))`
- `L`:`ifeq(layer, 1, hold_keys(Right), hold_keys(L))`
- `H`:`if_eq($layer, 1, hold_keys(Left), hold_keys(H))`
- `J`:`if_eq($layer, 1, hold_keys(Down), hold_keys(J))`
- `K`:`if_eq($layer, 1, hold_keys(Up), hold_keys(K))`
- `L`:`if_eq($layer, 1, hold_keys(Right), hold_keys(L))`


Loading