users/mechmerlin/readme.md

   1 # MechMerlin's Userspace v0.2.0
   2
   3 This is a collection of my most commonly used QMK features.
   4
   5 A majority of my keyboards are smaller than 75%, ANSI, and staggered.
   6
   7 ## Layers
   8 ----
   9
  10 ### _BL (Base Layer)
  11 Typical standard QWERTY keymap.
  12
  13 ### _FL (Function Layer)
  14 This layer is commonly accessed via `MO(_FL)` on the base layer. It consists of your typical function key F1 through F12 and some RGB and Backlight controls.
  15
  16 ### _AL (Arrow Layer)
  17 This layer is only present on my 60% boards. I habitually use the bottom right modifiers as arrows.
  18
  19 ### _CL (Control Layer)
  20 This is not defined in here as it's present only on `LAYOUT_66` boards, or to be specific, my clueboard. It currently uses the default clueboard controls.
  21
  22 ## Custom Keycodes
  23 ----
  24
  25 ### KC_FNX (Fn Extended)
  26
  27 `KC_FNX` functions as a hold for `MO(X)` and tap for `TG(Y)`. Layer X and Y are different layers.
  28
  29 It is used primarily on my `LAYOUT_60_ansi` boards as my regular toggle (the 1u key to the right of right shift), is not present there.
  30
  31 ### KC_CTCP (Control Caps)
  32
  33 This is just a wrapper for `CTL_T(KC_CAPS)`. This is a hold for control and tap for caps lock.
  34
  35 ## QMK Features
  36 ----
  37
  38 ### RGBLIGHT_SLEEP
  39
  40 Ensures that when my computer is in sleep mode, the keyboard underglow lights will also be off.
  41
  42 ### Audio Clicky
  43
  44 If a board has a speaker, enable beeps and boops per switch actuation. This is currently only available on prototype/gen1 clueboard 66_hotswaps.
  45
  46 ### Velocikey
  47
  48 [Velocikey](https://github.com/qmk/qmk_firmware/blob/master/docs/feature_velocikey.md) is an RGBLIGHT feature in which the faster you type, the faster the ARE GEE BEES.