Merge pull request #16 from jackhumbert/master

Forked from jackhumbert/qmk_firmware

keyboards/atreus/keymaps/replicaJunction/keymap.c

@@ -1,7 +1,7 @@
 /*
  * Keyboard: Atreus
  * Keymap:   replicaJunction
- * Version:  0.3
+ * Version:  0.4
  *
  * This keymap is designed to complement my Ergodox keyboard layout, found in keyboards/ergodox_ez.
  * The Atreus keyboard is a 40% board whose design was heavily influenced by the Ergodox. I now
@@ -42,51 +42,157 @@
 #define KX_PAST LCTL(KC_V)
 #define KX_UNDO LCTL(KC_Z)
 
+#define _USER 0 // User macro
+
 ; // This doesn't do anything. It's just for VSCode because its syntax highlighting is weird for the above #define statements.
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+/*
+ * Colemak-ModDH
+ *
+ * ,----------------------------------.                     ,----------------------------------.
+ * |   Q  |   W  |   F  |   P  |   B  |                     |   J  |   L  |   U  |   Y  |   ;  |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |   A  |   R  |   S  |   T  |   G  |                     |   M  |   N  |   E  |   I  |   O  |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |Z Shft|   X  |   C  |   D  |   V  | ,------.   ,------. |   K  |   H  |   ,  |   .  |/ Shft|
+ * +------+------+------+------+------| | Ctrl |   |  Alt | +------+------+------+------+------|
+ * |  Esc |  Gui |  Tab |  _FN | Bksp | |  Del |   | Enter| |Sp/_NU|  _EX |   -  |   '  |   =  |
+ * `----------------------------------' `------'   `------' `----------------------------------'
+ *
+ */
 [_CO] = KEYMAP(
   KC_Q,        KC_W,    KC_F,    KC_P,    KC_B,                                   KC_J,            KC_L,    KC_U,    KC_Y,    KC_SCLN,
   KC_A,        KC_R,    KC_S,    KC_T,    KC_G,                                   KC_M,            KC_N,    KC_E,    KC_I,    KC_O,
   SFT_T(KC_Z), KC_X,    KC_C,    KC_D,    KC_V,                                   KC_K,            KC_H,    KC_COMM, KC_DOT,  SFT_T(KC_SLSH),
-  KC_ESC,      KC_LGUI, KC_TAB,  KC_LALT, KC_BSPC, CTL_T(KC_DEL), ALT_T(KC_ENT),  LT(_NU, KC_SPC), MO(_EX), KC_MINS, KC_QUOT, KC_EQL
+  KC_ESC,      KC_LGUI, KC_TAB,  MO(_FN), KC_BSPC, CTL_T(KC_DEL), ALT_T(KC_ENT),  LT(_NU, KC_SPC), MO(_EX), KC_MINS, KC_QUOT, KC_EQL
 ),
 
+/*
+ * QWERTY
+ *
+ * ,----------------------------------.                     ,----------------------------------.
+ * |   Q  |   W  |   E  |   R  |   T  |                     |   Y  |   U  |   I  |   O  |   P  |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |   A  |   S  |   D  |   F  |   G  |                     |   H  |   J  |   K  |   L  |   ;  |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |Z Shft|   X  |   C  |   V  |   B  | ,------.   ,------. |   N  |   M  |   ,  |   .  |/ Shft|
+ * +------+------+------+------+------| | Ctrl |   |  Alt | +------+------+------+------+------|
+ * |  Esc |  Gui |  Tab |  _FN | Bksp | |  Del |   | Enter| |Sp/_NU|  _EX |   -  |   '  |   =  |
+ * `----------------------------------' `------'   `------' `----------------------------------'
+ *
+ */
 [_QW] = KEYMAP( /* Qwerty */
   KC_Q,        KC_W,    KC_E,    KC_R,    KC_T,                                  KC_Y,            KC_U,    KC_I,    KC_O,    KC_P,
   KC_A,        KC_S,    KC_D,    KC_F,    KC_G,                                  KC_H,            KC_J,    KC_K,    KC_L,    KC_SCLN,
   SFT_T(KC_Z), KC_X,    KC_C,    KC_V,    KC_B,                                  KC_N,            KC_M,    KC_COMM, KC_DOT,  SFT_T(KC_SLSH),
-  KC_ESC,      KC_LGUI, KC_TAB,  KC_LALT, KC_BSPC, CTL_T(KC_DEL), ALT_T(KC_ENT), LT(_NU, KC_SPC), MO(_EX), KC_MINS, KC_QUOT, KC_EQL
+  KC_ESC,      KC_LGUI, KC_TAB,  MO(_FN), KC_BSPC, CTL_T(KC_DEL), ALT_T(KC_ENT), LT(_NU, KC_SPC), MO(_EX), KC_MINS, KC_QUOT, KC_EQL
 ),
 
