[Keymap] Add userspace and personal keymaps (#7093)

* Add Planck keymap and custom keycodes to userspace * Add Preonic keymap and extract common ortho layers and keycodes * Add Leaf60 WKL keymap * Add M60-A keymap * Add Levinson keymap * Fix links in personal readmes * Use flash target * Remove duplicate definition Co-Authored-By: fauxpark <fauxpark@gmail.com> * Remove superfluous line endings * Planck and preonic encoder should have the same behavior * Use higher level API Co-Authored-By: fauxpark <fauxpark@gmail.com> * Use layouts to reduce planck/levinson duplication * Update flash instructions for levinson
2019-10-22 10:41:14 -07:00
parent e214f2826e
commit d99f6e95e1
19 changed files with 1045 additions and 0 deletions
@@ -0,0 +1,19 @@
+/* Copyright 2019 Fox Lab
+ *
+ * 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
+
+// place overrides here
@@ -0,0 +1,43 @@
+/* Copyright 2019 Fox Lab
+ *
+ * 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 "mguterl.h"
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+	[_QWERTY] = LAYOUT_all(
+		KC_GESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSLS, KC_GRV,
+		HPR_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSPC,
+		ESC_CTL, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT,
+		KC_LSFT, KC_NO, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, MO(UTIL),
+		KC_LALT, KC_LALT, KC_LGUI, SPC_UTL, SPC_UTL, SPC_UTL, KC_RALT, MO(1), KC_RGUI, KC_RCTL),
+
+	[_GAMING] = LAYOUT_all(
+		KC_ESC,  _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		KC_TAB,  _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, KC_SPC,  _______, _______, _______, _______, _______),
+
+	[_UTIL] = LAYOUT_all(
+		RESET,   KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______, _______,
+		TG_GAME, KC_MPLY, KC_MPRV, KC_MNXT, _______, _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END, _______, _______, _______, _______,
+		_______, KC_VOLD, KC_VOLU, KC_MUTE, _______, _______, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______)
+
+
+};
@@ -0,0 +1,11 @@
+# Michael Guterl's Leaf60 WKL Layout
+
+Check out my [userspace](/users/mguterl) for the custom keycodes that are used
+in keymap.c.
+
+This is a pretty standard 60% WKL layout. I add a couple of layers to add
+some conveniences and add vimkeys for navigation.
+
+```sh
+make foxlab/leaf60/universal:mguterl:flash
+```
@@ -0,0 +1,37 @@
+#pragma once
+
+#ifdef AUDIO_ENABLE
+    #define STARTUP_SONG SONG(PREONIC_SOUND)
+    // #define STARTUP_SONG SONG(NO_SOUND)
+
+    #define DEFAULT_LAYER_SONGS { SONG(QWERTY_SOUND), \
+                                  SONG(COLEMAK_SOUND), \
+                                  SONG(DVORAK_SOUND) \
+                                }
+#endif
+
+#define MUSIC_MASK (keycode != KC_NO)
+
+/*
+ * 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
@@ -0,0 +1,18 @@
+# Michael Guterl's Preonic Layout
+
+I have a very similar [keymap](/keyboards/planck/keymaps/mguterl) for my
+Planck.
+
+Check out my [userspace](/users/mguterl) for the custom keycodes that are used
+in keymap.c.
+
+At a very high level I use 4 layers:
+
+* Qwerty - Letters
+* Util   - Vimkeys for navigation and other convenient things
+* Raise  - Numbers and F keys
+* Lower  - Symbols
+
+```sh
+make preonic/rev3:mguterl:flash
+```
@@ -0,0 +1 @@
+SRC += muse.c
@@ -0,0 +1,82 @@
+#include QMK_KEYBOARD_H
+
+
+#define QWER 0
+#define GAMING 1
+#define HHKB 2
+#define UTIL 3
+#define LIGHTING 4
+#define HPR_TAB ALL_T(KC_TAB) // Tap for Tab, hold for Hyper (Super+Ctrl+Shift+Alt)
+#define TG_GAME TG(GAMING)
+
+enum custom_keycodes {
+    FN_HHKB = SAFE_RANGE,
+    FN_UTIL
+};
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record)
+{
+	switch(keycode) {
+		case FN_HHKB:
+			if (record->event.pressed) {
+				layer_on(2);
+				update_tri_layer(2, 3, 4);
+			} else {
+				layer_off(2);
+				update_tri_layer(2, 3, 4);
+			}
+			return false;
+			break;
+		case FN_UTIL:
+			if (record->event.pressed) {
+				layer_on(3);
+				update_tri_layer(2, 3, 4);
+			} else {
+				layer_off(3);
+				update_tri_layer(2, 3, 4);
+			}
+			return false;
+			break;
+    default:
+      return true;
+	}
+}
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+[QWER] = LAYOUT_60_hhkb(
+	KC_GESC, KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL,  KC_BSLS, KC_GRV,
+	HPR_TAB, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC, KC_RBRC, KC_BSPC,
+	KC_LCTL, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT, KC_ENT,
+	KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT, FN_HHKB,
+	         KC_LALT, KC_LGUI,                            LT(UTIL, KC_SPC),                   KC_RGUI, FN_UTIL),
+
+[GAMING] = LAYOUT_60_hhkb(
+	_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,  _______, _______,
+	 KC_TAB, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,  _______,
+	_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+	_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+	         _______, _______,                             KC_SPC,                            _______, _______),
+
+[HHKB] = LAYOUT_60_hhkb(
+	KC_GRV,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_INS,  KC_DEL,
+	KC_CAPS, _______, _______, _______, _______, _______, _______, _______, KC_PSCR, KC_SLCK, KC_PAUS, KC_UP,   _______, _______,
+	_______, KC_VOLD, KC_VOLU, KC_MUTE, KC_EJCT, _______, KC_PAST, KC_PSLS, KC_HOME, KC_PGUP, KC_LEFT, KC_RGHT, _______,
+	_______, _______, _______, _______, _______, _______, KC_PPLS, KC_PMNS, KC_END,  KC_PGDN, KC_DOWN, _______, _______,
+	         _______, _______,                            _______,                            _______, _______),
+
+[UTIL] = LAYOUT_60_hhkb(
+	_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+	_______, KC_MPLY, KC_MPRV, KC_MNXT, _______, _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END,  _______, _______, _______, _______,
+	_______, KC_VOLD, KC_VOLU, KC_MUTE, _______, _______, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, _______, _______, _______,
+	_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+	         _______, _______,                            _______,                            _______, _______),
+
+[LIGHTING] = LAYOUT_60_hhkb(
+	RESET,   EF_DEC,  EF_INC,  H1_DEC,  H1_INC,  H2_DEC,  H2_INC,  _______, _______, _______, _______, BR_DEC,  BR_INC,  _______, _______,
+	TG_GAME, _______, _______, S1_DEC,  S1_INC,  S2_DEC,  S2_INC,  _______, _______, _______, _______, ES_DEC,  ES_INC,  _______,
+	_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+	_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+	         _______, _______,                            _______,                            _______, _______),
+
+};
@@ -0,0 +1,15 @@
+# Michael Guterl's M60-A Layout
+
+Check out my [userspace](/users/mguterl) for the custom keycodes that are used
+in keymap.c.
+
+This is a pretty standard HHKB layout. I add a couple of layers to add
+some conveniences and add vimkeys for navigation.
+
+If you flash a layout without RESET then you can unplug the keyboard, hold
+spacebar and escape, and then plug the keyboard back. This sequence of
+actions will allow you to flash the keyboard.
+
+```sh
+make wilba_tech/rama_works_m60a:mguterl:flash
+```
@@ -0,0 +1 @@
+DYNAMIC_KEYMAP_ENABLE = no
@@ -0,0 +1,39 @@
+#pragma once
+
+#ifdef AUDIO_ENABLE
+    #define STARTUP_SONG SONG(PLANCK_SOUND)
+    // #define STARTUP_SONG SONG(NO_SOUND)
+
+    #define DEFAULT_LAYER_SONGS { SONG(QWERTY_SOUND), \
+                                  SONG(COLEMAK_SOUND), \
+                                  SONG(DVORAK_SOUND) \
+                                }
+#endif
+
+/*
+ * 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
+
@@ -0,0 +1,20 @@
+# Michael Guterl's Ortho 4x12 Layout
+
+I use this layout for both my Planck and Levinson. I also have a very similar
+[keymap](/keyboards/preonic/keymaps/mguterl) for my Preonic.
+
+Check out my [userspace](/users/mguterl) for the custom keycodes that are used
+in keymap.c.
+
+At a very high level I use 4 layers:
+
+* Qwerty - Letters
+* Util   - Vimkeys for navigation and other convenient things
+* Raise  - Numbers and F keys
+* Lower  - Symbols
+
+```sh
+make planck/rev5:mguterl:flash        # For Planck rev5 or earlier and Planck Light
+make planck/rev6:mguterl:flash        # For Planck rev6
+make keebio/levinson/rev2:mguterl:dfu # For Levinson rev2
+```
@@ -0,0 +1 @@
+SRC += muse.c
@@ -0,0 +1 @@
+#include "mguterl.h"
@@ -0,0 +1,67 @@
+#pragma once
+#include "quantum.h"
+
+#define LOWER MO(_LOWER)
+#define RAISE MO(_RAISE)
+
+/* Tap for Tab, hold for Hyper (Super+Ctrl+Shift+Alt) */
+#define HPR_TAB ALL_T(KC_TAB)
+
+/* Shift when held, Enter when tapped */
+#define SFT_ENT MT(MOD_RSFT, KC_ENT)
+
+/* Activate util layer while holding space */
+#define SPC_UTL LT(_UTIL, KC_SPC)
+
+/* Control when held, Escape when tapped */
+#define ESC_CTL MT(MOD_LCTL, KC_ESC)
+
+/* Toggle gaming layer */
+#define TG_GAME TG(_GAMING)
+
+/*
+ * Make it easy to navigate back and forward in Chrome.
+ */
+#define GO_BACK LGUI(KC_LBRC)
+#define GO_FWD  LGUI(KC_RBRC)
+
+/*
+ * When using a 40% layout, these keycodes make it easy to change tabs in apps
+ * like Chrome and VSCode.
+ */
+#define GUI_1 LGUI(KC_1)
+#define GUI_2 LGUI(KC_2)
+#define GUI_3 LGUI(KC_3)
+#define GUI_4 LGUI(KC_4)
+#define GUI_5 LGUI(KC_5)
+#define GUI_6 LGUI(KC_6)
+#define GUI_7 LGUI(KC_7)
+#define GUI_8 LGUI(KC_8)
+#define GUI_9 LGUI(KC_9)
+#define GUI_0 LGUI(KC_0)
+
+/*
+ * Common layers and keycodes that are shared between Planck and Preonic
+ */
+enum ortho_layers {
+  _QWERTY,
+  _GAMING,
+  _UTIL,
+  _COLEMAK,
+  _DVORAK,
+  _LOWER,
+  _RAISE,
+  _PLOVER,
+  _ADJUST
+};
+
+enum ortho_keycodes {
+  QWERTY = SAFE_RANGE,
+  GAMING,
+  UTIL,
+  COLEMAK,
+  DVORAK,
+  PLOVER,
+  BACKLIT,
+  EXT_PLV
+};
@@ -0,0 +1,14 @@
+Copyright 2019 Michael Guterl michael@diminishing.org @mguterl
+
+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/>.
@@ -0,0 +1 @@
+SRC += mguterl.c