summaryrefslogtreecommitdiffstats
path: root/keyboards/planck
diff options
context:
space:
mode:
authorJay <takuya813@gmail.com>2021-05-21 21:38:42 -0700
committerGitHub <noreply@github.com>2021-05-21 21:38:42 -0700
commitd425fcc8b126bc707e072472d32cf125c6229d85 (patch)
treecdccb5f39d4edc9a6d6bfb2e2f685c1eff53fead /keyboards/planck
parent10f8a6d983f4caf04acb51df1a421c607f6485b2 (diff)
[Keymap] Add kanbara's planck/rev4 keymap (#12486)
Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Jay Morrow <jay.morrow@apple.com>
Diffstat (limited to 'keyboards/planck')
-rw-r--r--keyboards/planck/keymaps/kanbara/config.h31
-rw-r--r--keyboards/planck/keymaps/kanbara/keymap.c199
-rw-r--r--keyboards/planck/keymaps/kanbara/readme.md118
-rw-r--r--keyboards/planck/keymaps/kanbara/rules.mk9
4 files changed, 357 insertions, 0 deletions
diff --git a/keyboards/planck/keymaps/kanbara/config.h b/keyboards/planck/keymaps/kanbara/config.h
new file mode 100644
index 0000000000..b701b9b40d
--- /dev/null
+++ b/keyboards/planck/keymaps/kanbara/config.h
@@ -0,0 +1,31 @@
+/* Copyright 2021 Jay Morrow
+ *
+ * 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
+ #ifdef TEMPO_DEFAULT
+ #undef TEMPO_DEFAULT
+ #define TEMPO_DEFAULT 80
+ #endif
+
+ #define STARTUP_SONG SONG(MAJOR_SOUND)
+
+ #define DEFAULT_LAYER_SONGS { SONG(COLEMAK_SOUND), \
+ SONG(DVORAK_SOUND), \
+ SONG(WORKMAN_SOUND) \
+ }
+#endif
diff --git a/keyboards/planck/keymaps/kanbara/keymap.c b/keyboards/planck/keymaps/kanbara/keymap.c
new file mode 100644
index 0000000000..711411f65d
--- /dev/null
+++ b/keyboards/planck/keymaps/kanbara/keymap.c
@@ -0,0 +1,199 @@
+/* Copyright 2021 Jay Morrow
+ *
+ * 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
+
+enum planck_layers {
+ _QWERTY,
+ _COLEMAK,
+ _LEAGUE,
+ _LOWER,
+ _RAISE,
+ _ADJUST,
+ _LRAISE,
+};
+
+enum planck_keycodes {
+ QWERTY = SAFE_RANGE,
+ COLEMAK,
+ LEAGUE,
+};
+
+#define LOWER MO(_LOWER)
+#define RAISE MO(_RAISE)
+#define ADJUST MO(_ADJUST)
+#define LRAISE MO(_LRAISE)
+
+#define KC_LQ LCTL(KC_Q)
+#define KC_LW LCTL(KC_W)
+#define KC_LE LCTL(KC_E)
+#define KC_LR LCTL(KC_R)
+
+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 |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Adjst| Ctrl | Alt | GUI | SPC | Lower| Raise| Enter| 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,
+ KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT,
+ ADJUST, KC_LCTL, KC_LALT, KC_LGUI, KC_SPC, LOWER, RAISE, KC_ENT, 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 |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Adjst| Ctrl | Alt | GUI | SPC | Lower| Raise| Enter| 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_RSFT,
+ ADJUST, KC_LCTL, KC_LALT, KC_LGUI, KC_SPC, LOWER, RAISE, KC_ENT, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
+),
+
+/* League
+ * ,-----------------------------------------------------------------------------------.
+ * | Tab | 1 | 2 | 3 | 4 | 5 | 6 | 7 | | | | Bksp |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Esc | Q | W | E | R | G | | | | | | |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | P | B | S | D | F | | | | | | | |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |Adjust| | | | | Spc | Raise| | Ent | | | |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_LEAGUE] = LAYOUT_planck_grid(
+ KC_TAB, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, XXXXXXX, XXXXXXX, XXXXXXX, KC_BSPC,
+ KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_G, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
+ KC_P, KC_B, KC_S, KC_D, KC_F, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
+ ADJUST, XXXXXXX, XXXXXXX, XXXXXXX, KC_SPC, LRAISE, XXXXXXX, KC_ENT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
+),
+
+/* Lower
+ * ,-----------------------------------------------------------------------------------.
+ * | ` | | _ | + | \ | { | } | | 7 | 8 | 9 | / |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | ~ | | _ | = | | | [ | ] | | 4 | 5 | 6 | * |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | | | | ( | ) | | 1 | 2 | 3 | - |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | | | | | | | 0 | , | . | + |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_LOWER] = LAYOUT_planck_grid(
+ KC_GRV, XXXXXXX, KC_MINS, KC_PLUS, KC_BSLS, KC_LCBR, KC_RCBR, XXXXXXX, KC_7, KC_8, KC_9, KC_SLSH,
+ KC_TILD, XXXXXXX, KC_UNDS, KC_EQL, KC_PIPE, KC_LBRC, KC_RBRC, XXXXXXX, KC_4, KC_5, KC_6, KC_ASTR,
+ _______, _______, _______, _______, _______, KC_LPRN, KC_RPRN, XXXXXXX, KC_1, KC_2, KC_3, KC_MINS,
+ _______, _______, _______, _______, _______, _______, _______, _______, KC_0, KC_COMM, KC_DOT, KC_PLUS
+),
+
+/* Raise
+ * ,-----------------------------------------------------------------------------------.
+ * | ~ | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | Home |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Del | ! | @ | # | $ | % | ^ | & | * | | | PgUp |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | | | Vol- | BR- | BR+ | Vol+ | | | | PgDn |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | | | | | | | | | | End |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_RAISE] = LAYOUT_planck_grid(
+ KC_TILD, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_HOME,
+ KC_DEL, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, _______, _______, KC_PGUP,
+ _______, _______, _______, _______, KC_VOLD, KC_BRMD, KC_BRMU, KC_VOLU, _______, _______, _______, KC_PGDN,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_END
+),
+
+/* Adjust
+ * ,-----------------------------------------------------------------------------------.
+ * |Reset |Debug | | | | | | | | | |Qwerty|
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | | | | | | | | | |Colmk |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | | | | | | | | | |League|
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | | | | | | | | | | |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_ADJUST] = LAYOUT_planck_grid(
+ RESET, DEBUG, _______, _______, _______, _______, _______, _______, _______, _______, _______, QWERTY,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, COLEMAK,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, LEAGUE,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+),
+
+/* League Raise
+ * ,-----------------------------------------------------------------------------------.
+ * | | F2 | F3 | F4 | F5 | | | | | | | |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | |Ctrl-Q|Ctrl-W|Ctrl-E|Ctrl-R| | | | | | | |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | | | | | | | | | | |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | | | | | | | | | | |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_LRAISE] = LAYOUT_planck_grid(
+ _______, KC_F2, KC_F3, KC_F4, KC_F5, _______, _______, _______, _______, _______, _______, _______,
+ _______, KC_LQ, KC_LW, KC_LE, KC_LR, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+),
+
+
+};
+
+// set the default layer in ROM so that we preserve state across power transitions
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+ switch (keycode) {
+ case QWERTY:
+ if (record->event.pressed) {
+ 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 LEAGUE:
+ if (record->event.pressed) {
+ set_single_persistent_default_layer(_LEAGUE);
+ }
+ return false;
+ break;
+ }
+ return true;
+}
diff --git a/keyboards/planck/keymaps/kanbara/readme.md b/keyboards/planck/keymaps/kanbara/readme.md
new file mode 100644
index 0000000000..de32a84d29
--- /dev/null
+++ b/keyboards/planck/keymaps/kanbara/readme.md
@@ -0,0 +1,118 @@
+kanbara's layout
+=======================
+This layout contains a Colemak and Qwerty mode (for easier pair programming with colleagues)
+as well as a mode specifically to play League of Legends, as the normal mode does not provide
+for accessible enough numbers and function keys
+
+
+## Base Layers (Qwerty/Colemak/League)
+After lots of tweaking, I've found that putting brackets in the middle is easier for
+programming, and having a separate numpad input is quite handy.
+
+- Contains split `space` and `enter`
+- Designed for macOS
+- Keeps the `Tab`/`Esc` swap which I quite like
+- Note the removal of evil caps lock
+
+### 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 |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Adjst| Ctrl | Alt | GUI | SPC | Lower| Raise| Enter| Left | Down | Up |Right |
+`-----------------------------------------------------------------------------------'
+```
+
+### 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 |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Adjst| Ctrl | Alt | GUI | SPC | Lower| Raise| Enter| Left | Down | Up |Right |
+`-----------------------------------------------------------------------------------'
+```
+
+### League
+
+- Has it's own raise just for F-keys and Ctrl+{Q,W,E,R} as a hold toggle
+- Just the base keys needed for the game + the adjust and backspace
+
+```
+,-----------------------------------------------------------------------------------.
+| Tab | 1 | 2 | 3 | 4 | 5 | 6 | 7 | | | | Bksp |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Esc | Q | W | E | R | G | | | | | | |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| P | B | S | D | F | | | | | | | |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+|Adjust| | | | | Spc | Raise| | Ent | | | |
+`-----------------------------------------------------------------------------------'
+```
+
+#### Raise
+```
+,-----------------------------------------------------------------------------------.
+| | F2 | F3 | F4 | F5 | | | | | | | |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| |Ctrl-Q|Ctrl-W|Ctrl-E|Ctrl-R| | | | | | | |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| | | | | | | | | | | | |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| | | | | | | | | | | | |
+`-----------------------------------------------------------------------------------'
+```
+
+## Lower Layer (Programming symbols + numpad)
+I've put a numpad on the right side, and brackets in the middle. I found that putting
+the shifted equivalents of `-`, `+`, `\` and `~` are quite convenient to type with one hand
+
+```
+,-----------------------------------------------------------------------------------.
+| ` | | _ | + | \ | { | } | | 7 | 8 | 9 | / |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| ~ | | _ | = | | | [ | ] | | 4 | 5 | 6 | * |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| | | | | | ( | ) | | 1 | 2 | 3 | - |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| | | | | | | | | 0 | , | . | + |
+`-----------------------------------------------------------------------------------'
+```
+
+## Raise Layer (Function keys + shifted numbers)
+Here are the Function keys, as well as shifted 1-9 in order, and some nav and OS keys
+
+```
+,-----------------------------------------------------------------------------------.
+| ~ | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | Home |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Del | ! | @ | # | $ | % | ^ | & | * | | | PgUp |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| | | | | Vol- | BR- | BR+ | Vol+ | | | | PgDn |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| | | | | | | | | | | | End |
+`-----------------------------------------------------------------------------------'
+```
+
+## Adjust Layer
+Contains reset, debug and the layer on the right which are set in EEPROM across power
+transitions
+
+```
+,-----------------------------------------------------------------------------------.
+|Reset |Debug | | | | | | | | | |Qwerty|
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| | | | | | | | | | | |Colmk |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| | | | | | | | | | | |League|
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| | | | | | | | | | | | |
+`-----------------------------------------------------------------------------------'
+```
diff --git a/keyboards/planck/keymaps/kanbara/rules.mk b/keyboards/planck/keymaps/kanbara/rules.mk
new file mode 100644
index 0000000000..4e1e300974
--- /dev/null
+++ b/keyboards/planck/keymaps/kanbara/rules.mk
@@ -0,0 +1,9 @@
+BOOTMAGIC_ENABLE = no
+MOUSEKEY_ENABLE = no
+EXTRAKEY_ENABLE = yes
+CONSOLE_ENABLE = no
+COMMAND_ENABLE = yes
+NKRO_ENABLE = yes
+BACKLIGHT_ENABLE = no
+AUDIO_ENABLE = yes
+RGBLIGHT_ENABLE = no