+/*
+ * Extend
+ *
+ * Ctrl+` is a keyboard shortcut for the program ConEmu, which brings up a dropdown console window.
+ *
+ * Also note that some dual-role keys are overridden here with their modifiers
+ *
+ * ,----------------------------------.                     ,----------------------------------.
+ * |      |      |      |      |Ctrl `|                     | PgUp | Home |   Up |  End |  Del |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |  Gui | Shift|  Alt | Ctrl |      |                     | PgDn | Left | Down | Right| Bksp |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * | Shift|  Cut | Copy |      | Paste| ,------.   ,------. |      | ^Tab |  Tab |      |Insert|
+ * +------+------+------+------+------| |  Del |   | Enter| +------+------+------+------+------|
+ * |      |      |      |      |      | |      |   |      | | Space|XXXXXX|      |      |PrntSc|
+ * `----------------------------------' `------'   `------' `----------------------------------'
+ *
+ */
 [_EX] = KEYMAP( /* Extend */
-  KC_CAPS, _______, _______, _______, _______,                   KC_PGUP, KC_HOME, KC_UP,   KC_END,  KC_DEL,
-  _______, KC_LGUI, KC_LALT, KC_LCTL, _______,                   KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, KC_BSPC,
-  _______, KX_CUT,  KX_COPY, _______, KX_PAST,                   _______, KC_TAB,  KCX_LST, _______, KC_INSERT,
-  _______, _______, _______, _______, _______, _______, _______, KC_SPC,  _______, _______, _______, KC_PSCR
+  _______, _______, _______, _______, LCTL(KC_GRV),              KC_PGUP, KC_HOME, KC_UP,   KC_END,  KC_DEL,
+  KC_LGUI, KC_LSFT, KC_LALT, KC_LCTL, _______,                   KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, KC_BSPC,
+  KC_LSFT, KX_CUT,  KX_COPY, _______, KX_PAST,                   _______, KCX_LST, KC_TAB,  _______, KC_INS,
+  _______, _______, _______, _______, _______, KC_DEL,  KC_ENT,  KC_SPC,  _______, _______, _______, KC_PSCR
 ),
 
+/*
+ * Numbers and symbols
+ *
+ * ,----------------------------------.                     ,----------------------------------.
+ * |   !  |   @  |   {  |   }  |   &  |                     |   /  |   7  |   8  |   9  |   *  |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |   #  |   $  |   (  |   )  |   ~  |                     |   |  |   4  |   5  |   6  |   -  |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |   %  |   ^  |   [  |   ]  |   `  | ,------.   ,------. |   \  |   1  |   2  |   3  |   +  |
+ * +------+------+------+------+------| |      |   |      | +------+------+------+------+------|
+ * |      |  _GA |      |      |      | |      |   |      | |XXXXXX|   0  |   .  |   =  |      |
+ * `----------------------------------' `------'   `------' `----------------------------------'
+ *
+ */
 [_NU] = KEYMAP( /* Numbers and symbols */
   KC_EXLM, KC_AT,   KC_LCBR, KC_RCBR, KC_AMPR,                    KC_SLSH, KC_7,    KC_8,   KC_9,   KC_ASTR,
   KC_HASH, KC_DLR,  KC_LPRN, KC_RPRN, KC_TILD,                    KC_PIPE, KC_4,    KC_5,   KC_6,   KC_MINS,
   KC_PERC, KC_CIRC, KC_LBRC, KC_RBRC, KC_GRV,                     KC_BSLS, KC_1,    KC_2,   KC_3,   KC_PLUS,
-  _______, TG(_GA), _______, MO(_FN), _______, _______,  _______, _______, KC_0,    KC_DOT, KC_EQL, _______
+  _______, TG(_GA), _______, _______, _______, _______,  _______, _______, KC_0,    KC_DOT, KC_EQL, _______
 ),
 
