keyboards/kbd6x/keymaps/othi/readme.md

   1 ## Othi's Universal HHKB keymap
   2
   3 ### Goals
   4 - Colemak layout. If you don't use Colemak then you'll need to also change the arrow key bindigns in other layers
   5
   6 - Vim-like navigation layer so you can use vim binding arrowkeys in non-vim environment
   7
   8 - Good modifier support so you don't have to hold 14 modifier keys at the same time
   9
  10 - RGB indicating layer change(only work with plain colors so far, don't put your rgb to pulsing or any non static animation)
  11
  12 ### Layers
  13 - **CL:**
  14
  15         The base layer, default is Colemak
  16
  17 - **NM_MODE:**
  18
  19         Vim-like arrowkeys in the home row, it's `LHNE` for *JENK Colemak* and `HJKL` for *QWERTY*
  20
  21         Also `HOME`, `END` and next/prev word (`Ctrl + Left/Right`) in `0, 4, w, b` like in vim
  22
  23 - **VI_MODE:**
  24
  25         The same as `NM_MODE` but with `KC_LSFT` held down for mostly highlighting
  26
  27 - **ACCENT + ACCENT_CAP:**
  28
  29         Function row and Unicode characters
  30
  31 ### Modifiers and Tap Dance keys
  32 **LHS:**
  33
  34 - Any Tap Dance key with the format of `TD(XXX_NM)` act as normal XXX modifier upon hold, but will hold **and** put you to `NM_MODE` when double click hold(a tap before the hold)(eg you can produce `Alt + PgUp` by pressing `Alt + Alt + U`)
  35
  36 - `KC_TAB` acts as both `KC_TAB` on tap and `KC_LGUI` on hold
  37
  38 - R3 CapsLock acts as both `KC_BSPC` on tap and `KC_LCTL` on hold
  39
  40 - Holding `KC_Q` also puts you into `NM_MODE`
  41
  42 - Holding `KC_F` puts you into `VI_MODE` for fast function keys
  43
  44 **RHS:**
  45
  46 - 3 keys `KC_SCLN`, `KC_DOT` and `KC_SLSH` in `CL` layer can also be held down for respectively `KC_LCTL`, `KC_LSFT`, `KC_LALT` for easier 2-hand modifier holding
  47
  48 - Right modifiers hold the selected modifier with `KC_LGUI` at the same time, mainly for i3wm, you can change this to whatever combination you want
  49
  50 ### Misc. functionalities
  51
  52 **Unicode:**
  53
  54 - In case the keyboard output the 4-digit codepoint instead of the actual unicode, you need to change the rewrite input mode of the keyboard into the EEPROM(you only have to do this if the EEPROM was cleared or your current machine use another unicode compose method other than IBus/Linux's `Ctrl + Shift + U`). Change the corresponding Input `void eeconfig_init_user(void)`. See [this](https://docs.qmk.fm/#/feature_unicode) for availble input modes.
  55
  56 - **NOTE:** make sure to keep your qmk env up to date with upstream