Palleiko's Keymap (#3096)

* cloned default layout to palleiko

* Added NAV layer, removed steno

* Added WM layout & Readme

* forgot comma

* Specify bootloader

* Fixed Mod Tap / Layer Tap bugs and updated readme

* Removed Layer Tap functionality

* KC_NO

* Updated Readme

4 files changed, 407 insertions, 0 deletions

diff --git a/keyboards/planck/keymaps/palleiko/config.h b/keyboards/planck/keymaps/palleiko/config.h
new file mode 100644
index 0000000000..a1635f2bab
--- /dev/null
+++ b/keyboards/planck/keymaps/palleiko/config.h
@@ -0,0 +1,42 @@
+#ifndef CONFIG_USER_H
+#define CONFIG_USER_H
+
+#include "config_common.h"
+
+#ifdef AUDIO_ENABLE
+    #define STARTUP_SONG SONG(PLANCK_SOUND)
+    // #define STARTUP_SONG SONG(NO_SOUND)
+
+    #define DEFAULT_LAYER_SONGS { SONG(QWERTY_SOUND), \
+                                  SONG(COLEMAK_SOUND), \
+                                  SONG(DVORAK_SOUND) \
+                                }
+#endif
+
+#define MUSIC_MASK (keycode != KC_NO)
+
+/*
+ * MIDI options
+ */
+
+/* Prevent use of disabled MIDI features in the keymap */
+//#define MIDI_ENABLE_STRICT 1
+
+/* enable basic MIDI features:
+   - MIDI notes can be sent when in Music mode is on
+*/
+                                
+#define MIDI_BASIC
+
+/* enable advanced MIDI features:
+   - MIDI notes can be added to the keymap
+   - Octave shift and transpose
+   - Virtual sustain, portamento, and modulation wheel
+   - etc.
+*/
+//#define MIDI_ADVANCED
+
+/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
+//#define MIDI_TONE_KEYCODE_OCTAVES 2
+
+#endif
\ No newline at end of file
diff --git a/keyboards/planck/keymaps/palleiko/keymap.c b/keyboards/planck/keymaps/palleiko/keymap.c
new file mode 100644
index 0000000000..603a6edbab
--- /dev/null
+++ b/keyboards/planck/keymaps/palleiko/keymap.c
@@ -0,0 +1,300 @@
+/* Copyright 2015-2018 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/>.
+ *
+ * Palleiko Layout
+ */
+
+#include "planck.h"
+#include "action_layer.h"
+
+extern keymap_config_t keymap_config;
+
+enum planck_layers {
+  _QWERTY,
+  _COLEMAK,
+  _DVORAK,
+  _LOWER,
+  _RAISE,
+  _NAV,
+  _NUM,
+  _WM,
+  _ADJUST
+};
+
+enum planck_keycodes {
+  QWERTY = SAFE_RANGE,
+  COLEMAK,
+  DVORAK,
+  LOWER,
+  RAISE,
+  NAV,
+  WM,
+  NUM
+};
+
+// i3 Binds
+#define WM_1 LALT(KC_1)
+#define WM_2 LALT(KC_2)
+#define WM_3 LALT(KC_3)
+#define WM_4 LALT(KC_4)
+#define WM_5 LALT(KC_5)
+#define WM_6 LALT(KC_6)
+#define WM_7 LALT(KC_7)
+#define WM_8 LALT(KC_8)
+#define WM_9 LALT(KC_9)
+#define WM_0 LALT(KC_0)
+
+// Transparent Key
+#define _______ KC_TRNS
+// NOP
+#define ___x___ KC_NO
+
+// MT Shift & Enter
+#define S_ENT MT(MOD_RSFT, KC_ENT)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+/* Qwerty
+ * ,-----------------------------------------------------------------------------------.
+ * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Ctrl |  NUM | NAV  | Alt  |Lower |    Space    |Raise | NAV  | GUI  |  NUM |  WM  |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_QWERTY] = {
+  {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
+  {KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
+  {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, S_ENT  },
+  {KC_LCTL, NUM,     NAV,     KC_LALT, LOWER,   KC_SPC,  KC_SPC,  RAISE,   NAV,     KC_RGUI, NUM,     WM}
+},
+
+/* Colemak
+ * ,-----------------------------------------------------------------------------------.
+ * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Ctrl |  NUM | NAV  | Alt  |Lower |    Space    |Raise | NAV  | GUI  |  NUM |  WM  |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_COLEMAK] = {
+  {KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
+  {KC_ESC,  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
+  {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, S_ENT  },
+  {KC_LCTL, NUM,     NAV,     KC_LALT, LOWER,   KC_SPC,  KC_SPC,  RAISE,   NAV,     KC_RGUI, NUM,     WM}
+},
+
+/* Dvorak
+ * ,-----------------------------------------------------------------------------------.
+ * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Ctrl |  NUM | NAV  | Alt  |Lower |    Space    |Raise | NAV  | GUI  |  NUM |  WM  |
+ * `----------------------------------------------------------------------------------'
+ */
+[_DVORAK] = {
+  {KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
+  {KC_ESC,  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH},
+  {KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT },
+  {KC_LCTL, NUM,     NAV,     KC_LALT, LOWER,   KC_SPC,  KC_SPC,  RAISE,   NAV,     KC_RGUI, NUM,     WM}
+},
+
+/* Lower
+ * ,-----------------------------------------------------------------------------------.
+ * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Del  |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | | Home | End  |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_LOWER] = {
+  {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR,    KC_ASTR,    KC_LPRN, KC_RPRN, KC_BSPC},
+  {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS,    KC_PLUS,    KC_LCBR, KC_RCBR, KC_PIPE},
+  {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  S(KC_NUHS), S(KC_NUBS), KC_HOME, KC_END,  _______},
+  {_______, _______, _______, _______, _______, _______, _______, _______,    KC_MNXT,    KC_VOLD, KC_VOLU, KC_MPLY}
+},
+
+/* Raise
+ * ,-----------------------------------------------------------------------------------.
+ * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Del  |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |Pg Up |Pg Dn |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_RAISE] = {
+  {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
+  {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
+  {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, _______},
+  {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
+},
+
+/* Hex Numpad
+ * ,-----------------------------------------------------------------------------------.
+ * |      |      |      |   {  |   }  |   A  |  B   |   7  |   8  |   9  |      |      |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * |  NUM |      |      |   (  |   )  |   C  |  D   |   4  |   5  |   6  |      |      |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |      |      |   [  |   ]  |   E  |  F   |   1  |   2  |   3  |      |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      |   0  |      |      |      |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_NUM] = {
+  {_______, ___x___, ___x___, KC_LCBR, KC_RCBR, KC_A,    KC_B,    KC_7,    KC_8,    KC_9,    ___x___, _______},
+  {_______, ___x___, ___x___, KC_LPRN, KC_RPRN, KC_C,    KC_D,    KC_4,    KC_5,    KC_6,    ___x___, _______},
+  {_______, ___x___, ___x___, KC_LBRC, KC_RBRC, KC_E,    KC_F,    KC_1,    KC_2,    KC_3,    ___x___, _______},
+  {_______, _______, _______, _______, _______, _______, _______, _______, KC_0,    _______, _______, _______}
+},
+
+/* WM (i3 window binds)
+ * ,-----------------------------------------------------------------------------------.
+ * |      | WM1  | WM2  | WM3  | WM4  | WM5  | WM6  | WM7  | WM8  | WM9  | WM0  |      |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * |      |      |      |      |      |             | WM6  | WM5  | WM4  |      |      |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |      |      |      |      |             | WM1  | WM2  | WM3  |      |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      | WM0  |      |      |      |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_WM] = {
+  {_______, WM_1,    WM_2,    WM_3,    WM_4,    WM_5,    WM_6,    WM_7,    WM_8,    WM_9,    WM_0,    _______},
+  {_______, _______, _______, _______, _______, _______, _______, WM_4,    WM_5,    WM_6,    _______, _______},
+  {_______, _______, _______, _______, _______, _______, _______, WM_1,    WM_2 ,   WM_3,    _______, _______},
+  {_______, _______, _______, _______, _______, _______, _______, _______, WM_0,    _______, _______, _______}
+},
+
+/* Navigation Layer (Vim-like arrow binds & i3 binds)
+ * ,-----------------------------------------------------------------------------------.
+ * |      |      |      |      |      |             |      |      |      |      |      |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * |      |      |      |      |      |        LEFT | DOWN |  UP  | RIGHT|  NAV |      |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      |      |      |      |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      |      |      |      |      |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_NAV] = {
+  {___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___},
+  {___x___, ___x___, ___x___, ___x___, ___x___, ___x___, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, ___x___, ___x___},
+  {_______, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___},
+  {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
+},
+
+/* Adjust (Lower + Raise)
+ * ,-----------------------------------------------------------------------------------.
+ * |      |      |      |      |      |      |      |      |      |      |      |  Del |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * |      |      |      |      |      |AGnorm|AGswap|Qwerty|Colemk|Dvorak|      |      |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |      |      |Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Reset| Debug|      |      |      |             |      |      |      |      |      |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_ADJUST] = {
+  {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL },
+  {_______, _______, _______, _______, _______, AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  _______, _______},
+  {_______, _______, _______, MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
+  {RESET,   DEBUG,   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
+}
+
+};
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  switch (keycode) {
+    case QWERTY:
+      if (record->event.pressed) {
+        print("mode just switched to qwerty and this is a huge string\n");
+        set_single_persistent_default_layer(_QWERTY);
+      }
+      return false;
+      break;
+    case COLEMAK:
+      if (record->event.pressed) {
+        set_single_persistent_default_layer(_COLEMAK);
+      }
+      return false;
+      break;
+    case DVORAK:
+      if (record->event.pressed) {
+        set_single_persistent_default_layer(_DVORAK);
+      }
+      return false;
+      break;
+    case LOWER:
+      if (record->event.pressed) {
+        layer_on(_LOWER);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      } else {
+        layer_off(_LOWER);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      }
+      return false;
+      break;
+    case RAISE:
+      if (record->event.pressed) {
+        layer_on(_RAISE);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      } else {
+        layer_off(_RAISE);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      }
+      return false;
+      break;
+    case NUM:
+      if (record->event.pressed) {
+        layer_on(_NUM);
+      } else {
+        layer_off(_NUM);
+      }
+      return false;
+      break;
+    case NAV:
+      if (record->event.pressed) {
+        layer_on(_NAV);
+      } else {
+        layer_off(_NAV);
+      }
+      return false;
+      break;
+    case WM:
+      if (record->event.pressed) {
+        layer_on(_WM);
+      } else {
+        layer_off(_WM);
+      }
+      return false;
+      break;
+    }
+  return true;
+}
diff --git a/keyboards/planck/keymaps/palleiko/readme.md b/keyboards/planck/keymaps/palleiko/readme.md
new file mode 100644
index 0000000000..d8c70a6526
--- /dev/null
+++ b/keyboards/planck/keymaps/palleiko/readme.md
@@ -0,0 +1,63 @@
+# Palleiko's Layout
+---
+
+This layout is mostly stock with a increased functionality for my usage.
+
+Changes over stock keymap:
+1. Altered R1 
+1. Home row navigation layer
+1. Hexadecimal numpad layer
+1. Window manager layer for my i3 setup
+
+All-in-all, anyone used to the standard map would have no problem using this.
+
+### QWERTY Keymap & Addded Layers
+##### Qwerty
+```
+Hold Enter for Right Shift
+,-----------------------------------------------------------------------------------.
+| Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+| Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   | 
+|------+------+------+------+------+------|------+------+------+------+------+------|
+| Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Ctrl |  NUM | NAV  | Alt  |Lower |    Space    |Raise | NAV  | GUI  |  NUM |  WM  |
+`-----------------------------------------------------------------------------------'
+```
+##### Hex Numpad
+```
+,-----------------------------------------------------------------------------------.
+|      |      |      |   {  |   }  |   A  |  B   |   7  |   8  |   9  |      |      |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+| _NUM |      |      |   (  |   )  |   C  |  D   |   4  |   5  |   6  |      |      |
+|------+------+------+------+------+------|------+------+------+------+------+------|
+|      |      |      |   [  |   ]  |   E  |  F   |   1  |   2  |   3  |      |      |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+|      |      |      |      |      |             |      |   0  |      |      |      |
+`-----------------------------------------------------------------------------------'
+```
+##### WM (i3 window binds)
+```
+,-----------------------------------------------------------------------------------.
+|      | WM1  | WM2  | WM3  | WM4  | WM5  | WM6  | WM7  | WM8  | WM9  | WM0  |      |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+|      |      |      |      |      |             | WM6  | WM5  | WM4  |      |      |
+|------+------+------+------+------+------|------+------+------+------+------+------|
+|      |      |      |      |      |             | WM1  | WM2  | WM3  |      |      |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+|      |      |      |      |      |             |      | WM0  |      |      | _WM  |
+`-----------------------------------------------------------------------------------'
+```
+##### Navigation Layer (Vim-like arrow binds & i3 binds)
+```
+,-----------------------------------------------------------------------------------.
+|      |      |      |      |      |      |      |      |      |      |      |      |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+|      |      |      |      |      |      | LEFT | DOWN |  UP  | RIGHT|      |      |
+|------+------+------+------+------+------|------+------+------+------+------+------|
+|      |      |      |      |      |      |      |      |      |      |      |      |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+|      | _NAV |      |      |      |             |      |      |      | _NAV |      |
+`-----------------------------------------------------------------------------------'
+```
diff --git a/keyboards/planck/keymaps/palleiko/rules.mk b/keyboards/planck/keymaps/palleiko/rules.mk
new file mode 100644
index 0000000000..d5ff6cd3ba
--- /dev/null
+++ b/keyboards/planck/keymaps/palleiko/rules.mk
@@ -0,0 +1,2 @@
+# Atmel ATMEGA23U4 Bootloader
+BOOTLOADER = atmel-dfu