+/*
+ * Functions
+ *
+ * ,----------------------------------.                     ,----------------------------------.
+ * | Caps |  F9  |  F10 |  F11 |  F12 |                     | _USER|Whl Up|  MUp |Whl Dn|      |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |      |  F5  |  F6  |  F7  |  F8  |                     | Vol ^| MLeft| MDown|MRight|      |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |      |  F1  |  F2  |  F3  |  F4  | ,------.   ,------. | Vol v|      |      |      |      |
+ * +------+------+------+------+------| |      |   |RClick| +------+------+------+------+------|
+ * |      |      |      |XXXXXX|      | |      |   |      | |LClick|MClick| _CO  |  _GA | RESET|
+ * `----------------------------------' `------'   `------' `----------------------------------'
+ *
+ */
 [_FN] = KEYMAP( /* Functions */
-  KC_DEL,  KC_HOME, KC_UP,   KC_END,  KC_PGUP,                   _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,
-  KC_BSPC, KC_LEFT, KC_DOWN, KC_RGHT, KC_DOWN,                   _______, KC_F4,   KC_F5,   KC_F6,   KC_F11,
-  _______, KC_VOLU, KC_MUTE, KC_VOLD, KC_MPLY,                   _______, KC_F1,   KC_F2,   KC_F3,   KC_F12,
-  _______, _______, _______, _______, KC_MSTP, _______, _______, _______, KC_NO,   DF(_CO), DF(_QW), RESET
+  KC_CAPS, KC_F9,   KC_F10,  KC_F11,  KC_F12,                    M(_USER),KC_WH_U, KC_MS_U, KC_WH_D, _______,
+  _______, KC_F5,   KC_F6,   KC_F7,   KC_F8,                     KC_VOLU, KC_MS_L, KC_MS_D, KC_MS_R, _______,
+  _______, KC_F1,   KC_F2,   KC_F3,   KC_F4,                     KC_VOLD, _______, _______, _______, _______,
+  _______, _______, _______, _______, _______, _______, KC_BTN2, KC_BTN1, KC_BTN3, DF(_CO), DF(_QW), RESET
 ),
 
+/*
+ * Gaming
+ *
+ * ,----------------------------------.                     ,----------------------------------.
+ * |      |      |      |      |      |                     |      |Whl Up|  MUp |Whl Dn|      |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |      |      |      |      |      |                     |      | MLeft| MDown|MRight|      |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |  Z   |      |      |      |      | ,------.   ,------. |      |      |      |      |      |
+ * +------+------+------+------+------| | Bksp |   |RClick| +------+------+------+------+------|
+ * |      |  _GA |      | Shift| Space| |      |   |      | |LClick|MClick|      |      |      |
+ * `----------------------------------' `------'   `------' `----------------------------------'
+ *
+ */
 [_GA] = KEYMAP( /* Gaming */
   _______, _______, _______, _______, _______,                   _______, KC_WH_U, KC_MS_U, KC_WH_D, _______,
   _______, _______, _______, _______, _______,                   _______, KC_MS_L, KC_MS_D, KC_MS_R, _______,
-  KC_Z,    _______, _______, _______, _______,                   KC_BTN3, _______, KC_MS_D, _______, _______,
-  _______, TG(_GA), _______, KC_LSFT, KC_SPC,  KC_BSPC, KC_BTN2, KC_BTN1, _______, _______, _______, _______
+  KC_Z,    _______, _______, _______, _______,                   _______, _______, KC_MS_D, _______, _______,
+  _______, TG(_GA), _______, KC_LSFT, KC_SPC,  KC_BSPC, KC_BTN2, KC_BTN1, KC_BTN3, _______, _______, _______
 )};
 
