Update README + keymap-drawer docs for NAVI/HUB layer rework
This commit is contained in:
afiqzudinhadi
github-actions[bot]
parent
9de7108d31
commit
437275d284
4 changed files with 58 additions and 36 deletions
|
|
@ -77,7 +77,7 @@ git clone git@github.com:afiqzudinhadi/zmk-config.git
|
|||
|
||||
### Edit Config Files
|
||||
|
||||
For full customization (combos, steno layer, behaviors):
|
||||
For full customization (layers, behaviors):
|
||||
|
||||
```
|
||||
config/
|
||||
|
|
@ -211,7 +211,7 @@ RGB settings are in `config/corne.conf`:
|
|||
| Setting | Value | Description |
|
||||
|---------|-------|-------------|
|
||||
| `CONFIG_ZMK_RGB_UNDERGLOW` | `y` | Enable RGB |
|
||||
| `CONFIG_ZMK_RGB_UNDERGLOW_ON_START` | `y` | On at boot |
|
||||
| `CONFIG_ZMK_RGB_UNDERGLOW_ON_START` | `n` | Off at boot (toggle on via HUB layer) |
|
||||
| `CONFIG_WS2812_STRIP` | `y` | WS2812 LED driver |
|
||||
| `CONFIG_ZMK_RGB_UNDERGLOW_EFF_START` | `4` | Default effect (see effects table) |
|
||||
| `CONFIG_ZMK_RGB_UNDERGLOW_BRT_STEP` | `1` | Brightness step (%) |
|
||||
|
|
@ -277,9 +277,12 @@ Docs: [zmk.dev/docs/keymaps/behaviors/underglow](https://zmk.dev/docs/keymaps/be
|
|||
|
||||
### Runtime Controls (HUB Layer)
|
||||
|
||||
Access: hold NAVI key (pos 12) → press HUB (pos 0), or from FPS layer (pos 11).
|
||||
|
||||
| Key | Action |
|
||||
|-----|--------|
|
||||
| `[RGB]` | Tap-dance: 1×=toggle, 2×=effect fwd, 3×=effect rev |
|
||||
| `TOG` | RGB on/off toggle |
|
||||
| `EFF` / `EFR` | Next/previous effect |
|
||||
| `[CLR]` | Tap-dance color presets: purple → white → red → blue → green |
|
||||
| `HUE+` / `HUE-` | Adjust hue |
|
||||
| `SAT+` / `SAT-` | Adjust saturation |
|
||||
|
|
|
|||
|
|
@ -143,6 +143,17 @@ parse_config:
|
|||
|
||||
'&out OUT_USB': Out USB
|
||||
'&out OUT_BLE': Out BLE
|
||||
'&out OUT_TOG': Out Tog
|
||||
|
||||
'&ht_esc_grave ESC GRAVE': {t: '`', h: Esc}
|
||||
'&kp C_MUTE': Mute
|
||||
'&kp C_PP': ⏯
|
||||
'&kp C_PREV': ⏮
|
||||
'&kp C_NEXT': ⏭
|
||||
'&kp C_BRI_UP': Scrn+
|
||||
'&kp C_BRI_DN': Scrn-
|
||||
'&kp C_VOL_UP': Vol+
|
||||
'&kp C_VOL_DN': Vol-
|
||||
|
||||
'&bt BT_SEL 0': BT 1
|
||||
'&bt BT_SEL 1': BT 2
|
||||
|
|
@ -317,10 +328,6 @@ parse_config:
|
|||
combo_rpar: {draw_separate: true}
|
||||
combo_lbkt: {draw_separate: true}
|
||||
combo_rbkt: {draw_separate: true}
|
||||
combo_tab: {draw_separate: true}
|
||||
combo_del: {draw_separate: true}
|
||||
combo_esc: {draw_separate: true}
|
||||
combo_ret: {draw_separate: true}
|
||||
combo_lock: {draw_separate: true}
|
||||
combo_bslh: {draw_separate: true}
|
||||
combo_slsh: {draw_separate: true}
|
||||
|
|
|
|||
|
|
@ -12,35 +12,30 @@
|
|||
## Layer 0: CARP (Carpalx QGMLWY)
|
||||
|
||||
```
|
||||
` Q G M L W | Y F U B ; ->HUB
|
||||
[HUB] D S T N R | I A E O H '
|
||||
`/ESC Q G M L W | Y F U B ; TAB
|
||||
[NAVI] D S T N R | I A E O H '
|
||||
LSHFT Z X C V J | K P , . / RSHFT
|
||||
[RGB] CTRL GUI | SPC ALT MUTE/PP
|
||||
CTRL RET GUI | SPC BSPC ALT
|
||||
```
|
||||
|
||||
**Combos (layers 0+1):**
|
||||
- Top+home row same col = `1`-`0`, shift+combo = `!` `@` `#` `$` `%` `^` `&` `*` `(` `)`
|
||||
- G+M (W+E on QWRT) = ESC
|
||||
- S+T (S+D on QWRT) = TAB
|
||||
- U+B (I+O on QWRT) = BSPC
|
||||
- E+O (K+L on QWRT) = ENTER
|
||||
|
||||
| Key | Behavior |
|
||||
|-----|----------|
|
||||
| `[HUB]` | Hold opens HUB layer, release goes back |
|
||||
| `[RGB]` | Tap-dance: 1x=toggle, 2x=effect fwd, 3x=effect rev |
|
||||
| `MUTE/PP` | Tap mute, hold play/pause |
|
||||
| `` ` ``/ESC | Tap = grave, hold = ESC |
|
||||
| `[NAVI]` | Hold opens NAVI layer, release goes back |
|
||||
|
||||
## Layer 1: QWRT (QWERTY)
|
||||
|
||||
```
|
||||
` Q W E R T | Y U I O P ->HUB
|
||||
[HUB] A S D F G | H J K L ; '
|
||||
`/ESC Q W E R T | Y U I O P TAB
|
||||
[NAVI] A S D F G | H J K L ; '
|
||||
LSHFT Z X C V B | N M , . / RSHFT
|
||||
[RGB] CTRL GUI | SPC ALT MUTE/PP
|
||||
CTRL RET GUI | SPC BSPC ALT
|
||||
```
|
||||
|
||||
Combos: same as CARP (top+home = 1-0, W+E = ESC, S+D = TAB, I+O = BSPC, K+L = ENTER)
|
||||
Combos: same as CARP (top+home = 1-0)
|
||||
|
||||
## Layer 2: STEN (Placeholder)
|
||||
|
||||
|
|
@ -61,14 +56,28 @@ M/ALT Z X C V G | _ _ _ _ _ _
|
|||
| `E` | Tap = E, hold = 3 |
|
||||
| `R` | Tap = R, hold = 4 |
|
||||
| `M` | Tap = M, hold = ALT |
|
||||
| `->HUB` | Press to go to HUB layer |
|
||||
|
||||
## Layer 4: HUB (Utility — BT, RGB, Media, Nav)
|
||||
## Layer 4: NAVI (Numbers, Nav, Symbols)
|
||||
|
||||
```
|
||||
BT_CLR BT0 BT1 BT2 BT3 BT4 | + [ UP ] * =
|
||||
OUT_TOG HUE+ SAT+ BRT+ SCRN+ VOL+ | - LEFT DOWN RIGHT / \
|
||||
LSHFT HUE- SAT- BRT- SCRN- VOL- | ->CARP ->QWRT ->STEN ->FPS [CLR] RSHFT
|
||||
[RGB] CTRL GUI | SPC ALT MUTE/PP
|
||||
->HUB 1 2 3 4 5 | + [ UP ] * =
|
||||
_ 6 7 8 9 0 | - LEFT DOWN RIGHT / \
|
||||
LSHFT _ _ _ _ _ | _ _ _ _ _ RSHFT
|
||||
CTRL RET GUI | SPC BSPC ALT
|
||||
```
|
||||
|
||||
| Key | Action |
|
||||
|-----|--------|
|
||||
| `->HUB` | Press to go to HUB layer |
|
||||
|
||||
## Layer 5: HUB (Media, BT, RGB, Layer Switch)
|
||||
|
||||
```
|
||||
->CARP ->QWRT ->STEN ->FPS _ PP | BT0 BT1 BT2 BT3 BT4 BT_CLR
|
||||
_ _ _ _ SCRN+ VOL+ | HUE+ SAT+ BRT- [CLR] _ OUT_TOG
|
||||
_ _ _ _ SCRN- VOL- | HUE- SAT- BRT+ _ _ _
|
||||
PREV NEXT MUTE | TOG EFR EFF
|
||||
```
|
||||
|
||||
| Key | Action |
|
||||
|
|
@ -77,6 +86,9 @@ LSHFT HUE- SAT- BRT- SCRN- VOL- | ->CARP ->QWRT ->STEN ->FPS [CLR] R
|
|||
| `HUE/SAT/BRT` | RGB underglow hue, saturation, brightness |
|
||||
| `SCRN` | Display brightness (C_BRI_UP/DN) |
|
||||
| `VOL` | Volume up/down |
|
||||
| `[RGB]` | Tap-dance: 1x=toggle, 2x=effect fwd, 3x=effect rev |
|
||||
| `PREV/NEXT` | Track previous/next |
|
||||
| `PP` | Play/pause |
|
||||
| `MUTE` | Mute toggle |
|
||||
| `TOG` | RGB on/off |
|
||||
| `EFF/EFR` | RGB effect next/previous |
|
||||
| `[CLR]` | Tap-dance color presets: 1x=purple, 2x=white, 3x=red, 4x=blue, 5x=green |
|
||||
| `MUTE/PP` | Tap mute, hold play/pause |
|
||||
|
|
|
|||
|
|
@ -191,29 +191,29 @@ layers:
|
|||
- ''
|
||||
- ''
|
||||
- ''
|
||||
- BRI UP
|
||||
- Vol Up
|
||||
- Scrn+
|
||||
- Vol+
|
||||
- {t: '$$mdi:led-on$$', s: '$$mdi:palette$$', type: sym_by_sym}
|
||||
- {t: '$$mdi:led-outline$$', s: '$$mdi:eyedropper$$', type: sym_by_sym}
|
||||
- {t: '$$mdi:led-on$$', s: '$$tabler:brightness-up$$', type: sym_by_sym}
|
||||
- '&td_colors'
|
||||
- ''
|
||||
- OUT TOG
|
||||
- Out Tog
|
||||
- ''
|
||||
- ''
|
||||
- ''
|
||||
- ''
|
||||
- BRI DN
|
||||
- Vol Down
|
||||
- Scrn-
|
||||
- Vol-
|
||||
- {t: '$$mdi:led-outline$$', s: '$$mdi:palette$$', type: sym_by_sym}
|
||||
- {t: '$$mdi:led-on$$', s: '$$mdi:eyedropper$$', type: sym_by_sym}
|
||||
- {t: '$$mdi:led-outline$$', s: '$$tabler:brightness-down$$', type: sym_by_sym}
|
||||
- ''
|
||||
- ''
|
||||
- ''
|
||||
- ⏮️
|
||||
- ⏭️
|
||||
- MUTE
|
||||
- ⏮
|
||||
- ⏭
|
||||
- Mute
|
||||
- {t: '$$mdi:led-on$$', h: '$$mdi:toggle-switch$$', s: '$$mdi:led-outline$$', type: toggle}
|
||||
- {t: '$$mdi:led-on$$', h: '$$mdi:page-next-outline$$', type: tap_dance}
|
||||
- {t: '$$mdi:led-on$$', h: '$$mdi:page-previous-outline$$', type: tap_dance}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue