aboutsummaryrefslogtreecommitdiff
path: root/layouts
diff options
context:
space:
mode:
authorJonathan Rascher <jon@bcat.name>2020-11-06 00:41:06 -0600
committerGitHub <noreply@github.com>2020-11-05 22:41:06 -0800
commitb5ebdf1b3a29119e1a414aaf7e2cf7a583853430 (patch)
tree201253b69b27b16ba30f86dec34298c35e477a97 /layouts
parentd7c90d805f414198a44d1b714363721df38950d6 (diff)
downloadqmk_firmware-b5ebdf1b3a29119e1a414aaf7e2cf7a583853430.tar.gz
qmk_firmware-b5ebdf1b3a29119e1a414aaf7e2cf7a583853430.zip
[Keymap] bcat keymaps and userspace (#10705)
Add Eco keymap, factor Crkbd keymap to community layout, other minor tweaks * Remove outdated Crkbd Ctrl key positioning info * Add Left Alt key to Lily58 keymap * Lily58 no longer overrides default TAPPING_TERM * Refactor Crkbd keymap to use new community layout * Fix underglow animations for Crkbd w/ Split Common * Add initial Eco keymap * Update outdated reference to Crkbd layout * Add keymap links to userspace readme * Add copyright notices to files changed in this PR
Diffstat (limited to 'layouts')
-rw-r--r--layouts/community/split_3x6_3/bcat/config.h34
-rw-r--r--layouts/community/split_3x6_3/bcat/keymap.c72
-rw-r--r--layouts/community/split_3x6_3/bcat/readme.md126
-rw-r--r--layouts/community/split_3x6_3/bcat/rules.mk10
4 files changed, 242 insertions, 0 deletions
diff --git a/layouts/community/split_3x6_3/bcat/config.h b/layouts/community/split_3x6_3/bcat/config.h
new file mode 100644
index 000000000..e177f0ffc
--- /dev/null
+++ b/layouts/community/split_3x6_3/bcat/config.h
@@ -0,0 +1,34 @@
1/* Copyright 2020 Jonathan Rascher
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#pragma once
18
19#if defined(KEYBOARD_crkbd_rev1_common) || defined(KEYBOARD_crkbd_rev1_legacy)
20# define EE_HANDS
21
22# if defined(RGBLIGHT_ENABLE)
23/* Configure RGB for underglow only (first six LEDs on each side). */
24# undef RGBLED_SPLIT
25# define RGBLED_SPLIT \
26 { 6, 6 }
27# endif
28
29# if defined(RGB_MATRIX_ENABLE)
30/* Limit max RGB LED current to avoid tripping controller fuse. */
31# undef RGB_MATRIX_MAXIMUM_BRIGHTNESS
32# define RGB_MATRIX_MAXIMUM_BRIGHTNESS 150
33# endif
34#endif
diff --git a/layouts/community/split_3x6_3/bcat/keymap.c b/layouts/community/split_3x6_3/bcat/keymap.c
new file mode 100644
index 000000000..934a8e31f
--- /dev/null
+++ b/layouts/community/split_3x6_3/bcat/keymap.c
@@ -0,0 +1,72 @@
1/* Copyright 2020 Jonathan Rascher
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
19#include "bcat.h"
20
21enum layer {
22 LAYER_DEFAULT,
23 LAYER_LOWER,
24 LAYER_RAISE,
25 LAYER_ADJUST,
26};
27
28#define LY_LWR MO(LAYER_LOWER)
29#define LY_RSE MO(LAYER_RAISE)
30
31#define KY_CSPC LCTL(KC_SPC)
32#define KY_ZMIN LCTL(KC_EQL)
33#define KY_ZMOUT LCTL(KC_MINS)
34#define KY_ZMRST LCTL(KC_0)
35
36const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
37 /* Default layer: http://www.keyboard-layout-editor.com/#/gists/08d9827d916662a9414f48805aa895a5 */
38 [LAYER_DEFAULT] = LAYOUT_split_3x6_3(
39 KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
40 KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
41 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT,
42 KC_LCTL, LY_LWR, KC_SPC, KC_ENT, LY_RSE, KC_RALT
43 ),
44
45 /* Lower layer: http://www.keyboard-layout-editor.com/#/gists/c3fba5eaa2cd70fdfbdbc0f9e34d3bc0 */
46 [LAYER_LOWER] = LAYOUT_split_3x6_3(
47 MC_ALTT, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, _______,
48 KY_CSPC, KY_ZMRST, KY_ZMOUT, KY_ZMIN, KC_WBAK, KC_WFWD, KC_PIPE, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_TILD,
49 _______, KC_APP, KC_PSCR, KC_SLCK, KC_PAUS, KC_LGUI, KC_BSLS, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_GRV,
50 _______, _______, _______, _______, _______, _______
51 ),
52
53 /* Raise layer: http://www.keyboard-layout-editor.com/#/gists/08b44355d4ca85d294bad9e2821f91d7 */
54 [LAYER_RAISE] = LAYOUT_split_3x6_3(
55 KC_CAPS, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, _______,
56 _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_F11, KC_DEL,
57 _______, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_HOME, KC_PGDN, KC_PGUP, KC_END, KC_F12, KC_INS,
58 _______, _______, _______, _______, _______, _______
59 ),
60
61 /* Adjust layer: http://www.keyboard-layout-editor.com/#/gists/77e7572e077b36a23eb2086017e16fee */
62 [LAYER_ADJUST] = LAYOUT_split_3x6_3(
63 _______, NK_TOGG, KC_MPLY, KC_VOLU, KC_MSTP, _______, EEP_RST, RESET, _______, _______, _______, _______,
64 _______, _______, KC_MPRV, KC_VOLD, KC_MNXT, _______, RGB_RMOD, RGB_VAD, RGB_VAI, RGB_MOD, RGB_SPI, _______,
65 _______, _______, _______, KC_MUTE, _______, _______, RGB_HUI, RGB_SAD, RGB_SAI, RGB_HUD, RGB_SPD, _______,
66 _______, _______, _______, RGB_TOG, _______, _______
67 ),
68};
69
70layer_state_t layer_state_set_keymap(layer_state_t state) {
71 return update_tri_layer_state(state, LAYER_LOWER, LAYER_RAISE, LAYER_ADJUST);
72}
diff --git a/layouts/community/split_3x6_3/bcat/readme.md b/layouts/community/split_3x6_3/bcat/readme.md
new file mode 100644
index 000000000..ed17b8418
--- /dev/null
+++ b/layouts/community/split_3x6_3/bcat/readme.md
@@ -0,0 +1,126 @@
1# bcat's split 3x6 + 3 thumb keys layout
2
3This is my favorite split ergo layout for typing, featuring the traditional
4four ortho/ergo layers (Default, Lower, Raise, Adjust). It is loosely inspired
5by the default Planck (numbers on Lower, symbols on Raise) and Crkbd (Space on
6left, Enter on right) layouts, but has since been redesigned heavily according
7to the principles described below.
8
9* Since my most-frequently-used keyboard shortcuts involve Ctrl, which lives on
10the left half of the keyboard, keys frequently used with it (numbers, function
11keys, etc.) are on the Raise layer activated by the right thumb.
12
13* Navigation can be done on the right half alone, to enable simultaneous
14left-handed mousing. Additionally, Web pages can be scrolled with Space or
15Shift+Space on the left half alone, to enable taking notes with the right hand
16at the same time.
17
18* Other than Right Shift (which I seldom use), mods aren't rebound on layers.
19
20* Likewise, Backspace is not rebound on layers to avoid having to let go of
21layer-switch keys to correct mistakes.
22
23## Default layer
24
25![Default layer layout](https://i.imgur.com/g5N7g8D.png)
26
27([KLE](http://www.keyboard-layout-editor.com/#/gists/08d9827d916662a9414f48805aa895a5))
28
29* The alpha keys are a standard QWERTY layout, no funny business there.
30
31* Tab and Backspace are in familiar locations from my row-staggered boards
32(almost all of which use HHKB-style split backspace).
33
34* The Esc key is next to the home row for convenience in Vim.
35
36* There are two Shift keys, although I generally use Left Shift. (I've
37considered replacing Right Shift with another key, but haven't chosen one.)
38
39* Lower and Raise layer-switch keys are in the resting position of my left and
40right thumbs, respectively.
41
42* Space and Enter are on the big thumb keys so they're easy to press.
43
44* Ctrl is on the left for ease of chording, especially one-handed use of common
45shortcuts like Ctrl+T and Ctrl+W. This puts Alt on the right by the process of
46elimination. (I would really like one more 1U thumb key on each half to allow
47for a redundant Alt key on the left and a dedicated Super key on the right.)
48
49## Lower layer
50
51![Lower layer layout](https://i.imgur.com/vaIc9JY.png)
52
53([KLE](http://www.keyboard-layout-editor.com/#/gists/c3fba5eaa2cd70fdfbdbc0f9e34d3bc0))
54
55* This could also be called the "symbol layer".
56
57* Shifted numbers are bound in their usual positions on the top row.
58
59* Hyphen/Underscore and Equals/Plus are in the right index- and middle-finger
60columns for easy reach. They share the same relative position as on a
61row-staggered keyboard, and the shifted versions are physically above the
62unshifted versions as a mnemonic device.
63
64* Brackets and braces are placed below the parens for easy recall. Once again,
65the shifted versions are on the home row and the unshifted versions are on the
66bottom row.
67
68* Forward Slash/Pipe and Backtick/Tilde fill out the remaining positions on the
69right half, with the same relative positions as on a row-staggered HHKB layout.
70And yup, the shifted versions are above the unshifted versions.
71
72* Remaining keys from a TKL are placed out of the way on the bottom row of the
73left half.
74
75* The home row on the left half contains handy shortcuts for zooming and browser
76navigation.
77
78* Lower+Esc is bound to Ctrl+Space because the Ctrl and Space keys are both on
79the left thumb, so this key combination (which I use for tmux prefix and editor
80autocomplete) is hard to press in its natural location.
81
82* Lower+Tab is bound to a custom Alt+Tab macro that keeps the Alt modifier held
83as long as the Lower key is held down. This means that window switching is on
84Lower+Tab immediately next to browser tab switching (Ctrl+Tab).
85
86## Raise layer
87
88![Raise layer layout](https://i.imgur.com/VNEiV9A.png)
89
90([KLE](http://www.keyboard-layout-editor.com/#/gists/08b44355d4ca85d294bad9e2821f91d7))
91
92* This could also be called the "number layer".
93
94* Unshifted numbers are bound in their usual positions on the top row.
95
96* Arrow keys are on VIM-style HJKL keys.
97
98* Home/End and Page Up/Page Down are in the same column as the arrow keys, but
99translated down one row. (This means that the comma and period keys are not
100bound on the number layer, which makes data entry a bit funky. I might add a
101dedicated numpad layer to compensate.)
102
103* Function keys F1–F10 take up most of remaining space on the left half, with
104F11 and F12 spilling over to the right half. (This puts the most used function
105keys (F1–F5) on the home row.)
106
107* Insert and Delete are on the rightmost column, because there didn't seem to
108be a better place to put them.
109
110* Caps Lock is bound in the same position as on an HHKB, for lack of an obvious
111better location.
112
113## Adjust layer
114
115![Adjust layer layout](https://i.imgur.com/fZouko5.png)
116
117([KLE](http://www.keyboard-layout-editor.com/#/gists/77e7572e077b36a23eb2086017e16fee))
118
119* Media keys are centered around the ESDF cluster, just like I arrange them on
120row-staggered keyboards. (It's even more sensible with columnar stagger.)
121
122* The navigation keys are replaced by RGB controls. Again, this mirrors the
123positioning I use on my row-staggered keyboards.
124
125* Finally, reset keys live at the top-left corner of the right half where it's
126reasonably hard to press them by accident.
diff --git a/layouts/community/split_3x6_3/bcat/rules.mk b/layouts/community/split_3x6_3/bcat/rules.mk
new file mode 100644
index 000000000..3a9796673
--- /dev/null
+++ b/layouts/community/split_3x6_3/bcat/rules.mk
@@ -0,0 +1,10 @@
1ifeq ($(strip $(KEYBOARD)), crkbd/rev1/common)
2 BOOTLOADER = atmel-dfu # Elite-C
3
4 # Enable underglow only. (Split Common doesn't support RGB matrix on slave.)
5 RGBLIGHT_ENABLE = yes
6else ifeq ($(strip $(KEYBOARD)), crkbd/rev1/legacy)
7 BOOTLOADER = atmel-dfu # Elite-C
8
9 RGB_MATRIX_ENABLE = WS2812 # per-key RGB and underglow
10endif