+/*
+ * Template
+ *
+ * ,----------------------------------.                     ,----------------------------------.
+ * |      |      |      |      |      |                     |      |      |      |      |      |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |      |      |      |      |      |                     |      |      |      |      |      |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |      |      |      |      |      | ,------.   ,------. |      |      |      |      |      |
+ * +------+------+------+------+------| |      |   |      | +------+------+------+------+------|
+ * |      |      |      |      |      | |      |   |      | |      |      |      |      |      |
+ * `----------------------------------' `------'   `------' `----------------------------------'
+ *
+ */
+
 const uint16_t PROGMEM fn_actions[] = {
 
 };
@@ -95,7 +201,7 @@ const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 {
   // MACRODOWN only works in this function
       switch(id) {
-        case 0:
+        case _USER:
           if (record->event.pressed) {
             register_code(KC_RSFT);
           } else {

keyboards/atreus/keymaps/replicaJunction/readme.md

@@ -10,13 +10,15 @@ I won't claim that this layout is perfect for everyone. It does make several sig
 
 ## Base Layer ##
 
-![Atreus base layout](atreus-replica-base-colemakdh.png)
+![Atreus base layout](atreus-replica-base.png)
 
 The letters on this layout are arranged in the [Colemak Mod-DH layout](https://colemakmods.github.io/mod-dh/).
 
-Note that there are four dual-purpose keys: Shift (Backspace), Ctrl (Delete), Alt (Enter), and Space (Number layer). In QMK, these dual-role keys can be made to hold their primary key by double-tapping the key and holding on the second tap. For example, if I wanted to insert a long string of Spaces, I would tap the Space key, then tap it again and hold. A single press and hold would trigger the secondary function of the key instead.
+The primary mechanism for the Shift keys in this keyboard are the dual-role Z and slash keys. Pressing the key sends the keystroke, while holding the key sends a shift. This is a design choice taken from the xyverz layout, and one I find much more intuitive than a thumb shift. In addition, the pinky doesn't need to stretch as far to reach these keys as it does to reach a standard Shift key.
 
-The secondary Alt on the left bottom row exists to provide a single-hand Alt+Tab shortcut, which would take two rows otherwise.
+Occasionally, when typing the letter Z, I'll hold the key down a fraction of a second too long, and the keyboard will shift instead. If you're not a confident typist, this dual-role Shift key layout is probably not a good solution. In that case, I'd suggest moving Shift onto the Backspace key (press for Backspace, hold for Shift).
+
+In addition to the Shift keys, there are three dual-purpose keys: Ctrl (Delete), Alt (Enter), and Space (Number layer). In QMK, these dual-role keys can be made to hold their primary key with a tap and hold. For example, if I wanted to insert a long string of Spaces, I would tap the Space key, then tap it again and hold. A single press and hold would trigger the secondary function of the key instead.
 
 ## Extend Layer ##
 
@@ -42,9 +44,11 @@ This layer also provides plenty of symbol shortcuts. Most of these can be access
 
 ![Atreus function layer](atreus-replica-function.png)
 
-Function keys (F1-F12) are on this layer, as well as some more generic "functions" such as media keys. I've also set up a mirror image of the arrows from the Extend layer in case I need to use these with my left hand, but I don't do this very often.
+Function keys (F1-F12) are on this layer. Their layout in groups of four comes from Jeremy's Atreus layout in this repository. I'd been using 1-9 in a numpad layout, then adding 10-12 on the side...I suppose it took seeing someone else do it this way for me to realize how much more sense it makes.
+
+On the right side are mouse keys - cursor left/right/up/down, and scroll up/down. Volume keys are also here, though really only because there was room for them (I'm not entirely happy with their positions).
 
-The reset key is on this layer, as well as a toggle from Colemak to QWERTY and back. The QWERTY layer is not currently documented, but it is functionally identical to the base layer except for letter positions.
+Finally, the reset key is on this layer, as well as toggles from Colemak to QWERTY and back. The QWERTY layer is not currently documented, but it is functionally identical to the base layer except for letter positions.
 
 ## Gaming Layer ##
 
@@ -54,4 +58,4 @@ This is a small layer developed to allow some simple gameplay without a mouse. T
 
 The keys on the left hand bring Space into the left thumb's reach, as well as overriding the dual-role Shift with its standard function (Z in both QWERTY and in Colemak). This allows easy Shift presses without blocking the Z key, commonly used in games.
 
-I would probably not consider this a hard-core gaming keyboard, and this layout does have the huge problem of blocking access to the number keys, but for more casual games, it plays quite well. I've used it quite a bit on Minecraft, for example, and I'm quite pleased with it.
+I would probably not consider the Atreus a hard-core gaming keyboard in the first place, and this layout does have the huge problem of blocking access to the number keys, but for more casual games, it plays quite well. I've used it quite a bit on Minecraft, for example, and I'm quite pleased with it.

keyboards/atreus62/keymaps/mneme/Makefile

@@ -0,0 +1,5 @@
+TAP_DANCE_ENABLE = yes
+NKRO_ENABLE = true
+MOUSEKEY_ENABLE = no
+EXTRAKEY_ENABLE = yes
+CONSOLE_ENABLE = no

keyboards/atreus62/keymaps/mneme/README.md

@@ -0,0 +1,56 @@
+<!-- -*- mode: markdown; fill-column: 8192 -*- -->
+
+Mnemes Swedish Bonaza
+=======================
+
+My Layout in process, most of the code is shamelessly stolen from [algernons][algernon] excellent layout
+
+ [algernon]: https://github.com/algernon/ergodox-layout
+
+It's for Windows (current work forces me to) and Swedish (matter of birth) so ymmw.
+
+## Table of Contents
+
+* [Layouts](#layouts)
+    - [Base layer](#base-layer)
+    - [Nav layer](#nav-layer)
+    - [Sym layer](#sym-layer)
+    - [LED states](#led-states)
+
+# Layouts
+
+## Base layer
+
+![Base layer](img/base.png)
+
+
+* The number row doubles as a function row. Short presses produces numbers, long presses produces Fxx
+* The `Shift`, `Alt`, and `Control` modifiers are one-shot.
+* `Backspace` and `Enter` doubles as switches to the `sym` layer when held
+* The `ESC` key also doubles as a one-shot cancel key.
+* The **Lead** key is followed by a sequence of keys.
+    - `LEAD l`   : `lgui+l`.
+    - `LEAD s l` : `λ`.
+    - `LEAD s s` : `¯\_(ツ)_/¯`
+    - `LEAD s f` : `凸(ツ)凸`
+    - `LEAD a *` : Application switching based on position in start menu. Very specific to my computer.
+
+
+## Nav layer
+
+![Nav layer](img/fun.png)
+
+Basic navigation on the right hand and modifiers close
+by for the left. The latter because I tend to use `ctrl+arrows` quite a lot.
+
+## Sym layer
+
+![Sym layer](img/sym.png)
+
+* Easy access to most symbols I use on a daily basis. Most common are on the home row, the rest are grouped as best as I could.
+
+- `eq` : Tapdance, produces `===` and `!==`
+- `fun`: Tapdance, produces `=>` and `() => {\n`
+
+# License
+  GPL-3+

keyboards/atreus62/keymaps/mneme/config.h

@@ -0,0 +1,7 @@
+#define ONESHOT_TIMEOUT 3000
+#define TAPPING_TERM 200
+#define PREVENT_STUCK_MODIFIERS
+
+#define LEADER_TIMEOUT 1000
+
+#include "../../config.h"