keyboards/dz60/keymaps/mechmerlin/readme.md

   1 # MechMerlin's DZ60 Keymap
   2
   3 The purpose of this keymap is to provide examples on how to do some common QMK features.
   4
   5 Make example for this keyboard (after setting up your build environment):
   6
   7     make dz60:mechmerlin
   8
   9 ## Merlin's DZ60 Hardware Info
  10 ---
  11
  12 The DZ60 is a 60% pcb produced by KBDFans. It comes in two variants, USB Mini B and USB C. It supports many many layouts. It also supports both backlight and RGB underglow. The USB C variant does not have a hardware reset switch. USB C to C is not supported.
  13
  14 Merlin's DZ60 uses
  15 - Layout B, in QMK this is LAYOUT_60_b_ansi.
  16 - USB C
  17 - 50g Zilents
  18 - Arrows are 78g Zilents
  19 - KPRepublic XD64 Case
  20
  21 ## Layers
  22 ---
  23
  24 Merlin's keymap has three different layers. To switch layers you can use the `MO(X)` keycode, where `X` is the layer you want to switch to.
  25
  26 ### _BL
  27
  28 This is the base layer also known as layer 0. It is a standard QWERTY layout. It has the `_FL` layer switch key.
  29
  30 ### _FL
  31
  32 This is the function layer also known as layer 1. It utiizes the following:
  33 - Function Keys
  34 - Navigation Keys
  35 - Audio keys such as Mute, Volume Down and Volume Up.
  36 - `_CL` layer switch key
  37
  38 ### _CL
  39
  40 This is the control layer also known as layer 2. It utilizes the following:
  41 - RGB Controls
  42 - `RESET` key
  43
  44 ## Non Standard Keycodes
  45 ---
  46 ### RESET
  47
  48 As long `BOOTMAGIC_ENABLE` is set to `yes` in `rules.mk`, the DZ60 can be put into bootloader mode by holding the `space` key and the `b` key while plugging in. However sometmes this doesn't work or is troublesome to do, might as well use the `RESET` keycode to accomplish this.
  49
  50 ### RSFT_T(KC_SLSH)
  51
  52 Layout B is missing the `?` key and is instead replaced with a `right shift`. This keycode makes it so that the key can be tapped for `?` and held for `right shift`.
  53
  54 ### LCTL_T(KC_CAPS)
  55
  56 `Caps Lock` is only ever used by tapping, why not use it as a `control` key when held? This keycode makes it so that the key can be tapped for `caps lock` and held for `control`.
  57
  58
  59 ## RGB Lighting
  60 ---
  61
  62 ### RGBLIGHT_SLEEP
  63
  64 This is set in `mechmerlin/config.h` so that when the computer goes to sleep, the RGB lights will also go to sleep on the keyboard. They will turn back on when the computer wakes.
  65
  66 ### RGB Underglow Color: Yellow
  67
  68 This is set in `mechmerlin/keymap.c` in the `matrix_init_user` function. The list of available colors can be found in [`quantum/rgblight_list.h`](https://github.com/qmk/qmk_firmware/blob/388df5359b913eaf1ce6fb0ef624e430ad010ea5/quantum/rgblight_list.h#L59-L121).