2020 February 29 Breaking Changes Update (#8064)
[jackhill/qmk/firmware.git] / keyboards / planck / keymaps / kelorean / keymap.c
CommitLineData
2908c0f9
K
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/>.
ade22f8e 15 */
2908c0f9 16
26eef35f 17#include QMK_KEYBOARD_H
2908c0f9
K
18
19extern keymap_config_t keymap_config;
20
21enum planck_layers {
22 _QWERTY,
23 _COLEMAK,
24 _DVORAK,
25 _LOWER,
26 _RAISE,
27 _PLOVER,
28 _ADJUST
29};
30
31enum planck_keycodes {
32 QWERTY = SAFE_RANGE,
33 COLEMAK,
34 DVORAK,
35 PLOVER,
36 LOWER,
37 RAISE,
38 BACKLIT,
39 EXT_PLV
40};
41
42const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
43
44/* Qwerty
45 * ,-----------------------------------------------------------------------------------.
0e31d85b 46 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Esc |
2908c0f9 47 * |------+------+------+------+------+-------------+------+------+------+------+------|
0e31d85b 48 * | Bksp | A | S | D | F | G | H | J | K | L | ; | " |
2908c0f9 49 * |------+------+------+------+------+------|------+------+------+------+------+------|
0e31d85b 50 * | Shift| Z | X | C | V | B | N | M | , | . | / |Sft/En|
2908c0f9 51 * |------+------+------+------+------+------+------+------+------+------+------+------|
0e31d85b 52 * | Ctrl | Brite| Alt | GUI |Lower | Space |Raise | Left | Up | Down |Ctr/Rt|
2908c0f9
K
53 * `-----------------------------------------------------------------------------------'
54 */
26eef35f
JY
55[_QWERTY] = LAYOUT_planck_grid(
56 KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_ESC,
57 KC_BSPC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
58 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_T(KC_ENT),
59 KC_LCTL, BACKLIT, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_UP, KC_DOWN, CTL_T(KC_RGHT)
60),
2908c0f9
K
61
62/* Colemak
63 * ,-----------------------------------------------------------------------------------.
0e31d85b 64 * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Esc |
2908c0f9 65 * |------+------+------+------+------+-------------+------+------+------+------+------|
0e31d85b 66 * | Bksp | A | R | S | T | D | H | N | E | I | O | " |
2908c0f9 67 * |------+------+------+------+------+------|------+------+------+------+------+------|
0e31d85b 68 * |Sft/Es| Z | X | C | V | B | K | M | , | . | / |Sft/En|
2908c0f9 69 * |------+------+------+------+------+------+------+------+------+------+------+------|
0e31d85b 70 * | Ctrl | Brite| Alt | GUI |Lower | Space |Raise | Left | Up | Down |Ctr/Rt|
2908c0f9
K
71 * `-----------------------------------------------------------------------------------'
72 */
26eef35f
JY
73[_COLEMAK] = LAYOUT_planck_grid(
74 KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_ESC,
75 KC_BSPC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT,
76 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_T(KC_ENT),
77 KC_LCTL, BACKLIT, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_UP, KC_DOWN, CTL_T(KC_RGHT)
78),
2908c0f9
K
79
80/* Dvorak
81 * ,-----------------------------------------------------------------------------------.
0e31d85b 82 * | Tab | " | , | . | P | Y | F | G | C | R | L | Esc |
2908c0f9 83 * |------+------+------+------+------+-------------+------+------+------+------+------|
0e31d85b 84 * | Bksp | A | O | E | U | I | D | H | T | N | S | " |
2908c0f9 85 * |------+------+------+------+------+------|------+------+------+------+------+------|
0e31d85b 86 * |Sft/Es| ; | Q | J | K | X | B | M | W | V | Z |Sft/En|
2908c0f9 87 * |------+------+------+------+------+------+------+------+------+------+------+------|
0e31d85b 88 * | Ctrl | Brite| Alt | GUI |Lower | Space |Raise | Left | Up | Down |Ctr/Rt|
2908c0f9
K
89 * `-----------------------------------------------------------------------------------'
90 */
26eef35f
JY
91[_DVORAK] = LAYOUT_planck_grid(
92 KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_ESC,
93 KC_BSPC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_QUOT,
94 KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, SFT_T(KC_ENT),
95 KC_LCTL, BACKLIT, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_UP, KC_DOWN, CTL_T(KC_RGHT)
96),
2908c0f9
K
97
98/* Lower
99 * ,-----------------------------------------------------------------------------------.
100 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
101 * |------+------+------+------+------+-------------+------+------+------+------+------|
102 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
103 * |------+------+------+------+------+------|------+------+------+------+------+------|
104 * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | Home | End | |
105 * |------+------+------+------+------+------+------+------+------+------+------+------|
106 * | | | | | | | | Next | Vol- | Vol+ | Play |
107 * `-----------------------------------------------------------------------------------'
108 */
26eef35f
JY
109[_LOWER] = LAYOUT_planck_grid(
110 KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC,
111 KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE,
112 _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, S(KC_NUHS), S(KC_NUBS), KC_HOME, KC_END, _______,
113 _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
114),
2908c0f9
K
115
116/* Raise
117 * ,-----------------------------------------------------------------------------------.
118 * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
119 * |------+------+------+------+------+-------------+------+------+------+------+------|
120 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ |
121 * |------+------+------+------+------+------|------+------+------+------+------+------|
122 * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO # |ISO / |Pg Up |Pg Dn | |
123 * |------+------+------+------+------+------+------+------+------+------+------+------|
124 * | | | | | | | | Next | Vol- | Vol+ | Play |
125 * `-----------------------------------------------------------------------------------'
126 */
26eef35f
JY
127[_RAISE] = LAYOUT_planck_grid(
128 KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC,
129 KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS,
130 _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, _______,
131 _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
132),
2908c0f9
K
133
134/* Plover layer (http://opensteno.org)
135 * ,-----------------------------------------------------------------------------------.
136 * | # | # | # | # | # | # | # | # | # | # | # | # |
137 * |------+------+------+------+------+-------------+------+------+------+------+------|
138 * | | S | T | P | H | * | * | F | P | L | T | D |
139 * |------+------+------+------+------+------|------+------+------+------+------+------|
140 * | | S | K | W | R | * | * | R | B | G | S | Z |
141 * |------+------+------+------+------+------+------+------+------+------+------+------|
142 * | Exit | | | A | O | | E | U | | | |
143 * `-----------------------------------------------------------------------------------'
144 */
145
26eef35f
JY
146[_PLOVER] = LAYOUT_planck_grid(
147 KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 ,
148 XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC,
149 XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
150 EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX
151),
2908c0f9
K
152
153/* Adjust (Lower + Raise)
154 * ,-----------------------------------------------------------------------------------.
155 * | | Reset| | | | | | | | | | Del |
156 * |------+------+------+------+------+-------------+------+------+------+------+------|
157 * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
158 * |------+------+------+------+------+------|------+------+------+------+------+------|
159 * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
160 * |------+------+------+------+------+------+------+------+------+------+------+------|
161 * | | | | | | | | | | | |
162 * `-----------------------------------------------------------------------------------'
163 */
26eef35f
JY
164[_ADJUST] = LAYOUT_planck_grid(
165 _______, RESET, DEBUG, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, KC_DEL ,
166 _______, _______, MU_MOD, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______,
167 _______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, TERM_ON, TERM_OFF, _______, _______, _______,
168 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
169)
2908c0f9
K
170
171
172};
173
174#ifdef AUDIO_ENABLE
175 float plover_song[][2] = SONG(PLOVER_SOUND);
176 float plover_gb_song[][2] = SONG(PLOVER_GOODBYE_SOUND);
177#endif
178
179bool process_record_user(uint16_t keycode, keyrecord_t *record) {
180 switch (keycode) {
181 case QWERTY:
182 if (record->event.pressed) {
183 print("mode just switched to qwerty and this is a huge string\n");
184 set_single_persistent_default_layer(_QWERTY);
185 }
186 return false;
187 break;
188 case COLEMAK:
189 if (record->event.pressed) {
190 set_single_persistent_default_layer(_COLEMAK);
191 }
192 return false;
193 break;
194 case DVORAK:
195 if (record->event.pressed) {
196 set_single_persistent_default_layer(_DVORAK);
197 }
198 return false;
199 break;
200 case LOWER:
201 if (record->event.pressed) {
202 layer_on(_LOWER);
203 update_tri_layer(_LOWER, _RAISE, _ADJUST);
204 } else {
205 layer_off(_LOWER);
206 update_tri_layer(_LOWER, _RAISE, _ADJUST);
207 }
208 return false;
209 break;
210 case RAISE:
211 if (record->event.pressed) {
212 layer_on(_RAISE);
213 update_tri_layer(_LOWER, _RAISE, _ADJUST);
214 } else {
215 layer_off(_RAISE);
216 update_tri_layer(_LOWER, _RAISE, _ADJUST);
217 }
218 return false;
219 break;
220 case BACKLIT:
221 if (record->event.pressed) {
222 register_code(KC_RSFT);
223 #ifdef BACKLIGHT_ENABLE
224 backlight_step();
225 #endif
226 PORTE &= ~(1<<6);
227 } else {
228 unregister_code(KC_RSFT);
229 PORTE |= (1<<6);
230 }
231 return false;
232 break;
233 case PLOVER:
234 if (record->event.pressed) {
235 #ifdef AUDIO_ENABLE
236 stop_all_notes();
237 PLAY_SONG(plover_song);
238 #endif
239 layer_off(_RAISE);
240 layer_off(_LOWER);
241 layer_off(_ADJUST);
242 layer_on(_PLOVER);
243 if (!eeconfig_is_enabled()) {
244 eeconfig_init();
245 }
246 keymap_config.raw = eeconfig_read_keymap();
247 keymap_config.nkro = 1;
248 eeconfig_update_keymap(keymap_config.raw);
249 }
250 return false;
251 break;
252 case EXT_PLV:
253 if (record->event.pressed) {
254 #ifdef AUDIO_ENABLE
255 PLAY_SONG(plover_gb_song);
256 #endif
257 layer_off(_PLOVER);
258 }
259 return false;
260 break;
261 }
262 return true;
263}