Merge pull request #988 from jcowgar/master

Added Jeremy’s developers keymap for the Planck

2 files changed, 265 insertions, 0 deletions

diff --git a/keyboards/planck/keymaps/jeremy-dev/keymap.c b/keyboards/planck/keymaps/jeremy-dev/keymap.c
new file mode 100644
index 0000000000..e7ed09b122
--- /dev/null
+++ b/keyboards/planck/keymaps/jeremy-dev/keymap.c
@@ -0,0 +1,180 @@
+// This is the personal keymap of Jeremy Cowgar (@jcowgar). It is written for the programmer.
+
+// Configuration options
+#define PREVENT_STUCK_MODIFIERS
+
+#include "planck.h"
+#include "action_layer.h"
+#include "eeconfig.h"
+
+// Each layer gets a name for readability, which is then used in the keymap matrix below.
+enum my_layers {
+  ALPH = 0,
+  NUMS,
+  CURS,
+  SYMB,
+  FKEY
+};
+
+// Each macro gets a name for readability.
+enum my_keycodes {
+  MY_ABVE = SAFE_RANGE,
+  MY_BELW,
+  MY_TERM,
+  MY_DEQL, // /=
+  MY_MEQL, // *=
+  MY_SEQL, // -=
+  MY_PEQL, // +=
+  MY_NEQL, // !=
+  MY_LTGT, // <>
+  MY_DPIP, // ||
+  MY_DAMP, // &&
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [ALPH] = {
+    {KC_Q,          KC_W,      KC_E,      KC_R,      KC_T,    KC_LBRC,        KC_RBRC,        KC_Y,    KC_U,      KC_I,      KC_O,      KC_P},
+    {KC_A,          KC_S,      KC_D,      KC_F,      KC_G,    KC_LPRN,        KC_RPRN,        KC_H,    KC_J,      KC_K,      KC_L,      KC_SCLN},
+    {SFT_T(KC_Z),   KC_X,      KC_C,      KC_V,      KC_B,    KC_LCBR,        KC_RCBR,        KC_N,    KC_M,      KC_COMM,   KC_DOT,    SFT_T(KC_SLSH)},
+    {CTL_T(KC_TAB), OSL(FKEY), OSL(NUMS), OSL(SYMB), KC_SPC,  ALT_T(KC_BSPC), GUI_T(KC_DELT), KC_ENT,  OSL(SYMB), OSL(CURS), TG(CURS),  CTL_T(KC_ESC)}
+  },
+  [NUMS] = {
+    {KC_NO,         KC_NO,     KC_NO,     KC_NO,     KC_NO,   KC_TRNS,        KC_TRNS,        KC_COMM, KC_7,      KC_8,      KC_9,      KC_SLSH},
+    {KC_LSFT,       KC_LGUI,   KC_LALT,   KC_LCTL,   KC_NO,   KC_TRNS,        KC_TRNS,        KC_LPRN, KC_4,      KC_5,      KC_6,      KC_ASTR},
+    {KC_NO,         KC_NO,     KC_NO,     KC_NO,     KC_NO,   KC_TRNS,        KC_TRNS,        KC_RPRN, KC_1,      KC_2,      KC_3,      KC_MINS},
+    {KC_NO,         KC_NO,     KC_TRNS,   TG(NUMS),  KC_TRNS, KC_TRNS,        KC_TRNS,        KC_TRNS, KC_0,      KC_DOT,    KC_EQL,    KC_PLUS}
+  },
+  [CURS] = {
+    {KC_MPLY,       KC_BSPC,   KC_UP,     KC_DELT,   KC_PGUP, KC_TRNS,        KC_TRNS,        KC_NO,   KC_NO,     KC_NO,     KC_NO,     KC_NO},
+    {KC_VOLU,       KC_LEFT,   KC_DOWN,   KC_RGHT,   KC_PGDN, KC_TRNS,        KC_TRNS,        KC_NO,   KC_LCTL,   KC_LALT,   KC_LGUI,   KC_LSFT},
+    {KC_VOLD,       KC_NO,     MY_ABVE,   MY_TERM,   KC_NO,   KC_TRNS,        KC_TRNS,        KC_NO,   KC_NO,     KC_NO,     KC_NO,     KC_LSFT},
+    {KC_MUTE,       KC_NO,     MY_BELW,   KC_NO,     KC_TRNS, KC_TRNS,        KC_TRNS,        KC_TRNS, KC_NO,     KC_TRNS,   KC_TRNS,   KC_NO}
+  },
+  [SYMB] = {
+    {MY_DEQL,       MY_MEQL,   MY_SEQL,   MY_PEQL,   MY_NEQL, KC_NO,          KC_NO,          MY_LTGT, KC_LABK,   KC_RABK,   KC_COLN,   KC_DLR},
+    {KC_SLSH,       KC_ASTR,   KC_MINS,   KC_PLUS,   KC_EQL,  KC_NO,          KC_PIPE,        MY_DPIP, KC_GRV,    KC_QUOT,   KC_DQUO,   KC_HASH},
+    {KC_BSLS,       KC_CIRC,   KC_PERC,   KC_UNDS,   KC_NO,   KC_NO,          KC_AMPR,        MY_DAMP, KC_TILD,   KC_AT,     KC_EXLM,   KC_QUES},
+    {KC_NO,         KC_NO,     KC_NO,     KC_TRNS,   KC_NO,   KC_TRNS,        KC_TRNS,        KC_TRNS, KC_TRNS,   KC_NO,     KC_NO,     KC_NO}
+  },
+  [FKEY] = {
+    {KC_NO,         KC_NO,     KC_NO,     KC_NO,     KC_NO,   KC_NO,          KC_NO,          KC_NO,   KC_F9,     KC_F10,    KC_F11,    KC_F12},
+    {KC_LSFT,       KC_LGUI,   KC_LALT,   KC_LCTL,   KC_NO,   KC_NO,          KC_NO,          KC_NO,   KC_F5,     KC_F6,     KC_F7,     KC_F8},
+    {KC_NO,         KC_NO,     KC_NO,     KC_NO,     KC_NO,   KC_NO,          KC_NO,          KC_NO,   KC_F1,     KC_F2,     KC_F3,     KC_F4},
+    {KC_NO,         KC_TRNS,   KC_NO,     KC_NO,     KC_NO,   KC_NO,          KC_NO,          KC_NO,   KC_NO,     KC_NO,     KC_NO,     KC_NO}
+  }
+};
+
+void press_key(uint16_t key) {
+  register_code(key);
+  unregister_code(key);
+}
+
+void press_two_keys(uint16_t key1, uint16_t key2) {
+  register_code(key1);
+  register_code(key2);
+  unregister_code(key2);
+  unregister_code(key1);
+}
+
+void press_three_keys(uint16_t key1, uint16_t key2, uint16_t key3) {
+  register_code(key1);
+  register_code(key2);
+  register_code(key3);
+  unregister_code(key3);
+  unregister_code(key2);
+  unregister_code(key1);
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  switch (keycode) {
+    case MY_BELW:
+      if (record->event.pressed) {
+        press_two_keys(KC_LGUI, KC_RGHT);
+        press_key(KC_ENT);
+      }
+
+      return false;
+
+    case MY_ABVE:
+      if (record->event.pressed) {
+        press_two_keys(KC_LGUI, KC_LEFT);
+        press_key(KC_ENT);
+        press_key(KC_UP);
+      }
+
+      return false;
+
+    case MY_TERM:
+      if (record->event.pressed) {
+        press_three_keys(KC_LGUI, KC_LSFT, KC_ENT);
+      }
+
+      return false;
+
+    case MY_DEQL: // /=
+      if (record->event.pressed) {
+        press_key(KC_SLSH);
+        press_key(KC_EQL);
+      }
+
+      return false;
+
+    case MY_MEQL: // *=
+      if (record->event.pressed) {
+        press_two_keys(KC_LSFT, KC_ASTR);
+        press_key(KC_EQL);
+      }
+
+      return false;
+
+    case MY_SEQL: // -=
+      if (record->event.pressed) {
+        press_key(KC_MINS);
+        press_key(KC_EQL);
+      }
+
+      return false;
+
+    case MY_PEQL: // +=
+      if (record->event.pressed) {
+        press_two_keys(KC_LSFT, KC_PLUS);
+        press_key(KC_EQL);
+      }
+
+      return false;
+
+    case MY_NEQL: // !=
+      if (record->event.pressed) {
+        press_two_keys(KC_LSFT, KC_EXLM);
+        press_key(KC_EQL);
+      }
+
+      return false;
+
+    case MY_LTGT: // <>
+      if (record->event.pressed) {
+        press_two_keys(KC_LSFT, KC_LABK);
+        press_two_keys(KC_LSFT, KC_RABK);
+      }
+
+      return false;
+
+    case MY_DPIP: // ||
+      if (record->event.pressed) {
+        press_two_keys(KC_LSFT, KC_PIPE);
+        press_two_keys(KC_LSFT, KC_PIPE);
+      }
+
+      return false;
+
+    case MY_DAMP: // &&
+      if (record->event.pressed) {
+        press_two_keys(KC_LSFT, KC_AMPR);
+        press_two_keys(KC_LSFT, KC_AMPR);
+      }
+
+      return false;
+  }
+
+  return true;
+}
diff --git a/keyboards/planck/keymaps/jeremy-dev/readme.md b/keyboards/planck/keymaps/jeremy-dev/readme.md
new file mode 100644
index 0000000000..b6a402d698
--- /dev/null
+++ b/keyboards/planck/keymaps/jeremy-dev/readme.md
@@ -0,0 +1,85 @@
+Jeremy Cowgar's Planck Keymap
+=============================
+
+I am a programmer by trade and suffer from the beginning stages of RSI. As a programmer, I use letters, symbols and cursor navigation most often. To prevent strange finger gymnastics, I wrote a script to rank which non-letter characters occurred in my primary source projects most often and then placed these characters in the easiest to reach locations, within reason and for me. I made heavy use of momentary layer toggling.
+
+Layers
+------
+
+The key mapping is made up of 5 layers: Letters, Symbols, Navigation, Numbers, and Function Keys.
+
+The layout can be viewed visually at:
+
+http://www.keyboard-layout-editor.com/#/gists/319474e5e2d199e583371ed1d2aec316
+
+* Purple buttons are dual function keys.
+* Green buttons are layer momentary toggle keys.
+* Red buttons are layer persistent toggle keys.
+
+The keys have multiple symbols:
+
+* Upper left: standard layer, the letter layer
+* Upper right: function layer
+* Lower left: navigation layer
+* Lower right: symbol layer
+
+The symbols in the layout editor are not entirely clear.
+
+The Z and ? keys double as shift keys. Hold for a shift, tap for a Z or ?
+
+The bottom row from left to right:
+
+* Tab when pressed, Control when held. It also is the volume mute key when in the "Navigation" layer
+* Function layer momentary toggle
+* Number layer momentary toggle
+* Symbol layer momentary toggle. When in the "Number" layer, this key also makes the "Number" layer sticky for using the 10 key for quite a bit of entry
+* Space
+* Backspace when tapped, Option when held
+* Delete when tapped, Command when held
+* Return
+* Symbol layer momentary toggle. When in the "Number" layer, key also is the zero key.
+* Navigation layer momentary toggle
+* Navigation layer toggle. This was included for when you are browsing a website, document or otherwise wish to stay in navigation mode. When in the "Number" layer, the key is the = symbol
+* Escape when pressed, Control when held. When in the "Number" layer, the key is the + symbol
+
+General Notes
+-------------
+
+The letter layer is separated by 2 center rows of keys. This spreads the hands out a little further which helps not twist the wrists as much. The 2 center rows are [], (), [], and Ctrl and Alt keys.
+
+The symbol layer keys are accessed by the thumbs. They are the closest to the thumbs, instead of the number toggle, because in my code I found I used symbols much more often than numbers. There are two symbol layer keys because the symbols spread across the right and left half of the keyboard. Thus, some symbols are easier hit with the left hand modifier or right hand modifier.
+
+The number layer key is only accessible by the left thumb because all of the number keys are on the right side of the keyboard. When in the number layer, you can press the key to the right to make that layer sticky when you are going to do a lot of number entry.
+
+The function layer key is only accessible by the left thumb because all of the function keys are on the right side of the keyboard.
+
+The navigation layer key is only accessible by the right thumb because all of the navigation keys are on the left side of the keyboard. You can press the key to the right of the navigation layer to make the navigation layer sticky when you are doing a lot of navigation, reading a web page for example.
+
+When using the number or navigation layers, the same hand that accesses the momentary layer toggle key also has the 4 primary modifiers under their home row.
+
+* Pointer finger is control
+* Middle finger is option
+* Ring finger is command
+* Pinky finger is shift
+
+This is so you can easily press Cmd+Shift+F4 or when navigating, select text or words of text by pressing Shift+Control, for example.
+
+Some keys are duplicated. For example, () are available in easy to reach locations while in the Number layer because they are often used in math.
+
+The symbol layer has additional helpers for programming including a single keys that enter /=, \*=, -=, +=, !=, <>, ||, and &&. It also includes three special Return keys on the left:
+
+* Up CR which moves the cursor up, to the end of the line and then presses CR
+* Down CR which moves the cursor to the end of the line and then presses CR
+* Right ; which moves the cursor to the end of the line and presses ; for C styled languages, such as JavaScript which is a primary language I use
+
+Word of Warning
+---------------
+
+I have been using the keymap for some time now and believe it to be a good keymap. There are a few things through the week that I wonder if it would have been better if this key were moved to that location.
+
+This keymap may change for further optimization.
+
+Please Give Feedback!
+---------------------
+
+I am very interested in your feedback. Send me a message here on GitHub, r/jcowgar or @jcowgar.