Add dz60_macos_arrow keymap (#3296)

3 files changed, 171 insertions, 0 deletions

diff --git a/keyboards/dz60/keymaps/macos_arrow/config.h b/keyboards/dz60/keymaps/macos_arrow/config.h
new file mode 100644
index 0000000000..235ae1b2db
--- /dev/null
+++ b/keyboards/dz60/keymaps/macos_arrow/config.h
@@ -0,0 +1,9 @@
+#ifndef CONFIG_KEYMAP_H
+#define CONFIG_KEYMAP_H
+
+#include "../../config.h"
+
+// Fix KC_GESC conflict with Cmd+Alt+Esc on macos
+#define GRAVE_ESC_GUI_OVERRIDE
+
+#endif
\ No newline at end of file
diff --git a/keyboards/dz60/keymaps/macos_arrow/keymap.c b/keyboards/dz60/keymaps/macos_arrow/keymap.c
new file mode 100644
index 0000000000..5beaf6d8d7
--- /dev/null
+++ b/keyboards/dz60/keymaps/macos_arrow/keymap.c
@@ -0,0 +1,92 @@
+#include QMK_KEYBOARD_H
+
+#define ______ KC_TRNS
+#define _BL 0
+#define _FL 1
+#define _ML 2
+
+enum my_keycodes {
+  BR_UP = SAFE_RANGE,
+  BR_DOWN
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  /* ,-----------------------------------------------------------------------------------------.
+   * | Esc | 1   | 2   | 3   | 4   | 5   | 6   | 7   | 8   | 9   | 0   | -   | =   | Backspace |
+   * |-----------------------------------------------------------------------------------------+
+   * | Tab    | Q   | W   | E   | R   | T   | Y   | U   | I   | O   | P   | [   | ]   |   \    |
+   * |-----------------------------------------------------------------------------------------+
+   * | _FL      | A   | S   | D   | F   | G   | H   | J   | K   | L   | ;   | '   | Enter      |
+   * |-----------------------------------------------------------------------------------------+
+   * | Shift     | Z   | X   | C   | V   | B   | N   | M   | ,   | .   | /   | _ML | Up  |Shift|
+   * |-----------------------------------------------------------------------------------------+
+   * | Ctrl | Alt  | Gui  |                Space               |Gui/_ML| Alt | Left| Down|Right|
+   * `-----------------------------------------------------------------------------------------'
+   */
+  [_BL] = LAYOUT_2_shifts(
+    KC_GESC, 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,
+    MO(_FL), KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT,
+    KC_LSFT, KC_NO, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, MO(_ML), KC_UP, KC_RSFT,
+    KC_LCTL, KC_LALT, KC_LGUI, KC_SPC, KC_SPC, KC_SPC, LM(_ML, MOD_RGUI), KC_RALT, KC_LEFT, KC_DOWN, KC_RIGHT),
+
+  /* ,-----------------------------------------------------------------------------------------.
+   * |  `  | F1  | F2  | F3  | F4  | F5  | F6  | F7  | F8  | F9  | F10 | F11 | F12 |    Del    |
+   * |-----------------------------------------------------------------------------------------+
+   * |        |     |     |     |     |     |     |     | UP  |     |     |     |     |  Reset |
+   * |-----------------------------------------------------------------------------------------+
+   * |          |     |     |     |     |     |     | Left| Down|Right|     |     |            |
+   * |-----------------------------------------------------------------------------------------+
+   * |           |     |     |     |     |     |     |     |     |     |     |     |     |     |
+   * |-----------------------------------------------------------------------------------------+
+   * |      |      |      |                                      |     |     |     |     |     |
+   * `-----------------------------------------------------------------------------------------'
+   */
+  [_FL] = LAYOUT(
+    KC_GRV, 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,
+    ______, ______, ______, ______, ______, ______, ______, ______, KC_UP, ______, ______, ______, ______, RESET,
+    ______, ______, ______, ______, ______, ______, ______, KC_LEFT, KC_DOWN, KC_RIGHT, ______, ______, ______,
+    ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______,
+    ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______),
+
+  /* ,-----------------------------------------------------------------------------------------.
+   * |     | BR- | BR+ | F3  | F4  |     |     |PREV |PLAY |NEXT |MUTE | V- | V+ |    Eject    |
+   * |-----------------------------------------------------------------------------------------+
+   * |        |     |     |     |     |     |     |     |     |     |     |     |     |        |
+   * |-----------------------------------------------------------------------------------------+
+   * |          |     |     |     |     |     |     |     |     |     |     |     |            |
+   * |-----------------------------------------------------------------------------------------+
+   * |           |     |     |     |     |     |     |     |     |     |     |     |     |     |
+   * |-----------------------------------------------------------------------------------------+
+   * |      |      |      |                                      |     |     |     |     |     |
+   * `-----------------------------------------------------------------------------------------'
+   */
+  [_ML] = LAYOUT(
+    ______, BR_DOWN, BR_UP, ______, ______, KC_F5, KC_F6, KC_MEDIA_PREV_TRACK, KC_MEDIA_PLAY_PAUSE, KC_MEDIA_NEXT_TRACK, KC_AUDIO_MUTE, KC_AUDIO_VOL_DOWN, KC_AUDIO_VOL_UP, ______, KC_MEDIA_EJECT,
+    ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______,
+    ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______,
+    ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______,
+    ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______),
+};
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  uint8_t key;
+  switch (keycode) {
+    case BR_DOWN:
+    case BR_UP:
+      // Clear the RGUI modifier placed by LM for _ML layer as brightness don't
+      // work with modifiers.
+      key = (keycode == BR_DOWN) ? KC_SLCK : KC_PAUS;
+      if (record->event.pressed) {
+          unregister_mods(MOD_RGUI);
+          add_key(key);
+          send_keyboard_report();
+      } else {
+          del_key(key);
+          send_keyboard_report();
+      }
+      return false; // Skip all further processing of this key
+    default:
+      return true; // Process all other keycodes normally
+  }
+}
diff --git a/keyboards/dz60/keymaps/macos_arrow/readme.md b/keyboards/dz60/keymaps/macos_arrow/readme.md
new file mode 100644
index 0000000000..bd8740bd41
--- /dev/null
+++ b/keyboards/dz60/keymaps/macos_arrow/readme.md
@@ -0,0 +1,70 @@
+# Macos keymap with arrow
+
+This is a keymap for DZ60 configured with arrows using the layout below:
+
+[![](https://poitr.us/mARFK9+)](http://www.keyboard-layout-editor.com/#/gists/07d924064c77c0ff43de6b8a9519f931)
+
+My build used the following components:
+* DZ60 PCB
+* [Stainless steel alu plate option A with 2U left shift](https://www.aliexpress.com/item/Alu-plate-dz60-plate-for-DIY-mechanical-keyboard/32827595666.html) (optional)
+* [YMDK customized 61 64 68 ANSI keyset](https://www.amazon.com/Customized-Keyset-Profile-Mechanical-Keyboard/dp/B0777LMKKK)
+* 60 Cherry MX Clear for the main keys + 10 Cherry MX Grey for the large keys
+* [The wood case for DZ60](https://www.aliexpress.com/item/GH60-Keyboard-Wood-Case-PCB-Board-Position-Plate-Satellite-Axis-And-Walnut-Wood-Wrist-Rest-For/32836566852.html) (optional)
+
+## Base Layer
+
+```
+,-----------------------------------------------------------------------------------------.
+| Esc | 1   | 2   | 3   | 4   | 5   | 6   | 7   | 8   | 9   | 0   | -   | =   | Backspace |
+|-----------------------------------------------------------------------------------------+
+| Tab    | Q   | W   | E   | R   | T   | Y   | U   | I   | O   | P   | [   | ]   |   \    |
+|-----------------------------------------------------------------------------------------+
+| _FL      | A   | S   | D   | F   | G   | H   | J   | K   | L   | ;   | '   | Enter      |
+|-----------------------------------------------------------------------------------------+
+| Shift     | Z   | X   | C   | V   | B   | N   | M   | ,   | .   | /   | _ML | Up  |Shift|
+|-----------------------------------------------------------------------------------------+
+| Ctrl | Alt  | Cmd  |                Space               |Cmd/_ML| Alt | Left| Down|Right|
+`-----------------------------------------------------------------------------------------'
+```
+
+* The escape key use `KC_GESC` to get grave accent on any letter with ``Alt+Esc`` and `` ` `` alone with the ``Hyper+Esc``. The `~` is obtained with `Shift+Esc`. `GRAVE_ESC_GUI_OVERRIDE` is define so `Cmd+Alt+Esc` can still work.
+* The `Caps-Lock` (`Hyper`) key switch to the function layer (`_FL`).
+* The right `Cmd` key is used to switch to the media layer (`_ML`) when used with keys mapped on that layer (the top row). Any other keys just act as a `Cmd+` that key.
+
+## Function Layer (_FL)
+
+```
+,-----------------------------------------------------------------------------------------.
+|  `  | F1  | F2  | F3  | F4  | F5  | F6  | F7  | F8  | F9  | F10 | F11 | F12 |    Del    |
+|-----------------------------------------------------------------------------------------+
+|        |     |     |     |     |     |     |     | UP  |     |     |     |     |  Reset |
+|-----------------------------------------------------------------------------------------+
+|          |     |     |     |     |     |     | Left| Down|Right|     |     |            |
+|-----------------------------------------------------------------------------------------+
+|           |     |     |     |     |     |     |     |     |     |     |     |     |     |
+|-----------------------------------------------------------------------------------------+
+|      |      |      |                                      |     |     |     |     |     |
+`-----------------------------------------------------------------------------------------'
+```
+
+The function layer is activated by the `Caps-Lock` (`Hyper`) key to access `F` keys. In addition, the `IJKL` are mapped as cursor keys on that layer.
+
+## Media Layer (_ML)
+
+```
+,-----------------------------------------------------------------------------------------.
+|     | BR- | BR+ | F3  | F4  |     |     |PREV |PLAY |NEXT |MUTE | V- | V+ |    Eject    |
+|-----------------------------------------------------------------------------------------+
+|        |     |     |     |     |     |     |     |     |     |     |     |     |        |
+|-----------------------------------------------------------------------------------------+
+|          |     |     |     |     |     |     |     |     |     |     |     |            |
+|-----------------------------------------------------------------------------------------+
+|           |     |     |     |     |     |     |     |     |     |     |     |     |     |
+|-----------------------------------------------------------------------------------------+
+|      |      |      |                                      |     |     |     |     |     |
+`-----------------------------------------------------------------------------------------'
+```
+
+The media layer is activated by the right `Cmd` (`FN`) key. It contains the typical macos media keys on the top row. Blank keys act as `Cmd+` that key on the base layer.
+
+