Add M4cs Keymap for dekunukem/duckyPad (#10900)

* Add Keymap

* Fix Media Keys

* Add Keymap ASCII and Clean Up

* Add Readme

* Add GPL Headers, Clean Up Code Based on @drashna Suggestions

* Remove unnecessary include

* Add Layout for info.json and Readme.md

* Fix Layout for info.json

* Fix #endif Error

* Remove Tapping Term

* Add Default Keymap

* Add comments, fix readmes, clean up

* Fix README formatting

* Fix Timeout

* Fix I2C Rules

* Fix Comment Formatting, Multiline Breaks

* Add Sleep/Backlight Rules

* Clean Up README

* Clean Up Rules

* Fix Comments

* Add Pragmas

Co-authored-by: M4cs <mabridgland@protonmail.com>
Co-authored-by: Max <max@Maxs-MacBook-Pro.local>

4 files changed, 338 insertions, 0 deletions

diff --git a/keyboards/dekunukem/duckypad/keymaps/m4cs/config.h b/keyboards/dekunukem/duckypad/keymaps/m4cs/config.h
new file mode 100644
index 0000000000..7d0bbb1341
--- /dev/null
+++ b/keyboards/dekunukem/duckypad/keymaps/m4cs/config.h
@@ -0,0 +1,75 @@
+/*
+
+M4cs Keymap for dekuNukem/duckyPad QMK firmware
+
+Copyright (C) 2020 Max Bridgland
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#pragma once
+
+#define NO_ACTION_FUNCTION
+#define NO_ACTION_ONESHOT
+
+#define OLED_TIMEOUT 90000
+#define RGB_DISABLE_TIMEOUT 90000
+
+#define MT_0_0 " prev "
+#define MT_0_1 " pl/pa"
+#define MT_0_2 " next "
+#define MT_0_3 " volx "
+#define MT_0_4 " vol- "
+#define MT_0_5 " vol+ "
+#define MT_0_6 " spot "
+#define MT_0_7 " ffox "
+#define MT_0_8 " code "
+#define MT_0_9 " term "
+#define MT_0_10 " steam"
+#define MT_0_11 " dscd "
+#define MT_0_12 "      "
+#define MT_0_13 " micx "
+#define MT_0_14 "      "
+
+#define MT_1_0 " stat "
+#define MT_1_1 " brth "
+#define MT_1_2 " rbow "
+#define MT_1_3 " swrl "
+#define MT_1_4 " spd- "
+#define MT_1_5 " spd+ "
+#define MT_1_6 " eff- "
+#define MT_1_7 " sat- "
+#define MT_1_8 " sat+ "
+#define MT_1_9 " eff+ "
+#define MT_1_10 " hue- "
+#define MT_1_11 " hue+ "
+#define MT_1_12 " powr "
+#define MT_1_13 " bri- "
+#define MT_1_14 " bri+ "
+
+#define MT_2_0 "      "
+#define MT_2_1 "      "
+#define MT_2_2 "      "
+#define MT_2_3 " undo "
+#define MT_2_4 "  cut "
+#define MT_2_5 " copy "
+#define MT_2_6 " paste"
+#define MT_2_7 " find "
+#define MT_2_8 " pscr "
+#define MT_2_9 "      "
+#define MT_2_10 "      "
+#define MT_2_11 "      "
+#define MT_2_12 "      "
+#define MT_2_13 "      "
+#define MT_2_14 "      "
diff --git a/keyboards/dekunukem/duckypad/keymaps/m4cs/keymap.c b/keyboards/dekunukem/duckypad/keymaps/m4cs/keymap.c
new file mode 100644
index 0000000000..2ce15d7e77
--- /dev/null
+++ b/keyboards/dekunukem/duckypad/keymaps/m4cs/keymap.c
@@ -0,0 +1,236 @@
+/*
+
+M4cs Keymap for dekuNukem/duckyPad QMK firmware
+
+Copyright (C) 2020 Max Bridgland
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#include QMK_KEYBOARD_H
+
+#include "stdio.h"
+#include <unistd.h>
+#include <string.h>
+
+#define LOGO_SIZE 384
+
+bool rgbToggled = false;
+bool altToggled = false;
+
+enum layer_codes {
+  RGB_LAYER = SAFE_RANGE,
+  ALT_LAYER
+};
+
+enum my_keycodes {
+    Z0 = SAFE_RANGE, Z1, Z2,
+    Z3, Z4, Z5,
+    Z6, Z7, Z8,
+    Z9, Z10, Z11,
+    Z12, Z13, Z14
+};
+
+#define MAC_1 LCTL(LALT(KC_MINS))
+#define MAC_2 LCTL(LALT(KC_EQL))
+#define MAC_3 LCTL(LALT(KC_LBRC))
+#define MAC_4 LCTL(LALT(KC_RBRC))
+#define MAC_5 LCTL(LALT(KC_BSLS))
+#define MAC_6 LCTL(LALT(KC_SCLN))
+#define MAC_7 LCTL(LALT(KC_QUOT))
+#define MAC_8 LCTL(LALT(KC_COMM))
+#define MAC_9 LCTL(LALT(KC_SLSH))
+
+#define MAC_10 LCTL(LSFT(KC_MINS))
+#define MAC_11 LCTL(LSFT(KC_EQL))
+#define MAC_12 LCTL(LSFT(KC_SLSH))
+#define MAC_13 LCTL(LSFT(KC_LBRC))
+#define MAC_14 LCTL(LSFT(KC_RBRC))
+#define MAC_15 LCTL(LSFT(KC_BSLS))
+#define MAC_16 LCTL(LSFT(KC_SCLN))
+#define MAC_17 LCTL(LSFT(KC_QUOT))
+#define MAC_18 LCTL(LSFT(KC_COMM))
+
+#define _DEFAULT 0
+#define _RGB 1
+#define _ALT 2
+
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  /*
+  ,=========================================.
+  | Media Prev. | Media Play  | Media Next  |
+  |=========================================|
+  | Mute Sound  | Volume Do.  | Volume Up   |
+  |=========================================|
+  | Macro 1     | Macro 2     | Macro 3     |
+  |=========================================|
+  | Macro 4     | Macro 5     | Macro 6     |
+  |=========================================| ,---------------------.
+  | Macro 7     | Macro 8     | Macro 9     | | RGB Menu | Alt Menu |
+  `=========================================' `--------------------'
+  */
+  [_DEFAULT] = LAYOUT(
+      KC_MEDIA_PREV_TRACK, KC_MEDIA_PLAY_PAUSE, KC_MEDIA_NEXT_TRACK,
+      KC_AUDIO_MUTE, KC_AUDIO_VOL_DOWN, KC_AUDIO_VOL_UP,
+      MAC_1, MAC_2, MAC_3,
+      MAC_4, MAC_5, MAC_6,
+      MAC_7, MAC_8, MAC_9,
+      RGB_LAYER, ALT_LAYER
+  ),
+  /*
+  ,=========================================.
+  | Plain RGB   | Breathe RGB | Rainbow RGB |
+  |=========================================|
+  | Swirl RGB   | Speed Down  | Speed Up    |
+  |=========================================|
+  | Effect Up   | Sat. Down   | Sat. Up     |
+  |=========================================|
+  | Effect Down | Hue Down    | Hue Up      |
+  |=========================================| ,----------------------.
+  | Toggle RGB  | Brt. Down   | Brt. Up     | | Norm Menu | Alt Menu |
+  `=========================================' `---------------------'
+  */
+  [_RGB] = LAYOUT(
+      RGB_MODE_PLAIN, RGB_MODE_BREATHE, RGB_MODE_RAINBOW,
+      RGB_MODE_SWIRL, RGB_SPD, RGB_SPI,
+      RGB_MOD, RGB_SAD, RGB_SAI,
+      RGB_RMOD, RGB_HUD, RGB_HUI,
+      RGB_TOG, RGB_VAD, RGB_VAI,
+      RGB_LAYER, ALT_LAYER
+  ),
+  /*
+  ,=========================================.
+  | Macro 10    | Macro 11    | Macro 12    |
+  |=========================================|
+  | Undo        | Cut         | Copy        |
+  |=========================================|
+  | Paste       | Find        | Prnt Scrn.  |
+  |=========================================|
+  | Macro 13    | Macro 14    | Macro 15    |
+  |=========================================| ,----------------------.
+  | Macro 16    | Macro 17    | Macro 18    | | Norm Menu | Alt Menu |
+  `=========================================' `---------------------'
+  */
+  [_ALT] = LAYOUT(
+      MAC_10, MAC_11, MAC_12,
+      KC_UNDO, KC_CUT, KC_COPY,
+      KC_PASTE, KC_FIND, KC_PSCR,
+      MAC_13, MAC_14, MAC_15,
+      MAC_16, MAC_17, MAC_18,
+      RGB_LAYER, ALT_LAYER
+  )
+};
+
+static void render_logo(void) {
+   static const char PROGMEM ducky_logo[LOGO_SIZE] = {
+      0, 0, 0, 0,128,128,128,128,128, 0, 0,252,252,252, 0, 0, 0,128,128,128, 0, 0, 0, 0, 0,128,128,128, 0, 0, 0, 0, 0,128,128,128,128,128, 0, 0, 0, 0, 0,252,252,252, 0, 0, 0, 0, 0,128,128,128,128,128,128, 0, 0, 0, 0, 0, 0,128,128,128,128, 0,248,248,248, 56, 56, 56, 56, 56, 56,120,240,224,192, 0, 0,128,128,128,128,128,128, 0, 0, 0, 0, 0, 0, 0, 0,128,128,128,128,128, 0, 0,252,252,252, 0, 0, 0, 0, 0,232, 24, 24,232, 0, 24, 48, 48, 24, 0,232, 24, 24,232, 0, 0,
+      0,248,254,255,143, 7, 3, 3, 3, 7,142,255,255,255, 0, 0, 0,255,255,255, 0, 0, 0, 0, 0,255,255,255, 0,248,254,255,143, 7, 3, 3, 3, 3,143, 7, 2, 0, 0,255,255,255,240,120,252,254,231,131, 1, 0, 1, 7, 63,254,240,192, 0,224,252,127, 31, 3, 0, 0,255,255,255,112,112,112,112,112,112, 56, 63, 31, 15,193,231,243,115, 51, 51, 51, 55,255,255,252, 0, 0,248,254,255,143, 7, 3, 3, 3, 7,142,255,255,255, 0, 0, 0, 0, 0, 21,127,127,252,252,252,253,253,252,252,252,255,255,255, 0, 0,
+      0, 0, 3, 7, 15, 15, 14, 14, 14, 7, 3, 15, 15, 15, 0, 0, 0, 3, 7, 15, 15, 14, 14, 6, 3, 15, 15, 15, 0, 0, 3, 7, 7, 15, 14, 14, 14, 14, 7, 7, 2, 0, 0, 15, 15, 15, 0, 0, 0, 1, 3, 15, 15, 12,136,224,224,224,247,127,127, 31, 3, 0, 0, 0, 0, 0, 15, 15, 15, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 7, 15, 14, 14, 14, 6, 3, 15, 15, 15, 0, 0, 0, 3, 7, 15, 15, 14, 14, 14, 7, 3, 15, 15, 15, 0, 0, 0, 0, 0, 0, 0, 0, 0, 8, 7, 11, 3, 11, 7, 11, 7, 7, 31, 0, 0
+   };
+   oled_write_raw_P(ducky_logo, LOGO_SIZE);
+}
+
+char* make_menu_text(void){
+  char *s = malloc((30 * 3) * sizeof(*s));
+  int width = 3;
+  sprintf(s, "%-*s %-*s %-*s\n%-*s %-*s %-*s\n%-*s %-*s %-*s\n%-*s %-*s %-*s\n%-*s %-*s %-*s",
+    width, MT_0_0, width, MT_0_1, width, MT_0_2,
+    width, MT_0_3, width, MT_0_4, width, MT_0_5,
+    width, MT_0_6, width, MT_0_7, width, MT_0_8,
+    width, MT_0_9, width, MT_0_10, width,MT_0_11,
+    width, MT_0_12, width, MT_0_13, width, MT_0_14
+  );
+  return s;
+};
+
+char* make_rgb_text(void){
+  char *s = malloc((30 * 3) * sizeof(*s));
+  int width = 3;
+  sprintf(
+    s, "%-*s %-*s %-*s\n%-*s %-*s %-*s\n%-*s %-*s %-*s\n%-*s %-*s %-*s\n%-*s %-*s %-*s",
+    width, MT_1_0, width, MT_1_1, width, MT_1_2,
+    width, MT_1_3, width, MT_1_4, width, MT_1_5,
+    width, MT_1_6, width, MT_1_7, width, MT_1_8,
+    width, MT_1_9, width, MT_1_10, width,MT_1_11,
+    width, MT_1_12, width, MT_1_13, width, MT_1_14
+  );
+  return s;
+};
+
+char* make_alt_text(void){
+  char *s = malloc((30 * 3) * sizeof(*s));
+  int width = 3;
+  sprintf(
+    s, "%-*s %-*s %-*s\n%-*s %-*s %-*s\n%-*s %-*s %-*s\n%-*s %-*s %-*s\n%-*s %-*s %-*s",
+    width, MT_2_0, width, MT_2_1, width, MT_2_2,
+    width, MT_2_3, width, MT_2_4, width, MT_2_5,
+    width, MT_2_6, width, MT_2_7, width, MT_2_8,
+    width, MT_2_9, width, MT_2_10, width,MT_2_11,
+    width, MT_2_12, width, MT_2_13, width, MT_2_14
+  );
+  return s;
+};
+
+void oled_task_user(void) {
+  render_logo();
+  oled_set_cursor(0,3);
+  if (rgbToggled) {
+    char *s = make_rgb_text();
+    oled_write_ln_P(s, false);
+    free(s);
+  } else if (altToggled) {
+    char *s = make_alt_text();
+    oled_write_ln_P(s, false);
+    free(s);
+  } else {
+    char *s = make_menu_text();
+    oled_write_ln_P(s, false);
+    free(s);
+  }
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  switch (keycode) {
+    case RGB_LAYER:
+      if (record->event.pressed) {
+        if (rgbToggled) {
+          rgbToggled = false;
+          altToggled = false;
+          layer_clear();
+        } else {
+          rgbToggled = true;
+          altToggled = false;
+          layer_on(_RGB);
+        }
+      }
+      return false;
+    case ALT_LAYER:
+      if (record->event.pressed) {
+        if (altToggled) {
+          rgbToggled = false;
+          altToggled = false;
+          layer_clear();
+        } else {
+          rgbToggled = false;
+          altToggled = true;
+          layer_on(_ALT);
+        }
+      }
+      return false;
+    default:
+      return true;
+  }
+  return false;
+}
diff --git a/keyboards/dekunukem/duckypad/keymaps/m4cs/readme.md b/keyboards/dekunukem/duckypad/keymaps/m4cs/readme.md
new file mode 100644
index 0000000000..42fae00440
--- /dev/null
+++ b/keyboards/dekunukem/duckypad/keymaps/m4cs/readme.md
@@ -0,0 +1,25 @@
+[M4cs'](https://github.com/M4cs) duckyPad Layout
+
+### Layers:
+
+0: Default Layer w/ Media Functionality and Macros
+
+1: RGB Menu that allows RGB customization
+
+2: Alternate Macro Menu
+
+### Configuration:
+
+To change the menu, edit the `MT_X_XX` values in `config.h`. The sytax is as follows: `MT_A_B`, where A equals the layer, and B equals the key from 0-14.
+
+### Misc. Info:
+
+The macros currently just map to Ctrl + Alt + (Different Keys) right now. I have them launching certain shortcuts. I recommend you change these and add your shortcuts to match your shortcut manager.
+
+### Need Help?
+
+Contact me on discord: macs#0420
+
+or join the duckyPad Discord and find me in there :)
+
+https://discord.gg/ADtrCjf
\ No newline at end of file
diff --git a/keyboards/dekunukem/duckypad/keymaps/m4cs/rules.mk b/keyboards/dekunukem/duckypad/keymaps/m4cs/rules.mk
new file mode 100644
index 0000000000..8706546668
--- /dev/null
+++ b/keyboards/dekunukem/duckypad/keymaps/m4cs/rules.mk
@@ -0,0 +1,2 @@
+LTO_ENABLE = yes # Enable Link Time Optimization
+NO_USB_STARTUP_CHECK = yes # Disables usb suspend check after keyboard startup