From 2218879d6878a63e74bca473399f9d315da7648b Mon Sep 17 00:00:00 2001
From: Jarrett Drouillard <jarrett@thestyl.us>
Date: Thu, 12 Aug 2021 11:56:25 -0400
Subject: [PATCH] [Keymap] add kuatsure planck keymap (#10625)
Co-authored-by: Ryan <fauxpark@gmail.com>
---
keyboards/planck/keymaps/kuatsure/config.h | 33 ++
keyboards/planck/keymaps/kuatsure/keymap.c | 318 ++++++++++++++++++++
keyboards/planck/keymaps/kuatsure/readme.md | 1 +
keyboards/planck/keymaps/kuatsure/rules.mk | 6 +
keyboards/preonic/keymaps/kuatsure/keymap.c | 2 +
users/kuatsure/kuatsure.c | 14 +-
users/kuatsure/kuatsure.h | 10 +-
7 files changed, 371 insertions(+), 13 deletions(-)
create mode 100644 keyboards/planck/keymaps/kuatsure/config.h
create mode 100644 keyboards/planck/keymaps/kuatsure/keymap.c
create mode 100644 keyboards/planck/keymaps/kuatsure/readme.md
create mode 100644 keyboards/planck/keymaps/kuatsure/rules.mk
diff --git a/keyboards/planck/keymaps/kuatsure/config.h b/keyboards/planck/keymaps/kuatsure/config.h
new file mode 100644
index 0000000000..8d832285bc
--- /dev/null
+++ b/keyboards/planck/keymaps/kuatsure/config.h
@@ -0,0 +1,33 @@
+/* Copyright 2020 kuatsure
+ *
+ * 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
+
+#ifdef AUDIO_ENABLE
+ #define STARTUP_SONG SONG(PLANCK_SOUND)
+ // #define STARTUP_SONG SONG(NO_SOUND)
+
+ #define GAME_SOUND DVORAK_SOUND
+
+ #define DEFAULT_LAYER_SONGS { SONG(QWERTY_SOUND), \
+ SONG(GAME_SOUND) \
+ }
+#endif
+
+#define MIDI_BASIC
+
+// Most tactile encoders have detents every 4 stages
+#define ENCODER_RESOLUTION 4
diff --git a/keyboards/planck/keymaps/kuatsure/keymap.c b/keyboards/planck/keymaps/kuatsure/keymap.c
new file mode 100644
index 0000000000..6ce1049b80
--- /dev/null
+++ b/keyboards/planck/keymaps/kuatsure/keymap.c
@@ -0,0 +1,318 @@
+/* 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"
+#include "kuatsure.h"
+
+#define LAYOUT_planck_grid_wrapper(...) LAYOUT_planck_grid(__VA_ARGS__)
+
+enum planck_layers {
+ _QWERTY,
+ _GAME,
+ _GAME_LOWER,
+ _GAME_RAISE,
+ _MOUSE,
+ _LOWER,
+ _RAISE,
+ _ADJUST
+};
+
+enum planck_keycodes {
+ QWERTY = USER_SAFE_RANGE,
+ GAME,
+};
+
+#define LOWER MO(_LOWER)
+#define RAISE MO(_RAISE)
+#define MOUSE TG(_MOUSE)
+#define G_LOWER MO(_GAME_LOWER)
+#define G_RAISE MO(_GAME_RAISE)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+/* Qwerty
+ * ,-----------------------------------------------------------------------------------.
+ * | Tab/M| Q | W | E | R | T | Y | U | I | O | P | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Esc/C| A | S | D | F | G | H | J | K | L | ; | ' |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | Shift| Z | X | C | V | B | N | M | , | . | / | Ent |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Mute | Ldr | Alt | GUI |Lower | RSE | SPC | Left | Down | Up |Right |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_QWERTY] = LAYOUT_planck_grid_wrapper(
+ KT_MTAB, _________________QWERTY_L1_________________, _________________QWERTY_R1_________________, KC_BSPC,
+ KT_CESC, _________________QWERTY_L2_________________, _________________QWERTY_R2_________________, KC_QUOT,
+ KT_LSFT, _________________QWERTY_L3_________________, _________________QWERTY_R3_________________, KC_ENT,
+ KC_MPLY, KC_LEAD, KC_LALT, KC_LGUI, LOWER, RAISE, KC_SPC, KC_SPC, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
+),
+
+/* Lower
+ * ,-----------------------------------------------------------------------------------.
+ * | | ! | & | Up | | ` | | { | } | _ | | | |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | | Del | Left | Down | Right| ~ | = | ( | ) | + | : | " |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | | VolD | Prev | Play | Next | VolU | - | [ | ] | | ? |Mouse |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | | | | | | | Home | PgDn | PgUp | End |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_LOWER] = LAYOUT_planck_grid_wrapper(
+ _______, KC_EXLM, KC_AMPR, KC_UP, _______, KC_GRV, _______, ____CRBRACES____, KC_UNDS, _______, KC_PIPE,
+ _______, KC_DEL, KC_LEFT, KC_DOWN, KC_RIGHT, KC_TILD, KC_EQL, _____PARENS_____, KC_PLUS, KC_COLN, KC_DQT ,
+ _______, KC_VOLD, KC_MPRV, KC_MPLY, KC_MNXT, KC_VOLU, KC_MINS, ___SQBRACKETS___, _______, KC_QUES, MOUSE ,
+ _______, _______, _______, _______, _______, _______, _______, _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END
+),
+
+/* Raise
+ * ,-----------------------------------------------------------------------------------.
+ * | | F9 | F10 | F11 | F12 | | * | 7 | 8 | 9 | 0 | \ |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | | F5 | F6 | F7 | F8 | | = | 4 | 5 | 6 | + | |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | | F1 | F2 | F3 | F4 | | - | 1 | 2 | 3 | / | |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | | | | | | | 0 | 0 | | |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_RAISE] = LAYOUT_planck_grid_wrapper(
+ _______, ____________FUNCTION_3____________, _______, KC_ASTR, KC_7, KC_8, KC_9, KC_0, KC_BSLS,
+ _______, ____________FUNCTION_2____________, _______, KC_EQL, KC_4, KC_5, KC_6, KC_PLUS, _______,
+ _______, ____________FUNCTION_1____________, _______, KC_MINS, KC_1, KC_2, KC_3, KC_SLASH, _______,
+ _______, _______, _______, _______, _______, _______, _______, KC_0, KC_0, _______, _______, _______
+),
+
+/* Mouse
+ * ,-----------------------------------------------------------------------------------.
+ * | | | Btn1 | mUP | Btn2 | | | | | | | |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | mLEFT| mDWN | mRGHT| | | | | | | |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | Btn3 | Btn4 | Btn5 | | | | | | |Mouse |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | | | | | | | | | | |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_MOUSE] = LAYOUT_planck_grid_wrapper(
+ _______, _______, KC_BTN1, KC_MS_U, KC_BTN2, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, KC_MS_L, KC_MS_D, KC_MS_R, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, KC_BTN3, KC_BTN4, KC_BTN5, _______, _______, _______, _______, _______, _______, MOUSE ,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+),
+
+/* Adjust (Lower + Raise)
+ * ,-----------------------------------------------------------------------------------.
+ * | | MAKE | FLSH | | | | | | | | | Del |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | | RESET| DEBUG| | |Aud on|AudOff| Game |Mouse | | | |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | | VRSN | | |MusMod|Mus on|MusOff| | | | | |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | | | | | | | | | | |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_ADJUST] = LAYOUT_planck_grid_wrapper(
+ _______, KB_MAKE, KB_FLSH, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL,
+ _______, RESET, DEBUG, _______, _______, AU_ON, AU_OFF, GAME, MOUSE, _______, _______, _______,
+ _______, KB_VRSN, _______, _______, MU_MOD, MU_ON, MU_OFF, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+),
+
+/* Game
+ *
+ * Mostly transparent, but wanted to disable gui key.
+ * Also give a key to get back to qwerty layout.
+ *
+ * Disabling the `Controlled ESC` key is also plus.
+ * Think BDO / Monster Hunter / D2
+ *
+ * ,-----------------------------------------------------------------------------------.
+ * | Tab | | | | | | | | | | | |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Ctrl | | | | | | | | | | | |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | Shft | | | | | | | | | | | |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | |Qwerty| F14 | Spc | gLWR | gRSE | ESC | | | | |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_GAME] = LAYOUT_planck_grid_wrapper(
+ KC_TAB, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ KC_LCTL, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ KC_LSFT, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, QWERTY, KC_F14, KC_SPC, G_LOWER, G_RAISE, KC_ESC, KC_ESC, _______, _______, _______, _______
+),
+
+/* Game Lower
+ * ,-----------------------------------------------------------------------------------.
+ * | | 1 | 2 | 3 | 4 | ` | | F9 | F10 | F11 | F12 | |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | | 5 | 6 | 7 | 8 | | | F5 | F6 | F7 | F8 | |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | | 9 | 0 | - | = | | | F1 | F2 | F3 | F4 | |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | | | | | | | | | | |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_GAME_LOWER] = LAYOUT_planck_grid_wrapper(
+ _______, KC_1, KC_2, KC_3, KC_4, KC_GRV, _______, ____________FUNCTION_3____________, _______,
+ _______, KC_5, KC_6, KC_7, KC_8, _______, _______, ____________FUNCTION_2____________, _______,
+ _______, KC_9, KC_0, KC_MINS, KC_EQL, _______, _______, ____________FUNCTION_1____________, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+),
+
+/* Game Raise
+ * ,-----------------------------------------------------------------------------------.
+ * | | p7 | p8 | p9 | p0 | ` | | F9 | F10 | F11 | F12 | |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | | p4 | p5 | p6 | p+ | | | F5 | F6 | F7 | F8 | |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | | p1 | p2 | p3 | pE | | | F1 | F2 | F3 | F4 | |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | | | | | | | | | | |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_GAME_RAISE] = LAYOUT_planck_grid_wrapper(
+ _______, KC_P7, KC_P8, KC_P9, KC_P0, KC_GRV, _______, ____________FUNCTION_3____________, _______,
+ _______, KC_P4, KC_P5, KC_P6, KC_PPLS, _______, _______, ____________FUNCTION_2____________, _______,
+ _______, KC_P1, KC_P2, KC_P3, KC_PENT, _______, _______, ____________FUNCTION_1____________, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+),
+
+};
+
+#ifdef AUDIO_ENABLE
+ float plover_song[][2] = SONG(PLOVER_SOUND);
+ float plover_gb_song[][2] = SONG(PLOVER_GOODBYE_SOUND);
+#endif
+
+layer_state_t layer_state_set_user(layer_state_t state) {
+ return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
+}
+
+bool process_record_keymap(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 GAME:
+ if (record->event.pressed) {
+ set_single_persistent_default_layer(_GAME);
+ }
+ 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) {
+ if (IS_LAYER_ON(_MOUSE)) {
+ tap_code(KC_MS_WH_UP);
+ } else {
+ tap_code(KC_VOLU);
+ }
+ } else {
+ if (IS_LAYER_ON(_MOUSE)) {
+ tap_code(KC_MS_WH_DOWN);
+ } else {
+ tap_code(KC_VOLD);
+ }
+ }
+ }
+}
+
+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_keymap(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/kuatsure/readme.md b/keyboards/planck/keymaps/kuatsure/readme.md
new file mode 100644
index 0000000000..b1e5c64230
--- /dev/null
+++ b/keyboards/planck/keymaps/kuatsure/readme.md
@@ -0,0 +1 @@
+# The kuatsure Planck layout - largely based on the Preonic's & Keyboard Paradise V60's layout
diff --git a/keyboards/planck/keymaps/kuatsure/rules.mk b/keyboards/planck/keymaps/kuatsure/rules.mk
new file mode 100644
index 0000000000..f9fba61d3e
--- /dev/null
+++ b/keyboards/planck/keymaps/kuatsure/rules.mk
@@ -0,0 +1,6 @@
+SRC += muse.c
+
+BACKLIGHT_ENABLE = no
+LEADER_ENABLE = yes
+ENCODER_ENABLE = yes
+MOUSEKEY_ENABLE = yes
diff --git a/keyboards/preonic/keymaps/kuatsure/keymap.c b/keyboards/preonic/keymaps/kuatsure/keymap.c
index 907360d0cf..5bd7321d49 100644
--- a/keyboards/preonic/keymaps/kuatsure/keymap.c
+++ b/keyboards/preonic/keymaps/kuatsure/keymap.c
@@ -17,6 +17,8 @@
#include QMK_KEYBOARD_H
#include "kuatsure.h"
+#define LAYOUT_preonic_grid_wrapper(...) LAYOUT_preonic_grid(__VA_ARGS__)
+
enum preonic_layers {
_QWERTY,
_GAME,
diff --git a/users/kuatsure/kuatsure.c b/users/kuatsure/kuatsure.c
index f935e83c74..88bf6790a4 100644
--- a/users/kuatsure/kuatsure.c
+++ b/users/kuatsure/kuatsure.c
@@ -3,7 +3,8 @@
qk_tap_dance_action_t tap_dance_actions[] = {
[TD_LBRC] = ACTION_TAP_DANCE_DOUBLE(KC_LBRC, KC_LT),
- [TD_RBRC] = ACTION_TAP_DANCE_DOUBLE(KC_RBRC, KC_GT)
+ [TD_RBRC] = ACTION_TAP_DANCE_DOUBLE(KC_RBRC, KC_GT),
+ [TD_SLSH] = ACTION_TAP_DANCE_DOUBLE(KC_SLSH, KC_BSLS),
};
__attribute__ ((weak))
@@ -29,15 +30,8 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
case KB_FLSH:
if (!record->event.pressed) {
- SEND_STRING("make " QMK_KEYBOARD ":" QMK_KEYMAP
- #if (defined(BOOTLOADER_DFU) || defined(BOOTLOADER_LUFA_DFU) || defined(BOOTLOADER_QMK_DFU))
- ":dfu "
- #elif defined(BOOTLOADER_HALFKAY)
- ":teensy "
- #elif defined(BOOTLOADER_CATERINA)
- ":avrdude "
- #endif
- SS_TAP(X_ENTER)
+ SEND_STRING(
+ "qmk flash -kb " QMK_KEYBOARD " -km " QMK_KEYMAP
);
reset_keyboard();
diff --git a/users/kuatsure/kuatsure.h b/users/kuatsure/kuatsure.h
index 8961d56213..ca2c91c9bc 100644
--- a/users/kuatsure/kuatsure.h
+++ b/users/kuatsure/kuatsure.h
@@ -11,13 +11,18 @@ enum kuatsure_keycodes {
USER_SAFE_RANGE,
};
+#define ONESHOT_TAP_TOGGLE 2
+#define KT_LSFT OSM(MOD_LSFT)
+
enum {
TD_LBRC = 0,
TD_RBRC,
+ TD_SLSH
};
#define KT_LBRC TD(TD_LBRC)
#define KT_RBRC TD(TD_RBRC)
+#define KT_SLSH TD(TD_SLSH)
#define TAPPING_TERM 200
@@ -33,8 +38,6 @@ void tmux_pane_zoom(void);
#undef LEADER_TIMEOUT
#define LEADER_TIMEOUT 300
-#define LAYOUT_preonic_grid_wrapper(...) LAYOUT_preonic_grid(__VA_ARGS__)
-
#define _________________NUMBER_L1_________________ KC_1, KC_2, KC_3, KC_4, KC_5
#define _________________NUMBER_R1_________________ KC_6, KC_7, KC_8, KC_9, KC_0
@@ -47,7 +50,8 @@ void tmux_pane_zoom(void);
#define _________________QWERTY_R1_________________ KC_Y, KC_U, KC_I, KC_O, KC_P
#define _________________QWERTY_R2_________________ KC_H, KC_J, KC_K, KC_L, KC_SCLN
-#define _________________QWERTY_R3_________________ KC_N, KC_M, KC_COMM, KC_DOT, KC_SLASH
+#define _________________QWERTY_R3_________________ KC_N, KC_M, KC_COMM, KC_DOT, KT_SLSH
+#define _________________QWERTY_R3_M_______________ KC_N, KC_M, KC_COMM, KC_DOT, KC_UP
#define ____________FUNCTION_1____________ KC_F1, KC_F2, KC_F3, KC_F4
#define ____________FUNCTION_2____________ KC_F5, KC_F6, KC_F7, KC_F8