Keymap: Add unagi planck keymap (#3527)

* modifications to add mouse buttons 1-4 and misc * Add khord chocopad keymap * fix merge message * Add unagi keymap * Add readme for unagi planck keymap * Replace boilerplate for unagi keymap
author: Dylan Khor <thekhord@gmail.com> 2018-07-31 20:48:41 -0400
committer: Drashna Jaelre <drashna@live.com> 2018-07-31 17:48:41 -0700
commit: cbf200e9dd39138f053368835e9af2069f7c1902 (patch)
tree: 7904c977689e77974d189a074b697d4a7c7758c1
parent: 2bc34b09cd71fc79269243712f3b6bf341169494 (diff)
download: qmk_firmware-cbf200e9dd39138f053368835e9af2069f7c1902.tar.gz
qmk_firmware-cbf200e9dd39138f053368835e9af2069f7c1902.zip
4 files changed, 398 insertions, 0 deletions
diff --git a/keyboards/planck/keymaps/unagi/config.h b/keyboards/planck/keymaps/unagi/config.h
new file mode 100644
index 000000000..9cd2f4a53
--- /dev/null
+++ b/keyboards/planck/keymaps/unagi/config.h
@@ -0,0 +1,41 @@
+#pragma
+#ifdef AUDIO_ENABLE
+    #define STARTUP_SONG SONG(SONIC_RING)
+    // #define STARTUP_SONG SONG(NO_SOUND)
+    #define MUSIC_ON_SONG SONG(ZELDA_PUZZLE)
+    #define DEFAULT_LAYER_SONGS { SONG(QWERTY_SOUND), \
+                                  SONG(COLEMAK_SOUND), \
+                                  SONG(DVORAK_SOUND) \
+                                }
+#endif
+#define TAPPING_TERM 200
+/*
+ * 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
+// Most tactile encoders have detents every 4 stages
+#define ENCODER_RESOLUTION 4
diff --git a/keyboards/planck/keymaps/unagi/keymap.c b/keyboards/planck/keymaps/unagi/keymap.c
new file mode 100644
index 000000000..596973ba3
--- /dev/null
+++ b/keyboards/planck/keymaps/unagi/keymap.c
@@ -0,0 +1,347 @@
+/* Copyright 2015-2017 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/>.
+ */
+#include QMK_KEYBOARD_H
+#include "muse.h"
+extern keymap_config_t keymap_config;
+enum planck_layers {
+  _QWERTY,
+  _COLEMAK,
+  _DVORAK,
+  _LOWER,
+  _RAISE,
+  _PLOVER,
+  _ADJUST
+};
+enum planck_keycodes {
+  QWERTY = SAFE_RANGE,
+  COLEMAK,
+  DVORAK,
+  PLOVER,
+  BACKLIT,
+  EXT_PLV
+};
+// Tap Dance Declarations
+enum {
+  SFT_CAP = 0
+};
+#define LOWER MO(_LOWER)
+#define RAISE MO(_RAISE)
+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 |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_QWERTY] = LAYOUT_planck_grid(
+    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,
+    TD(SFT_CAP), KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, SFT_T(KC_ENT),
+    BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT
+),
+/* 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 |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_COLEMAK] = LAYOUT_planck_grid(
+    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, KC_ENT ,
+    BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT
+),
+/* 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 |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_DVORAK] = LAYOUT_planck_grid(
+    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 ,
+    BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT
+),
+/* Lower
+ * ,-----------------------------------------------------------------------------------.
+ * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | | Home | End  |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_LOWER] = LAYOUT_planck_grid(
+    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  | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |Pg Up |Pg Dn |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_RAISE] = LAYOUT_planck_grid(
+    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
+),
+/* Plover layer (http://opensteno.org)
+ * ,-----------------------------------------------------------------------------------.
+ * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_PLOVER] = LAYOUT_planck_grid(
+    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   ,
+    XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC,
+    XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,
+    EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX
+),
+/* Adjust (Lower + Raise)
+ * ,-----------------------------------------------------------------------------------.
+ * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      |      |      |      |      |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_ADJUST] = LAYOUT_planck_grid(
+    _______, RESET,   DEBUG,    RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, KC_DEL ,
+    _______, _______, MU_MOD,  AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______,
+    _______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  TERM_ON, TERM_OFF, _______, _______, _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+)
+};
+qk_tap_dance_action_t tap_dance_actions[] = {
+  [SFT_CAP] = ACTION_TAP_DANCE_DOUBLE(KC_LSFT, KC_CAPS)
+};
+#ifdef AUDIO_ENABLE
+  float plover_song[][2]     = SONG(PLOVER_SOUND);
+  float plover_gb_song[][2]  = SONG(PLOVER_GOODBYE_SOUND);
+#endif
+uint32_t layer_state_set_user(uint32_t state) {
+  return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
+}
+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 BACKLIT:
+      if (record->event.pressed) {
+        register_code(KC_RSFT);
+        #ifdef BACKLIGHT_ENABLE
+          backlight_step();
+        #endif
+        #ifdef KEYBOARD_planck_rev5
+          PORTE &= ~(1<<6);
+        #endif
+      } else {
+        unregister_code(KC_RSFT);
+        #ifdef KEYBOARD_planck_rev5
+          PORTE |= (1<<6);
+        #endif
+      }
+      return false;
+      break;
+    case PLOVER:
+      if (record->event.pressed) {
+        #ifdef AUDIO_ENABLE
+          stop_all_notes();
+          PLAY_SONG(plover_song);
+        #endif
+        layer_off(_RAISE);
+        layer_off(_LOWER);
+        layer_off(_ADJUST);
+        layer_on(_PLOVER);
+        if (!eeconfig_is_enabled()) {
+            eeconfig_init();
+        }
+        keymap_config.raw = eeconfig_read_keymap();
+        keymap_config.nkro = 1;
+        eeconfig_update_keymap(keymap_config.raw);
+      }
+      return false;
+      break;
+    case EXT_PLV:
+      if (record->event.pressed) {
+        #ifdef AUDIO_ENABLE
+          PLAY_SONG(plover_gb_song);
+        #endif
+        layer_off(_PLOVER);
+      }
+      return false;
+      break;
+  }
+  return true;
+}
+bool muse_mode = false;
+uint8_t last_muse_note = 0;
+uint16_t muse_counter = 0;
+uint8_t muse_offset = 70;
+uint16_t muse_tempo = 50;
+void encoder_update(bool clockwise) {
+  if (muse_mode) {
+    if (IS_LAYER_ON(_RAISE)) {
+      if (clockwise) {
+        muse_offset++;
+      } else {
+        muse_offset--;
+      }
+    } else {
+      if (clockwise) {
+        muse_tempo+=1;
+      } else {
+        muse_tempo-=1;
+      }
+    }
+  } else {
+    if (clockwise) {
+      register_code(KC_PGDN);
+      unregister_code(KC_PGDN);
+    } else {
+      register_code(KC_PGUP);
+      unregister_code(KC_PGUP);
+    }
+  }
+}
+void dip_update(uint8_t index, bool active) {
+  switch (index) {
+    case 0:
+      if (active) {
+        #ifdef AUDIO_ENABLE
+          PLAY_SONG(plover_song);
+        #endif
+        layer_on(_ADJUST);
+      } else {
+        #ifdef AUDIO_ENABLE
+          PLAY_SONG(plover_gb_song);
+        #endif
+        layer_off(_ADJUST);
+      }
+      break;
+    case 1:
+      if (active) {
+        muse_mode = true;
+      } else {
+        muse_mode = false;
+        #ifdef AUDIO_ENABLE
+          stop_all_notes();
+        #endif
+      }
+   }
+}
+void matrix_scan_user(void) {
+  #ifdef AUDIO_ENABLE
+    if (muse_mode) {
+      if (muse_counter == 0) {
+        uint8_t muse_note = muse_offset + SCALE[muse_clock_pulse()];
+        if (muse_note != last_muse_note) {
+          stop_note(compute_freq_for_midi_note(last_muse_note));
+          play_note(compute_freq_for_midi_note(muse_note), 0xF);
+          last_muse_note = muse_note;
+        }
+      }
+      muse_counter = (muse_counter + 1) % muse_tempo;
+    }
+  #endif
+}
+bool music_mask_user(uint16_t keycode) {
+  switch (keycode) {
+    case RAISE:
+    case LOWER:
+      return false;
+    default:
+      return true;
+  }
+}
diff --git a/keyboards/planck/keymaps/unagi/readme.md b/keyboards/planck/keymaps/unagi/readme.md
new file mode 100644
index 000000000..08477d7ee
--- /dev/null
+++ b/keyboards/planck/keymaps/unagi/readme.md
@@ -0,0 +1,8 @@
+# The Unagi Planck Layout
+This layout is a modified version of the default Planck keymap with the following additions:
+- Double tap left shift for caps lock
+- Hold enter for right shift (enter on-tap)
+- "Sonic Ring" startup tone
+- "Zelda Puzzle" music tone
diff --git a/keyboards/planck/keymaps/unagi/rules.mk b/keyboards/planck/keymaps/unagi/rules.mk
new file mode 100644
index 000000000..5433b3b68
--- /dev/null
+++ b/keyboards/planck/keymaps/unagi/rules.mk
@@ -0,0 +1,2 @@
+SRC += muse.c
+TAP_DANCE_ENABLE = yes
author	Dylan Khor <thekhord@gmail.com>	2018-07-31 20:48:41 -0400
committer	Drashna Jaelre <drashna@live.com>	2018-07-31 17:48:41 -0700
commit	cbf200e9dd39138f053368835e9af2069f7c1902 (patch)
tree	7904c977689e77974d189a074b697d4a7c7758c1
parent	2bc34b09cd71fc79269243712f3b6bf341169494 (diff)
download	qmk_firmware-cbf200e9dd39138f053368835e9af2069f7c1902.tar.gz qmk_firmware-cbf200e9dd39138f053368835e9af2069f7c1902.zip

diff --git a/keyboards/planck/keymaps/unagi/config.h b/keyboards/planck/keymaps/unagi/config.h new file mode 100644 index 000000000..9cd2f4a53 --- /dev/null +++ b/keyboards/planck/keymaps/unagi/config.h
@@ -0,0 +1,41 @@
	1	#pragma
	2
	3	#ifdef AUDIO_ENABLE
	4	#define STARTUP_SONG SONG(SONIC_RING)
	5	// #define STARTUP_SONG SONG(NO_SOUND)
	6	#define MUSIC_ON_SONG SONG(ZELDA_PUZZLE)
	7
	8	#define DEFAULT_LAYER_SONGS { SONG(QWERTY_SOUND), \
	9	SONG(COLEMAK_SOUND), \
	10	SONG(DVORAK_SOUND) \
	11	}
	12	#endif
	13
	14	#define TAPPING_TERM 200
	15
	16	/*
	17	* MIDI options
	18	*/
	19
	20	/* Prevent use of disabled MIDI features in the keymap */
	21	//#define MIDI_ENABLE_STRICT 1
	22
	23	/* enable basic MIDI features:
	24	- MIDI notes can be sent when in Music mode is on
	25	*/
	26
	27	#define MIDI_BASIC
	28
	29	/* enable advanced MIDI features:
	30	- MIDI notes can be added to the keymap
	31	- Octave shift and transpose
	32	- Virtual sustain, portamento, and modulation wheel
	33	- etc.
	34	*/
	35	//#define MIDI_ADVANCED
	36
	37	/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
	38	//#define MIDI_TONE_KEYCODE_OCTAVES 2
	39
	40	// Most tactile encoders have detents every 4 stages
	41	#define ENCODER_RESOLUTION 4


