[Keyboard] Adding RGBKB Zygomorph Keyboard (#5841)

* Initial Zygomorph 5x6 code

Split is not working yet

* layout changes

implement 4 row config option (not done yet), remove layout comments in layout.c

* Zygomorph layouts for 5x12, 5x6, 4x12, and 4x6

Also, info.json *should* be nearly usable
 for the configurator

* temporary fix for pin D5 being broken

* show D5 issue comment

* add build notes

* Pin B7 broken in split why?

* remove fix

* Fix some pin assignments

* begin to fix keymap

* Create new 5x6 layout

* update key positions

* Initial Zygomorph 5x6 code

Split is not working yet

* layout changes

implement 4 row config option (not done yet), remove layout comments in layout.c

* Zygomorph layouts for 5x12, 5x6, 4x12, and 4x6

Also, info.json *should* be nearly usable
 for the configurator

* temporary fix for pin D5 being broken

* show D5 issue comment

* add build notes

* Pin B7 broken in split why?

* remove fix

* Fix some pin assignments

* begin to fix keymap

* Create new 5x6 layout

* Rough first pass at split common conversion.
Keymap cleanup to cover just the basics.
Broke OLED code out into separate example.

* Fix readme

* Removal of old encoder / oled driver, fix for layout macros

* small update

* xulkal zygomorph keymaps

* Removed the LED_MIRRORED option as leds are always mirrored on Zygomorph

* Xulkal keymaps update

* split rgb light support

* fix line endings

* Apply suggestions from code review

Co-Authored-By: zvecr <git@zvecr.com>

* More layout and compile fixes from pr review

* Cleaning up rules.mk files

* Apply suggestions from code review

Co-Authored-By: zvecr <git@zvecr.com>

* Updating defaults

* Apply suggestions from code review

Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>

3 files changed, 154 insertions, 0 deletions

diff --git a/keyboards/zygomorph/keymaps/xulkal/config.h b/keyboards/zygomorph/keymaps/xulkal/config.h
new file mode 100644
index 000000000..452cdda82
--- /dev/null
+++ b/keyboards/zygomorph/keymaps/xulkal/config.h
@@ -0,0 +1,25 @@
+/*
+This is the c configuration file for the keymap
+
+Copyright 2012 Jun Wako <wakojun@gmail.com>
+Copyright 2015 Jack Humbert
+
+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 2 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
+
+
+// place overrides here
+
diff --git a/keyboards/zygomorph/keymaps/xulkal/keymap.c b/keyboards/zygomorph/keymaps/xulkal/keymap.c
new file mode 100644
index 000000000..f886cb454
--- /dev/null
+++ b/keyboards/zygomorph/keymaps/xulkal/keymap.c
@@ -0,0 +1,87 @@
+#include QMK_KEYBOARD_H
+#include "xulkal.h"
+
+#ifdef PROTOCOL_LUFA
+#include "lufa.h"
+#include "split_util.h"
+#endif
+
+#define EXPAND_LAYOUT(...) LAYOUT_ortho_5x12(__VA_ARGS__)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+    /*  / QWERTY \
+   * /-----------------------------------------\  /-----------------------------------------\
+   * | GESC |   1  |   2  |  3   |  4   |  5   |  |  6   |  7   |  8   |  9   |  0   | BkSp |
+   * |------+------+------+------+------+------|  |------+------+------+------+------+------|
+   * | Tab  |   Q  |   W  |  E   |  R   |  T   |  |  Y   |  U   |  I   |  O   |  P   |   \  |
+   * |------+------+------+------+------+------|  |------+------+------+------+------+------|
+   * |FN(CAPS)| A  |   S  |   D  |  F   |  G   |  |  H   |  J   |  K   |  L   |  ;   | Enter|
+   * |------+------+------+------+------+------|  |------+------+------+------+------+------|
+   * | Sft[ |   Z  |   X  |   C  |  V   |  B   |  |  N   |  M   |  ,   |  .   |  /   | Sft] |
+   * |------+------+------+------+------+------|  |------+------+------+------+------+------|
+   * | Ctl- |  Win | LOWER| RAISE| Alt  | Space|  | Space| Left |  Up  | Down | Right| Ctl= |
+   * \------+------+------+------+------+------/  \------+------+------+------+------+------/
+   */
+  [_QWERTY] = EXPAND_LAYOUT( \
+    _________________QWERTY_L1_________________,  _________________QWERTY_R1_________________, \
+    _________________QWERTY_L2_________________,  _________________QWERTY_R2_________________, \
+    _________________QWERTY_L3_________________,  _________________QWERTY_R3_________________, \
+    _________________QWERTY_L4_________________,  _________________QWERTY_R4_________________, \
+    _________________QWERTY_L5_________________,  _________________QWERTY_R5_________________ \
+  ),
+
+#ifndef GAMELAYER_DISABLE
+  [_GAME] = EXPAND_LAYOUT( \
+    ___________________GAME_L1_________________,  ___________________GAME_R1_________________, \
+    ___________________GAME_L2_________________,  ___________________GAME_R2_________________, \
+    ___________________GAME_L3_________________,  ___________________GAME_R3_________________, \
+    ___________________GAME_L4_________________,  ___________________GAME_R4_________________, \
+    ___________________GAME_L5_________________,  ___________________GAME_R5_________________ \
+  ),
+#endif
+
+  [_LOWER] =  EXPAND_LAYOUT( \
+    __________________LOWER_L1_________________,  __________________LOWER_R1_________________, \
+    __________________LOWER_L2_________________,  __________________LOWER_R2_________________, \
+    __________________LOWER_L3_________________,  __________________LOWER_R3_________________, \
+    __________________LOWER_L4_________________,  __________________LOWER_R4_________________, \
+    __________________LOWER_L5_________________,  __________________LOWER_R5_________________ \
+  ),
+
+  [_RAISE] = EXPAND_LAYOUT( \
+    __________________RAISE_L1_________________,  __________________RAISE_R1_________________, \
+    __________________RAISE_L2_________________,  __________________RAISE_R2_________________, \
+    __________________RAISE_L3_________________,  __________________RAISE_R3_________________, \
+    __________________RAISE_L4_________________,  __________________RAISE_R4_________________, \
+    __________________RAISE_L5_________________,  __________________RAISE_R5_________________ \
+  ),
+
+#ifdef TRILAYER_ENABLED
+  [_ADJUST] = EXPAND_LAYOUT( \
+    _________________ADJUST_L1_________________,  _________________ADJUST_R1_________________, \
+    _________________ADJUST_L2_________________,  _________________ADJUST_R2_________________, \
+    _________________ADJUST_L3_________________,  _________________ADJUST_R3_________________, \
+    _________________ADJUST_L4_________________,  _________________ADJUST_R4_________________, \
+    _________________ADJUST_L5_________________,  _________________ADJUST_R5_________________ \
+  ),
+#endif
+};
+
+#ifdef ENCODER_ENABLE
+void encoder_update_user(uint8_t index, bool clockwise) {
+  if (index == 0) { /* First encoder */
+    if (clockwise) {
+      tap_code(KC_PGDN);
+    } else {
+      tap_code(KC_PGUP);
+    }
+  } else if (index == 1) { /* Second encoder from slave */
+    if (clockwise) {
+      tap_code(KC_UP);
+    } else {
+      tap_code(KC_DOWN);
+    }
+  }
+}
+#endif
diff --git a/keyboards/zygomorph/keymaps/xulkal/rules.mk b/keyboards/zygomorph/keymaps/xulkal/rules.mk
new file mode 100644
index 000000000..dc687cbbd
--- /dev/null
+++ b/keyboards/zygomorph/keymaps/xulkal/rules.mk
@@ -0,0 +1,42 @@
+# Build Options
+#   change to "no" to disable the options, or define them in the Makefile in
+#   the appropriate keymap folder that will get included automatically
+#
+
+MOUSEKEY_ENABLE = no        # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = no         # Console for debug
+COMMAND_ENABLE = no         # Commands for debug and configuration
+NKRO_ENABLE = no            # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+RGBLIGHT_ENABLE = yes       # Enable global lighting effects. Do not enable with RGB Matrix
+RGBLIGHT_ANIMATIONS = yes   # LED animations
+RGBLIGHT_SPLIT_ENABLE = yes # Split RGBLight Support
+RGB_MATRIX_ENABLE = no      # Enable per-key coordinate based RGB effects. Do not enable with RGBlight
+RGB_MATRIX_KEYPRESSES = no  # Enable reactive per-key effects.
+RGBLIGHT_FULL_POWER = yes   # Allow maximum RGB brightness. Otherwise, limited to a safe level for a normal USB-A port
+UNICODE_ENABLE = no         # Unicode
+SWAP_HANDS_ENABLE = no      # Enable one-hand typing
+ENCODER_ENABLE = no         # Enable rotary encoder
+OLED_DRIVER_ENABLE = no     # Enable the OLED Driver
+IOS_DEVICE_ENABLE = no      # Limit max brightness to connect to IOS device (iPad,iPhone)
+LINK_TIME_OPTIMIZATION_ENABLE = no      # Enable optimizations to reduce firmware size. Also disables action macros and functions.
+
+# Do not edit past here
+
+ifeq ($(strip $(IOS_DEVICE_ENABLE)), yes)
+    OPT_DEFS += -DIOS_DEVICE_ENABLE
+else ifeq ($(strip $(RGBLIGHT_FULL_POWER)), yes)
+    OPT_DEFS += -DRGBLIGHT_FULL_POWER
+endif
+
+ifeq ($(strip $(RGB_MATRIX_KEYPRESSES)), yes)
+    OPT_DEFS += -DRGB_MATRIX_KEYPRESSES
+endif
+
+ifeq ($(strip $(RGBLIGHT_ANIMATIONS)), yes)
+    OPT_DEFS += -DRGBLIGHT_ANIMATIONS
+endif
+
+ifeq ($(strip $(RGBLIGHT_SPLIT_ENABLE)), yes)
+    OPT_DEFS += -DRGBLIGHT_SPLIT_ENABLE
+endif