Added comments with ASCII art keymaps

1 files changed, 105 insertions, 1 deletions

diff --git a/keyboards/atreus/keymaps/replicaJunction/keymap.c b/keyboards/atreus/keymaps/replicaJunction/keymap.c
index f7ef1174d..4d46db69e 100644
--- a/keyboards/atreus/keymaps/replicaJunction/keymap.c
+++ b/keyboards/atreus/keymaps/replicaJunction/keymap.c
@@ -45,6 +45,21 @@
 ; // 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 |  Alt | 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,
@@ -52,6 +67,20 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
   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
 ),
 
+/*
+ * 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 |  Alt | 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,
@@ -59,13 +88,45 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
   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
 ),
 
+/*
+ * 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
+ *
+ * ,----------------------------------.                     ,----------------------------------.
+ * | Caps |      |      |      |Ctrl `|                     | PgUp | Home |   Up |  End |  Del |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |      |  Gui |  Alt | Ctrl |      |                     | PgDn | Left | Down | Right| Bksp |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * | Shift|  Cut | Copy |      | Paste| ,------.   ,------. |      | ^Tab |  Tab |      |Insert|
+ * +------+------+------+------+------| |      |   |      | +------+------+------+------+------|
+ * |      |      |      |      |      | |      |   |      | | Space|      |      |      |PrntSc|
+ * `----------------------------------' `------'   `------' `----------------------------------'
+ *
+ */
 [_EX] = KEYMAP( /* Extend */
   KC_CAPS, _______, _______, _______, LCTL(KC_GRV),              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_LSFT, KX_CUT,  KX_COPY, _______, KX_PAST,                   _______, KCX_LST, KC_TAB,  _______, KC_INS,
   _______, _______, _______, _______, _______, _______, _______, KC_SPC,  _______, _______, _______, KC_PSCR
 ),
 
+/*
+ * Numbers and symbols
+ *
+ * ,----------------------------------.                     ,----------------------------------.
+ * |   !  |   @  |   {  |   }  |   &  |                     |   /  |   7  |   8  |   9  |   *  |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |   #  |   $  |   (  |   )  |   ~  |                     |   |  |   4  |   5  |   6  |   -  |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |   %  |   ^  |   [  |   ]  |   `  | ,------.   ,------. |   \  |   1  |   2  |   3  |   +  |
+ * +------+------+------+------+------| |      |   |      | +------+------+------+------+------|
+ * |      |  _GA |      |  _FN |      | |      |   |      | |      |   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,
@@ -73,6 +134,20 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
   _______, TG(_GA), _______, MO(_FN), _______, _______,  _______, _______, KC_0,    KC_DOT, KC_EQL, _______
 ),
 
+/*
+ * Functions
+ *
+ * ,----------------------------------.                     ,----------------------------------.
+ * |      |      |      |      |      |                     |      |  F7  |  F8  |  F9  |  F10 |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |      |      |      |      |      |                     |      |  F4  |  F5  |  F6  |  F11 |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |      | Vol ^| Mute | Vol v| Play | ,------.   ,------. |      |  F1  |  F2  |  F3  |  F12 |
+ * +------+------+------+------+------| |      |   |      | +------+------+------+------+------|
+ * |      |      |      |      | Stop | |      |   |      | |      |      | _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,
@@ -80,6 +155,20 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
   _______, _______, _______, _______, KC_MSTP, _______, _______, _______, KC_NO,   DF(_CO), DF(_QW), RESET
 ),
 
+/*
+ * Gaming
+ *
+ * ,----------------------------------.                     ,----------------------------------.
+ * |      |      |      |      |      |                     |      |Whl Up|  MUp |Whl Dn|      |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |      |      |      |      |      |                     |      | MLeft| MDown|MRight|      |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |  Z   |      |      |      |      | ,------.   ,------. |MClick|      |      |      |      |
+ * +------+------+------+------+------| | Bksp |   |RClick| +------+------+------+------+------|
+ * |      |  _GA |      | Shift| Space| |      |   |      | |LClick|      |      |      |      |
+ * `----------------------------------' `------'   `------' `----------------------------------'
+ *
+ */
 [_GA] = KEYMAP( /* Gaming */
   _______, _______, _______, _______, _______,                   _______, KC_WH_U, KC_MS_U, KC_WH_D, _______,
   _______, _______, _______, _______, _______,                   _______, KC_MS_L, KC_MS_D, KC_MS_R, _______,
@@ -87,6 +176,21 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
   _______, TG(_GA), _______, KC_LSFT, KC_SPC,  KC_BSPC, KC_BTN2, KC_BTN1, _______, _______, _______, _______
 )};
 
+/*
+ * Template
+ *
+ * ,----------------------------------.                     ,----------------------------------.
+ * |      |      |      |      |      |                     |      |      |      |      |      |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |      |      |      |      |      |                     |      |      |      |      |      |
+ * +------+------+------+------+------|                     +------+------+------+------+------|
+ * |      |      |      |      |      | ,------.   ,------. |      |      |      |      |      |
+ * +------+------+------+------+------| |      |   |      | +------+------+------+------+------|
+ * |      |      |      |      |      | |      |   |      | |      |      |      |      |      |
+ * `----------------------------------' `------'   `------' `----------------------------------'
+ *
+ */
+
 const uint16_t PROGMEM fn_actions[] = {
 
 };