diff --git a/keyboards/planck/keymaps/unagi/keymap.c b/keyboards/planck/keymaps/unagi/keymap.c new file mode 100644 index 000000000..596973ba3 --- /dev/null +++ b/keyboards/planck/keymaps/unagi/keymap.c
@@ -0,0 +1,347 @@
	1	/* Copyright 2015-2017 Jack Humbert
	2	*
	3	* This program is free software: you can redistribute it and/or modify
	4	* it under the terms of the GNU General Public License as published by
	5	* the Free Software Foundation, either version 2 of the License, or
	6	* (at your option) any later version.
	7	*
	8	* This program is distributed in the hope that it will be useful,
	9	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	11	* GNU General Public License for more details.
	12	*
	13	* You should have received a copy of the GNU General Public License
	14	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	15	*/
	16
	17	#include QMK_KEYBOARD_H
	18	#include "muse.h"
	19
	20	extern keymap_config_t keymap_config;
	21
	22	enum planck_layers {
	23	_QWERTY,
	24	_COLEMAK,
	25	_DVORAK,
	26	_LOWER,
	27	_RAISE,
	28	_PLOVER,
	29	_ADJUST
	30	};
	31
	32	enum planck_keycodes {
	33	QWERTY = SAFE_RANGE,
	34	COLEMAK,
	35	DVORAK,
	36	PLOVER,
	37	BACKLIT,
	38	EXT_PLV
	39	};
	40
	41	// Tap Dance Declarations
	42	enum {
	43	SFT_CAP = 0
	44	};
	45
	46	#define LOWER MO(_LOWER)
	47	#define RAISE MO(_RAISE)
	48
	49	const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
	50
	51	/* Qwerty
	52	* ,-----------------------------------------------------------------------------------.
	53	* \| Tab \| Q \| W \| E \| R \| T \| Y \| U \| I \| O \| P \| Bksp \|
	54	* \|------+------+------+------+------+-------------+------+------+------+------+------\|
	55	* \| Esc \| A \| S \| D \| F \| G \| H \| J \| K \| L \| ; \| " \|
	56	* \|------+------+------+------+------+------\|------+------+------+------+------+------\|
	57	* \| Shift\| Z \| X \| C \| V \| B \| N \| M \| , \| . \| / \|Enter \|
	58	* \|------+------+------+------+------+------+------+------+------+------+------+------\|
	59	* \| Brite\| Ctrl \| Alt \| GUI \|Lower \| Space \|Raise \| Left \| Down \| Up \|Right \|
	60	* `-----------------------------------------------------------------------------------'
	61	*/
	62	[_QWERTY] = LAYOUT_planck_grid(
	63	KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
	64	KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
	65	TD(SFT_CAP), KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_T(KC_ENT),
	66	BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
	67	),
	68
	69	/* Colemak
	70	* ,-----------------------------------------------------------------------------------.
	71	* \| Tab \| Q \| W \| F \| P \| G \| J \| L \| U \| Y \| ; \| Bksp \|
	72	* \|------+------+------+------+------+-------------+------+------+------+------+------\|
	73	* \| Esc \| A \| R \| S \| T \| D \| H \| N \| E \| I \| O \| " \|
	74	* \|------+------+------+------+------+------\|------+------+------+------+------+------\|
	75	* \| Shift\| Z \| X \| C \| V \| B \| K \| M \| , \| . \| / \|Enter \|
	76	* \|------+------+------+------+------+------+------+------+------+------+------+------\|
	77	* \| Brite\| Ctrl \| Alt \| GUI \|Lower \| Space \|Raise \| Left \| Down \| Up \|Right \|
	78	* `-----------------------------------------------------------------------------------'
	79	*/
	80	[_COLEMAK] = LAYOUT_planck_grid(
	81	KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC,
	82	KC_ESC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT,
	83	KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT ,
	84	BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
	85	),
	86
	87	/* Dvorak
	88	* ,-----------------------------------------------------------------------------------.
	89	* \| Tab \| " \| , \| . \| P \| Y \| F \| G \| C \| R \| L \| Bksp \|
	90	* \|------+------+------+------+------+-------------+------+------+------+------+------\|
	91	* \| Esc \| A \| O \| E \| U \| I \| D \| H \| T \| N \| S \| / \|
	92	* \|------+------+------+------+------+------\|------+------+------+------+------+------\|
	93	* \| Shift\| ; \| Q \| J \| K \| X \| B \| M \| W \| V \| Z \|Enter \|
	94	* \|------+------+------+------+------+------+------+------+------+------+------+------\|
	95	* \| Brite\| Ctrl \| Alt \| GUI \|Lower \| Space \|Raise \| Left \| Down \| Up \|Right \|
	96	* `-----------------------------------------------------------------------------------'
	97	*/
	98	[_DVORAK] = LAYOUT_planck_grid(
	99	KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC,
	100	KC_ESC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH,
	101	KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_ENT ,
	102	BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
	103	),
	104
	105	/* Lower
	106	* ,-----------------------------------------------------------------------------------.
	107	* \| ~ \| ! \| @ \| # \| $ \| % \| ^ \| & \| * \| ( \| ) \| Bksp \|
	108	* \|------+------+------+------+------+-------------+------+------+------+------+------\|
	109	* \| Del \| F1 \| F2 \| F3 \| F4 \| F5 \| F6 \| _ \| + \| { \| } \| \| \|
	110	* \|------+------+------+------+------+------\|------+------+------+------+------+------\|
	111	* \| \| F7 \| F8 \| F9 \| F10 \| F11 \| F12 \|ISO ~ \|ISO \| \| Home \| End \| \|
	112	* \|------+------+------+------+------+------+------+------+------+------+------+------\|
	113	* \| \| \| \| \| \| \| \| Next \| Vol- \| Vol+ \| Play \|
	114	* `-----------------------------------------------------------------------------------'
	115	*/
	116	[_LOWER] = LAYOUT_planck_grid(
	117	KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC,
	118	KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE,
	119	_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, S(KC_NUHS), S(KC_NUBS), KC_HOME, KC_END, _______,
	120	_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
	121	),
	122
	123	/* Raise
	124	* ,-----------------------------------------------------------------------------------.
	125	* \| ` \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 0 \| Bksp \|
	126	* \|------+------+------+------+------+-------------+------+------+------+------+------\|
	127	* \| Del \| F1 \| F2 \| F3 \| F4 \| F5 \| F6 \| - \| = \| [ \| ] \| \ \|
	128	* \|------+------+------+------+------+------\|------+------+------+------+------+------\|
	129	* \| \| F7 \| F8 \| F9 \| F10 \| F11 \| F12 \|ISO # \|ISO / \|Pg Up \|Pg Dn \| \|
	130	* \|------+------+------+------+------+------+------+------+------+------+------+------\|
	131	* \| \| \| \| \| \| \| \| Next \| Vol- \| Vol+ \| Play \|
	132	* `-----------------------------------------------------------------------------------'
	133	*/
	134	[_RAISE] = LAYOUT_planck_grid(
	135	KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC,
	136	KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS,
	137	_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, _______,
	138	_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
	139	),
	140
	141	/* Plover layer (http://opensteno.org)
	142	* ,-----------------------------------------------------------------------------------.
	143	* \| # \| # \| # \| # \| # \| # \| # \| # \| # \| # \| # \| # \|
	144	* \|------+------+------+------+------+-------------+------+------+------+------+------\|
	145	* \| \| S \| T \| P \| H \| * \| * \| F \| P \| L \| T \| D \|
	146	* \|------+------+------+------+------+------\|------+------+------+------+------+------\|
	147	* \| \| S \| K \| W \| R \| * \| * \| R \| B \| G \| S \| Z \|
	148	* \|------+------+------+------+------+------+------+------+------+------+------+------\|
	149	* \| Exit \| \| \| A \| O \| \| E \| U \| \| \| \|
	150	* `-----------------------------------------------------------------------------------'
	151	*/
	152
	153	[_PLOVER] = LAYOUT_planck_grid(
	154	KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 ,
	155	XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC,
	156	XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
	157	EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX
	158	),
	159
	160	/* Adjust (Lower + Raise)
	161	* ,-----------------------------------------------------------------------------------.
	162	* \| \| Reset\| \| \| \| \| \| \| \| \| \| Del \|
	163	* \|------+------+------+------+------+-------------+------+------+------+------+------\|
	164	* \| \| \| \|Aud on\|Audoff\|AGnorm\|AGswap\|Qwerty\|Colemk\|Dvorak\|Plover\| \|
	165	* \|------+------+------+------+------+------\|------+------+------+------+------+------\|
	166	* \| \|Voice-\|Voice+\|Mus on\|Musoff\|MIDIon\|MIDIof\| \| \| \| \| \|
	167	* \|------+------+------+------+------+------+------+------+------+------+------+------\|
	168	* \| \| \| \| \| \| \| \| \| \| \| \|
	169	* `-----------------------------------------------------------------------------------'
	170	*/
	171	[_ADJUST] = LAYOUT_planck_grid(
	172	_______, RESET, DEBUG, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, KC_DEL ,
	173	_______, _______, MU_MOD, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______,
	174	_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, TERM_ON, TERM_OFF, _______, _______, _______,
	175	_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
	176	)
	177
	178
	179	};
	180
	181	qk_tap_dance_action_t tap_dance_actions[] = {
	182	[SFT_CAP] = ACTION_TAP_DANCE_DOUBLE(KC_LSFT, KC_CAPS)
	183	};
	184
	185	#ifdef AUDIO_ENABLE
	186	float plover_song[][2] = SONG(PLOVER_SOUND);
	187	float plover_gb_song[][2] = SONG(PLOVER_GOODBYE_SOUND);
	188	#endif
	189
	190	uint32_t layer_state_set_user(uint32_t state) {
	191	return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
	192	}
	193
	194	bool process_record_user(uint16_t keycode, keyrecord_t *record) {
	195	switch (keycode) {
	196	case QWERTY:
	197	if (record->event.pressed) {
	198	print("mode just switched to qwerty and this is a huge string\n");
	199	set_single_persistent_default_layer(_QWERTY);
	200	}
	201	return false;
	202	break;
	203	case COLEMAK:
	204	if (record->event.pressed) {
	205	set_single_persistent_default_layer(_COLEMAK);
	206	}
	207	return false;
	208	break;
	209	case DVORAK:
	210	if (record->event.pressed) {
	211	set_single_persistent_default_layer(_DVORAK);
	212	}
	213	return false;
	214	break;
	215	case BACKLIT:
	216	if (record->event.pressed) {
	217	register_code(KC_RSFT);
	218	#ifdef BACKLIGHT_ENABLE
	219	backlight_step();
	220	#endif
	221	#ifdef KEYBOARD_planck_rev5
	222	PORTE &= ~(1<<6);
	223	#endif
	224	} else {
	225	unregister_code(KC_RSFT);
	226	#ifdef KEYBOARD_planck_rev5
	227	PORTE \|= (1<<6);
	228	#endif
	229	}
	230	return false;
	231	break;
	232	case PLOVER:
	233	if (record->event.pressed) {
	234	#ifdef AUDIO_ENABLE
	235	stop_all_notes();
	236	PLAY_SONG(plover_song);
	237	#endif
	238	layer_off(_RAISE);
	239	layer_off(_LOWER);
	240	layer_off(_ADJUST);
	241	layer_on(_PLOVER);
	242	if (!eeconfig_is_enabled()) {
	243	eeconfig_init();
	244	}
	245	keymap_config.raw = eeconfig_read_keymap();
	246	keymap_config.nkro = 1;
	247	eeconfig_update_keymap(keymap_config.raw);
	248	}
	249	return false;
	250	break;
	251	case EXT_PLV:
	252	if (record->event.pressed) {
	253	#ifdef AUDIO_ENABLE
	254	PLAY_SONG(plover_gb_song);
	255	#endif
	256	layer_off(_PLOVER);
	257	}
	258	return false;
	259	break;
	260	}
	261	return true;
	262	}
	263
	264	bool muse_mode = false;
	265	uint8_t last_muse_note = 0;
	266	uint16_t muse_counter = 0;
	267	uint8_t muse_offset = 70;
	268	uint16_t muse_tempo = 50;
	269
	270	void encoder_update(bool clockwise) {
	271	if (muse_mode) {
	272	if (IS_LAYER_ON(_RAISE)) {
	273	if (clockwise) {
	274	muse_offset++;
	275	} else {
	276	muse_offset--;
	277	}
	278	} else {
	279	if (clockwise) {
	280	muse_tempo+=1;
	281	} else {
	282	muse_tempo-=1;
	283	}
	284	}
	285	} else {
	286	if (clockwise) {
	287	register_code(KC_PGDN);
	288	unregister_code(KC_PGDN);
	289	} else {
	290	register_code(KC_PGUP);
	291	unregister_code(KC_PGUP);
	292	}
	293	}
	294	}
	295
	296	void dip_update(uint8_t index, bool active) {
	297	switch (index) {
	298	case 0:
	299	if (active) {
	300	#ifdef AUDIO_ENABLE
	301	PLAY_SONG(plover_song);
	302	#endif
	303	layer_on(_ADJUST);
	304	} else {
	305	#ifdef AUDIO_ENABLE
	306	PLAY_SONG(plover_gb_song);
	307	#endif
	308	layer_off(_ADJUST);
	309	}
	310	break;
	311	case 1:
	312	if (active) {
	313	muse_mode = true;
	314	} else {
	315	muse_mode = false;
	316	#ifdef AUDIO_ENABLE
	317	stop_all_notes();
	318	#endif
	319	}
	320	}
	321	}
	322
	323	void matrix_scan_user(void) {
	324	#ifdef AUDIO_ENABLE
	325	if (muse_mode) {
	326	if (muse_counter == 0) {
	327	uint8_t muse_note = muse_offset + SCALE[muse_clock_pulse()];
	328	if (muse_note != last_muse_note) {
	329	stop_note(compute_freq_for_midi_note(last_muse_note));
	330	play_note(compute_freq_for_midi_note(muse_note), 0xF);
	331	last_muse_note = muse_note;
	332	}
	333	}
	334	muse_counter = (muse_counter + 1) % muse_tempo;
	335	}
	336	#endif
	337	}
	338
	339	bool music_mask_user(uint16_t keycode) {
	340	switch (keycode) {
	341	case RAISE:
	342	case LOWER:
	343	return false;
	344	default:
	345	return true;
	346	}
	347	}


diff --git a/keyboards/planck/keymaps/unagi/readme.md b/keyboards/planck/keymaps/unagi/readme.md new file mode 100644 index 000000000..08477d7ee --- /dev/null +++ b/keyboards/planck/keymaps/unagi/readme.md
@@ -0,0 +1,8 @@
	1	# The Unagi Planck Layout
	2
	3	This layout is a modified version of the default Planck keymap with the following additions:
	4	- Double tap left shift for caps lock
	5	- Hold enter for right shift (enter on-tap)
	6	- "Sonic Ring" startup tone
	7	- "Zelda Puzzle" music tone
	8


diff --git a/keyboards/planck/keymaps/unagi/rules.mk b/keyboards/planck/keymaps/unagi/rules.mk new file mode 100644 index 000000000..5433b3b68 --- /dev/null +++ b/keyboards/planck/keymaps/unagi/rules.mk
@@ -0,0 +1,2 @@
	1	SRC += muse.c
	2	TAP_DANCE_ENABLE = yes