[Keymap] bingocaller's DZ60 MacOS keymap (#5914)

* Added customisations and README

* Tweak keymap: word traversal/deletion

* Add w and b word traversal/deletion keycodes.
* Add fine volume control key codes, but don't use them, because they
  conflict with other key codes. `A` somehow got remapped to fine
  volume up.

* Set mousekey delay to zero

* Use SAFE_RANGE for key codes.

* Update keymap and README

Add new mouse-specific layer 3, activated by pressing and holding space.
Add brightness controls to layer 4 (previously, layer 3).
Update README:
  * New keyboard-layout mockup image.
  * Add actual link to kbdfans.cn.
  * Update layer descriptions.

* Fix indentation in keymap.c

* Use _______ over KC_TRNS to increase readability

* Custom keys: use #define over process_record_user

* Use enum for naming layers

* Rename README.md -> readme.md

3 files changed, 209 insertions, 0 deletions

diff --git a/keyboards/dz60/keymaps/bingocaller/config.h b/keyboards/dz60/keymaps/bingocaller/config.h
new file mode 100644
index 000000000..470e3d18b
--- /dev/null
+++ b/keyboards/dz60/keymaps/bingocaller/config.h
@@ -0,0 +1,2 @@
+#undef MOUSEKEY_DELAY
+#define MOUSEKEY_DELAY 0
diff --git a/keyboards/dz60/keymaps/bingocaller/keymap.c b/keyboards/dz60/keymaps/bingocaller/keymap.c
new file mode 100644
index 000000000..961d82556
--- /dev/null
+++ b/keyboards/dz60/keymaps/bingocaller/keymap.c
@@ -0,0 +1,93 @@
+#include QMK_KEYBOARD_H
+
+#define WORD_BACK A(KC_LEFT)
+#define WORD_FORWARD A(KC_RIGHT)
+#define DELETE_WORD_BACK A(KC_BSPACE)
+#define DELETE_WORD_FORWARD A(KC_DELETE)
+#define FINE_VOLUP S(A(KC__VOLUP))
+#define FINE_VOLDOWN S(A(KC__VOLDOWN))
+
+enum layers {
+  _BASE,
+  _ARROWS,
+  _HDUE, // Home, PgDown, PgUp, End
+  _MOUSE,
+  _FN
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /*  Default layer:
+        * Space Cadet shifts (parentheses on tap)
+        * Caps Lock is Control on hold, Esc on tap
+        * Hyper/Caps Lock on Control
+        * Hold D to activate layer 1
+        * Hold Space to activate layer 3 (Mouse keys)
+        * Hold FN to activate layer 4
+    */
+    [_BASE] = LAYOUT(
+        KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_NO, KC_BSPC,
+        KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS,
+        LCTL_T(KC_ESC), KC_A, KC_S, LT(_ARROWS, KC_D), KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT,
+        KC_LSPO, KC_NO, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSPC, KC_NO,
+        ALL_T(KC_CAPS), KC_LALT, KC_LGUI, KC_NO, LT(_MOUSE, KC_SPC), KC_NO, KC_RGUI, KC_RALT, KC_NO, MO(_FN), ALL_T(KC_CAPS)),
+
+    /*  Layer 1:
+        * Vim arrows (HJKL)
+        * Vim-like move across words with W(ord), and B(eginning)
+        * Media controls (fine volume controls using Option+Shift)
+        * Backspace/Del on N/M
+        * Hold F to activate layer 2
+    */
+    [_ARROWS] = LAYOUT(
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, WORD_FORWARD, _______, _______, _______, _______, KC_MRWD, KC_MPLY, KC_MFFD, KC__MUTE, FINE_VOLDOWN, FINE_VOLUP, _______,
+        _______, _______, _______, _______, LT(_HDUE, _______), _______, KC_LEFT, KC_DOWN, KC_UP, KC_RIGHT, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, WORD_BACK, KC_BSPC, KC_DEL, _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______),
+
+    /*  Layer 2:
+        * Home, End, Page Up, Page Down
+        * Delete word forward/back on W/B
+    */
+    [_HDUE] = LAYOUT(
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, DELETE_WORD_FORWARD, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, KC_HOME, KC_PGDOWN, KC_PGUP, KC_END, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, DELETE_WORD_BACK, _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______),
+
+    /*  Layer 3:
+        * Mouse keys
+            * Cursor movement: HJKL
+            * MB 1, 2, and 3 on F, D, and S, respectively
+            * Mouse wheel: U(p) and D(own)
+    */
+    [_MOUSE] = LAYOUT(
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, KC_WH_U, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, KC_BTN3, KC_BTN2, KC_BTN1, _______, KC_MS_L, KC_MS_D, KC_MS_U, KC_MS_R, _______, _______, _______,
+        _______, _______, _______, _______, KC_WH_D, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______),
+
+    /*  Layer 4:
+        * F1-12
+        * Del on backspace
+        * RGB (underglow) controls
+        * RESET firmware on backslash
+        * Screen brightness: Z (decrease), X (increase)
+    */
+    [_FN] = LAYOUT(
+        _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______, KC_DEL,
+        _______, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, _______, _______, _______, RESET,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______, KC_BRMD, KC_BRMU, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______),
+
+    // TEMPLATE
+    // LAYOUT(
+        // _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        // _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        // _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        // _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        // _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______),
+};
diff --git a/keyboards/dz60/keymaps/bingocaller/readme.md b/keyboards/dz60/keymaps/bingocaller/readme.md
new file mode 100644
index 000000000..0cb3f77e2
--- /dev/null
+++ b/keyboards/dz60/keymaps/bingocaller/readme.md
@@ -0,0 +1,114 @@
+# MacOS standard 60% keymap with Vim-like arrows
+
+This is a MacOS-specific keymap for DZ60 configured in a standard 60% ANSI layout, with a stepped Caps Lock:
+
+[![](https://i.imgur.com/lFP2O41.png)](http://www.keyboard-layout-editor.com/#/gists/4b156fdf2c1426bffc82fadd2b1c5634)
+
+**[Fully assembled 60% keyboard from KBDfans](https://kbdfans.cn/collections/fully-assembled-keyboard/products/fully-assembled-plastic-case-mechanical-keyboard)**
+
+## Base Layer
+
+```
+,-----------------------------------------------------------------------------------------.
+|  `  |  1  |  2  |  3  |  4  |  5  |  6  |  7  |  8  |  9  |  0  |  -  |  =  | Backspace |
+|-----------------------------------------------------------------------------------------+
+|   Tab  |  Q  |  W  |  E  |  R  |  T  |  Y  |  U  |  I  |  O  |  P  |  [  |  ]  |   \    |
+|-----------------------------------------------------------------------------------------+
+| Ctrl/Esc |  A  |  S  | D/L1 |  F  |  G  |  H  |  J  |  K  |  L  |  ;  |  '  |   Enter   |
+|-----------------------------------------------------------------------------------------+
+|   Shift/(   |  Z  |  X  |  C  |  V  |  B  |  N  |  M  |  ,  |  .  |  /  |    Shift/)    |
+|-----------------------------------------------------------------------------------------+
+| Hyper |  Alt  |  Cmd  |             Space/L3             |  Cmd  |  Alt  |  L4  | Hyper |
+`-----------------------------------------------------------------------------------------'
+```
+
+* Space Cadet shifts (parentheses on tap)
+* Caps Lock is Control on hold, Esc on tap
+* Hyper/Caps Lock on Control
+* Hold D to activate layer 1
+* Hold Space to activate layer 3 (Mouse keys)
+* Hold FN to activate layer 4
+
+## `L1`
+
+```
+,-----------------------------------------------------------------------------------------.
+|     |     |     |     |     |     |     |     |     |     |     |     |     |           |
+|-----------------------------------------------------------------------------------------+
+|        |     |  W→  |     |     |     |     | ⏮ | ⏯ | ⏭ |  🔇 |  🔉 |  🔊 |         |
+|-----------------------------------------------------------------------------------------+
+|          |     |     |     |  L2  |     |  ←  |  ↓  |  ↑  |  →  |     |     |           |
+|-----------------------------------------------------------------------------------------+
+|             |     |     |     |     |  W←  |  ⌫  |  ⌦  |     |     |     |              |
+|-----------------------------------------------------------------------------------------+
+|       |       |       |                                 |       |       |       |       |
+`-----------------------------------------------------------------------------------------'
+```
+
+* Vim arrows (HJKL)
+* Vim-like move across words with W(ord), and B(eginning)
+* Media controls (fine volume controls using Option+Shift)
+* Backspace/Del on N/M
+* Hold F to activate layer 2
+
+## `L2`
+
+```
+,-----------------------------------------------------------------------------------------.
+|     |     |     |     |     |     |     |     |     |     |     |     |     |           |
+|-----------------------------------------------------------------------------------------+
+|        |     |  W⌦  |     |     |     |     |     |     |     |     |     |     |       |
+|-----------------------------------------------------------------------------------------+
+|          |     |      |     |     |     |  ↖  |  ⇞  |  ⇟  |  ↘︎  |     |     |           |
+|-----------------------------------------------------------------------------------------+
+|             |     |     |     |     |  W⌫  |     |     |     |     |     |              |
+|-----------------------------------------------------------------------------------------+
+|       |       |       |                                 |       |       |       |       |
+`-----------------------------------------------------------------------------------------'
+```
+
+* Home, End, Page Up, Page Down
+* Delete word forward/back on W/B
+
+## `L3`
+
+```
+,-----------------------------------------------------------------------------------------.
+|     |     |     |     |     |     |     |     |     |     |     |     |     |           |
+|-----------------------------------------------------------------------------------------+
+|        |     |     |     | MWU |     |     |     |     |     |     |     |     |        |
+|-----------------------------------------------------------------------------------------+
+|           |     | M3  | M2  | M1  |     | M←  | M↓  | M↑  | M→  |     |     |           |
+|-----------------------------------------------------------------------------------------+
+|             |     |     |     | MWD |     |     |     |     |     |     |               |
+|-----------------------------------------------------------------------------------------+
+|       |       |       |                                 |       |       |       |       |
+`-----------------------------------------------------------------------------------------'
+```
+
+* Mouse keys
+    * Cursor movement: HJKL
+    * MB 1, 2, and 3 on F, D, and S, respectively
+    * Mouse wheel: Up (R) and Down (V)
+
+## `L4`
+
+```
+,-----------------------------------------------------------------------------------------.
+|     | F1  | F2  | F3  | F4  | F5  | F6  | F7  | F8  | F9  | F10 | F11 | F12 |     ⌦     |
+|-----------------------------------------------------------------------------------------+
+|       |RGB_T|RGB_M|RGB_H+|RGB_H-|RGB_S+|RGB_S-|RGB_V+|RGB_V-|   |   |   |   |   RESET   |
+|-----------------------------------------------------------------------------------------+
+|           |     |     |     |     |     |     |     |     |     |     |     |           |
+|-----------------------------------------------------------------------------------------+
+|             | 🔅 | 🔆 |     |     |     |     |     |     |     |      |                |
+|-----------------------------------------------------------------------------------------+
+|       |       |       |                                 |       |       |       |       |
+`-----------------------------------------------------------------------------------------'
+```
+
+* F1-12
+* Del on backspace
+* RGB (underglow) controls
+* RESET firmware on backspace
+* Screen brightness: Z (decrease), X (increase)