[Keymap] Added layout for my Keyboardio Atreus (#10726)

* Adding Evan Travers' Keyboardio Atreus branch.

Initial commit of my KeyboardIO Atreus layout.
This is a direct copy of my default Atreus layout, with blank spaces
for the two additional keys.

* Added MACLOCK macro to keymap.c

* Updates to Keyboardio Atreus keymap and readme.

* Adding arrows to bottom row of RAISE and LOWER layers

* bringing the rest of the master branch to my working branch.

* Changes to my KeyboardIO Atreus keymap & readme

* Changes to keymap.

* Adding Evan Travers' Keyboardio Atreus branch.

Initial commit of my KeyboardIO Atreus layout.
This is a direct copy of my default Atreus layout, with blank spaces
for the two additional keys.

* Added MACLOCK macro to keymap.c

* Updates to Keyboardio Atreus keymap and readme.

* Adding arrows to bottom row of RAISE and LOWER layers

* bringing the rest of the master branch to my working branch.

* Changes to my KeyboardIO Atreus keymap & readme

* Changes to keymap.

* Added GPL2+ compatible license header.

Co-authored-by: Ian Sterling <503326@MC02YT9K9LVCF.tld>

2 files changed, 312 insertions, 0 deletions

diff --git a/keyboards/keyboardio/atreus/keymaps/xyverz/keymap.c b/keyboards/keyboardio/atreus/keymaps/xyverz/keymap.c
new file mode 100644
index 0000000000..2bd30bc586
--- /dev/null
+++ b/keyboards/keyboardio/atreus/keymaps/xyverz/keymap.c
@@ -0,0 +1,207 @@
+ /* Copyright 2020 Ian Sterling 
+  * 
+  * 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/>. 
+  */ 
+
+// This is the personal keymap of Ian Sterling (@xyverz). It is based on the keymap by
+// Chris Gerber (@gerbercj), with the addition of persistent layers like the Planck and
+// Preonic keyboards by Jack Humbert.
+
+#include QMK_KEYBOARD_H
+
+// Initial keymap for Xyverz's Keyboardio Atreus
+
+enum layer_names {
+  _DVORAK,
+  _QWERTY,
+  _COLEMAK,
+  _DVORMAC,
+  _LOWER,
+  _RAISE,
+  _ADJUST
+};
+
+enum planck_keycodes {
+  DVORAK = SAFE_RANGE,
+  QWERTY,
+  COLEMAK,
+  DVORMAC,
+  LOWER,
+  RAISE,
+  ADJUST
+};
+
+// Adding macros to make the keymaps below much easier to read.
+#define SFTSCLN SFT_T(KC_SCLN)
+#define SFTSLSH SFT_T(KC_SLSH)
+#define SFTZED SFT_T(KC_Z)
+#define ALTENT ALT_T(KC_ENT)
+#define ESCTRL CTL_T(KC_ESC)
+#define TABALT ALT_T(KC_TAB)
+#define DELGUI GUI_T(KC_DEL)
+#define DELCTL CTL_T(KC_DEL)
+#define MACLOCK LGUI(LCTL(KC_Q))
+#define ADJUST MO(_ADJUST)
+#define LOWER MO(_LOWER)
+#define RAISE MO(_RAISE)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  /* Dvorak Layer
+	,----------------------------------.              ,----------------------------------.
+	|   '  |   ,  |   .  |   P  |   Y  |              |   F  |   G  |   C  |   R  |   L  |
+	|------+------+------+------+------|              |------+------+------+------+------|
+	|   A  |   O  |   E  |   U  |   I  |              |   D  |   H  |   T  |   N  |   S  |
+	|------+------+------+------+------+------.,------+------+------+------+------+------|
+	|SFT/ ;|   Q  |   J  |   K  |   X  | Home || End  |   B  |   M  |   W  |   V  |SFT/ Z|
+	|------+------+------+------+------+------||------+------+------+------+------+------|
+	|  Esc |  Tab |  GUI | LOWER| BkSp |DELCTL||ALTENT|  Spc | RAISE|   -  |   /  |   \  |
+	`-----------------------------------------'`-----------------------------------------' */
+  [_DVORAK] = LAYOUT(
+    KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,                      KC_F,    KC_G,    KC_C,    KC_R,    KC_L   ,
+    KC_A,    KC_O,    KC_E,    KC_U,    KC_I,                      KC_D,    KC_H,    KC_T,    KC_N,    KC_S   ,
+    SFTSCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_HOME, KC_END,  KC_B,    KC_M,    KC_W,    KC_V,    SFTZED ,
+    ESCTRL,  TABALT,  KC_LGUI, LOWER,   KC_BSPC, DELCTL,  ALTENT,  KC_SPC,  RAISE,   KC_MINS, KC_SLSH, KC_BSLS
+  ),
+
+  /* QWERTY Layer
+	,----------------------------------.              ,----------------------------------.
+	|   Q  |   W  |   E  |   R  |   T  |              |   Y  |   U  |   I  |   O  |   P  |
+	|------+------+------+------+------|              |------+------+------+------+------|
+	|   A  |   S  |   D  |   F  |   G  |              |   H  |   J  |   K  |   L  |   ;  |
+	|------+------+------+------+------+------.,------+------+------+------+------+------|
+	|SFT/ Z|   X  |   C  |   V  |   B  | Home || End  |   N  |   M  |   ,  |   .  |SFT/ /|
+	|------+------+------+------+------+------||------+------+------+------+------+------|
+	|  Esc |  Tab |  GUI | LOWER| BkSp | LCTL ||ALTENT|  Spc | RAISE|   -  |   '  |   \  |
+	`-----------------------------------------'`-----------------------------------------' */
+  [_QWERTY] = LAYOUT(
+    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,
+    SFTZED,  KC_X,    KC_C,    KC_V,    KC_B,    KC_HOME, KC_END,  KC_N,    KC_M,    KC_COMM, KC_DOT,  SFTSLSH,
+    ESCTRL,  TABALT,  KC_LGUI, LOWER,   KC_BSPC, KC_LCTL, ALTENT,  KC_SPC,  RAISE,   KC_MINS, KC_QUOT, KC_BSLS
+  ),
+
+  /* Colemak Layer
+	,----------------------------------.              ,----------------------------------.
+	|   Q  |   W  |   F  |   P  |   G  |              |   J  |   L  |   U  |   Y  |   L  |
+	|------+------+------+------+------|              |------+------+------+------+------|
+	|   A  |   R  |   S  |   T  |   D  |              |   H  |   N  |   E  |   I  |   S  |
+	|------+------+------+------+------+------.,------+------+------+------+------+------|
+	|SFT/ Z|   X  |   C  |   V  |   B  | Home || End  |   K  |   M  |   ,  |   .  |SFT/ /|
+	|------+------+------+------+------+------||------+------+------+------+------+------|
+	|  Esc |  Tab |  GUI | LOWER| BkSp | LCTL ||ALTENT|  Spc | RAISE|   -  |   '  |   \  |
+	`-----------------------------------------'`-----------------------------------------'*/
+  [_COLEMAK] = LAYOUT(
+    KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,                      KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN,
+    KC_A,    KC_R,    KC_S,    KC_T,    KC_D,                      KC_H,    KC_N,    KC_E,    KC_I,    KC_O   ,
+    SFTZED,  KC_X,    KC_C,    KC_V,    KC_B,    KC_HOME, KC_END,  KC_K,    KC_M,    KC_COMM, KC_DOT,  SFTSLSH,
+    ESCTRL,  TABALT,  KC_LGUI, LOWER,   KC_BSPC, KC_LCTL, ALTENT,  KC_SPC,  RAISE,   KC_MINS, KC_QUOT, KC_BSLS
+  ),
+
+  /* Dvorak Layer with Command key on left thumb instead of Control
+	,----------------------------------.              ,----------------------------------.
+	|   '  |   ,  |   .  |   P  |   Y  |              |   F  |   G  |   C  |   R  |   L  |
+	|------+------+------+------+------|              |------+------+------+------+------|
+	|   A  |   O  |   E  |   U  |   I  |              |   D  |   H  |   T  |   N  |   S  |
+	|------+------+------+------+------+------.,------+------+------+------+------+------|
+	|SFT/ ;|   Q  |   J  |   K  |   X  | Home || End  |   B  |   M  |   W  |   V  |SFT/ Z|
+	|------+------+------+------+------+------||------+------+------+------+------+------|
+	|  Esc |  Tab |  GUI | LOWER| BkSp | LGUI ||ALTENT|  Spc | RAISE|   -  |   /  |   \  |
+	`-----------------------------------------'`-----------------------------------------' */
+  [_DVORMAC] = LAYOUT(
+    KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,                      KC_F,    KC_G,    KC_C,    KC_R,    KC_L   ,
+    KC_A,    KC_O,    KC_E,    KC_U,    KC_I,                      KC_D,    KC_H,    KC_T,    KC_N,    KC_S   ,
+    SFTSCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_HOME, KC_END,  KC_B,    KC_M,    KC_W,    KC_V,    SFTZED ,
+    ESCTRL,  TABALT,  KC_LGUI, LOWER,   KC_BSPC, DELGUI,  ALTENT,  KC_SPC,  RAISE,   KC_MINS, KC_SLSH, KC_BSLS
+  ),
+
+  /* LOWER Layer
+	,----------------------------------.              ,----------------------------------.
+	|   !  |   @  |   #  |   $  |   %  |              |   ^  |   &  |   *  |   (  |   )  |
+	|------+------+------+------+------|              |------+------+------+------+------|
+	| CAPS |      |  UP  |      | Home |              | PgDn |      |   +  |   {  |   }  |
+	|------+------+------+------+------+------.,------+------+------+------+------+------|
+	|      | Left | Down | Right| End  |      ||      | PgUp | Mute | Vol- | Vol+ |      |
+	|------+------+------+------+------+------||------+------+------+------+------+------|
+	|   ~  |      |      |      | Del  |      ||      | Ins  |      |      |      |      |
+	`-----------------------------------------'`-----------------------------------------'*/
+  [_LOWER] = LAYOUT(
+    KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC,                   KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN,
+    KC_CAPS, _______, KC_UP,   _______, KC_HOME,                   KC_PGUP, _______, KC_PLUS, KC_LCBR, KC_RCBR,
+    _______, KC_LEFT, KC_DOWN, KC_RGHT, KC_END,  _______, _______, KC_PGDN, KC_MUTE, KC_VOLD, KC_VOLU, _______,
+    KC_TILD, KC_LEFT, KC_RGHT, _______, KC_DEL,  _______, _______, KC_INS,  _______, KC_UP,   KC_DOWN, _______
+  ),
+
+  /* RAISE Layer
+	,----------------------------------.              ,----------------------------------.
+	|   1  |   2  |   3  |   4  |   5  |              |   6  |   7  |   8  |   9  |   0  |
+	|------+------+------+------+------|              |------+------+------+------+------|
+	| CAPS |      |  UP  |      | Home |              | PgDn |      |   =  |   [  |   ]  |
+	|------+------+------+------+------+------.,------+------+------+------+------+------|
+	|      | Left | Down | Right| End  |MacLck||      | PgUp | Prev | Play | Next |      |
+	|------+------+------+------+------+------||------+------+------+------+------+------|
+	|   `  |      |      |      | Del  |      ||      | Ins  |      |      |      |      |
+	`-----------------------------------------'`-----------------------------------------'*/
+  [_RAISE] = LAYOUT(
+    KC_1,    KC_2,    KC_3,    KC_4,    KC_5,                      KC_6,    KC_7,    KC_8,    KC_9,    KC_0   ,
+    KC_CAPS, _______, KC_UP,   _______, KC_HOME,                   KC_PGUP, _______, KC_EQL,  KC_LBRC, KC_RBRC,
+    _______, KC_LEFT, KC_DOWN, KC_RGHT, KC_END,  MACLOCK, _______, KC_PGDN, KC_MPRV, KC_MPLY, KC_MNXT, _______,
+    KC_GRV,  KC_LEFT, KC_RGHT, _______, KC_DEL,  _______, _______, KC_INS,  _______, KC_UP,   KC_DOWN, _______
+  ),
+
+  /* ADJUST Layer
+	,----------------------------------.              ,----------------------------------.
+	|  F1  |  F2  |  F3  |  F4  |  F5  |              |  F6  |  F7  |  F8  |  F9  | F10  |
+	|------+------+------+------+------|              |------+------+------+------+------|
+	|  F11 |      |      |      |      |              |      | PrSc | ScLk | Paus | F12  |
+	|------+------+------+------+------+------.,------+------+------+------+------+------|
+	|      |QWERTY|COLEMK|DVORAK|DVORMC|      ||      |      |      |      |      |      |
+	|------+------+------+------+------+------||------+------+------+------+------+------|
+	|      |      |      |      |      |      ||      |      |      |      |      | RESET|
+	`-----------------------------------------'`-----------------------------------------'*/
+  [_ADJUST] = LAYOUT(
+    KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,                     KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10 ,
+    KC_F11,  _______, _______, _______, _______,                   _______, KC_PSCR, KC_SLCK, KC_PAUS, KC_F12 ,
+    _______, QWERTY,  COLEMAK, DVORAK,  DVORMAC, _______, _______, _______, _______, _______, _______, _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RESET  
+  ),
+};
+
+layer_state_t layer_state_set_user(layer_state_t state) {
+  return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
+}
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  switch (keycode) {
+    case DVORAK:
+      if (record->event.pressed) {
+        set_single_persistent_default_layer(_DVORAK);
+      }
+      return false;
+    case COLEMAK:
+      if (record->event.pressed) {
+        set_single_persistent_default_layer(_COLEMAK);
+      }
+      return false;
+    case QWERTY:
+      if (record->event.pressed) {
+        set_single_persistent_default_layer(_QWERTY);
+      }
+      return false;
+    case DVORMAC:
+      if (record->event.pressed) {
+        set_single_persistent_default_layer(_DVORMAC);
+      }
+      return false;
+  }
+  return true;
+}
\ No newline at end of file
diff --git a/keyboards/keyboardio/atreus/keymaps/xyverz/readme.md b/keyboards/keyboardio/atreus/keymaps/xyverz/readme.md
new file mode 100644
index 0000000000..f9749bb3bd
--- /dev/null
+++ b/keyboards/keyboardio/atreus/keymaps/xyverz/readme.md
@@ -0,0 +1,105 @@
+# Xyverz's Keyboardio Atreus Keymap
+
+## About this keymap:
+
+This is the first iteration of my Keyboardio Atreus keymap. This is entirely based on my original Atreus keymap
+with a few changes added to reflect the extra two keys, and a code update to current standards.
+
+I'm using MOD_TAP quite a bit in this keymap. On all layers, R4 pinky keys use mod-tap and are SHIFT when held
+and their normal keys when tapped. In addition, ESC and TAB are also set as Ctrl and ALT respectively when held,
+and Enter/ALT on the right thumb key for all alpha layers.
+
+I've enabled persistent keymaps for Qwerty, Dvorak and Colemak layers, similar to the default Planck layouts.
+
+Recently added: Documentation, Formatting, and another Dvorak layer that has Command on the left thumb, instead of
+Control.
+
+## Still to do:
+
+ * Enjoy this revision; figure out new things later.
+
+### Layer 0: Dvorak layer
+
+	,----------------------------------.              ,----------------------------------.
+	|   '  |   ,  |   .  |   P  |   Y  |              |   F  |   G  |   C  |   R  |   L  |
+	|------+------+------+------+------|              |------+------+------+------+------|
+	|   A  |   O  |   E  |   U  |   I  |              |   D  |   H  |   T  |   N  |   S  |
+	|------+------+------+------+------+------.,------+------+------+------+------+------|
+	|SFT/ ;|   Q  |   J  |   K  |   X  | Home || End  |   B  |   M  |   W  |   V  |SFT/ Z|
+	|------+------+------+------+------+------||------+------+------+------+------+------|
+	|  Esc |  Tab |  GUI | LOWER| BkSp | LCTL ||ALTENT|  Spc | RAISE|   -  |   /  |   \  |
+	`-----------------------------------------'`-----------------------------------------'
+
+### Layer 1: QWERTY layer
+
+	,----------------------------------.              ,----------------------------------.
+	|   Q  |   W  |   E  |   R  |   T  |              |   Y  |   U  |   I  |   O  |   P  |
+	|------+------+------+------+------|              |------+------+------+------+------|
+	|   A  |   S  |   D  |   F  |   G  |              |   H  |   J  |   K  |   L  |   ;  |
+	|------+------+------+------+------+------.,------+------+------+------+------+------|
+	|SFT/ Z|   X  |   C  |   V  |   B  | Home || End  |   N  |   M  |   ,  |   .  |SFT/ /|
+	|------+------+------+------+------+------||------+------+------+------+------+------|
+	|  Esc |  Tab |  GUI | LOWER| BkSp | LCTL ||ALTENT|  Spc | RAISE|   -  |   '  |   \  |
+	`-----------------------------------------'`-----------------------------------------'
+	 
+### Layer 2: Colemak layer
+
+	,----------------------------------.              ,----------------------------------.
+	|   Q  |   W  |   F  |   P  |   G  |              |   J  |   L  |   U  |   Y  |   L  |
+	|------+------+------+------+------|              |------+------+------+------+------|
+	|   A  |   R  |   S  |   T  |   D  |              |   H  |   N  |   E  |   I  |   S  |
+	|------+------+------+------+------+------.,------+------+------+------+------+------|
+	|SFT/ Z|   X  |   C  |   V  |   B  | Home || End  |   K  |   M  |   ,  |   .  |SFT/ /|
+	|------+------+------+------+------+------||------+------+------+------+------+------|
+	|  Esc |  Tab |  GUI | LOWER| BkSp | LCTL ||ALTENT|  Spc | RAISE|   -  |   '  |   \  |
+	`-----------------------------------------'`-----------------------------------------'
+
+### Layer 3: Dvorak for Mac layer
+
+	,----------------------------------.              ,----------------------------------.
+	|   '  |   ,  |   .  |   P  |   Y  |              |   F  |   G  |   C  |   R  |   L  |
+	|------+------+------+------+------|              |------+------+------+------+------|
+	|   A  |   O  |   E  |   U  |   I  |              |   D  |   H  |   T  |   N  |   S  |
+	|------+------+------+------+------+------.,------+------+------+------+------+------|
+	|SFT/ ;|   Q  |   J  |   K  |   X  | Home || End  |   B  |   M  |   W  |   V  |SFT/ Z|
+	|------+------+------+------+------+------||------+------+------+------+------+------|
+	|  Esc |  Tab |  GUI | LOWER| BkSp | LGUI ||ALTENT|  Spc | RAISE|   -  |   /  |   \  |
+	`-----------------------------------------'`-----------------------------------------'
+
+### Layer 4: LOWER layer
+
+	,----------------------------------.              ,----------------------------------.
+	|   !  |   @  |   #  |   $  |   %  |              |   ^  |   &  |   *  |   (  |   )  |
+	|------+------+------+------+------|              |------+------+------+------+------|
+	| CAPS |      |  UP  |      | Home |              | PgDn |      |   +  |   {  |   }  |
+	|------+------+------+------+------+------.,------+------+------+------+------+------|
+	|      | Left | Down | Right| End  |      ||      | PgUp | Mute | Vol- | Vol+ |      |
+	|------+------+------+------+------+------||------+------+------+------+------+------|
+	|   ~  |      |      |      | Del  |      ||      | Ins  |      |      |      |      |
+	`-----------------------------------------'`-----------------------------------------'
+
+
+### Layer 5: RAISE layer
+
+	,----------------------------------.              ,----------------------------------.
+	|   1  |   2  |   3  |   4  |   5  |              |   6  |   7  |   8  |   9  |   0  |
+	|------+------+------+------+------|              |------+------+------+------+------|
+	| CAPS |      |  UP  |      | Home |              | PgDn |      |   =  |   [  |   ]  |
+	|------+------+------+------+------+------.,------+------+------+------+------+------|
+	|      | Left | Down | Right| End  |MacLck||      | PgUp | Prev | Play | Next |      |
+	|------+------+------+------+------+------||------+------+------+------+------+------|
+	|   `  |      |      |      | Del  |      ||      | Ins  |      |      |      |      |
+	`-----------------------------------------'`-----------------------------------------'
+
+### Layer 6: ADJUST layer
+
+	,----------------------------------.              ,----------------------------------.
+	|  F1  |  F2  |  F3  |  F4  |  F5  |              |  F6  |  F7  |  F8  |  F9  | F10  |
+	|------+------+------+------+------|              |------+------+------+------+------|
+	|  F11 |      |      |      |      |              |      | PrSc | ScLk | Paus | F12  |
+	|------+------+------+------+------+------.,------+------+------+------+------+------|
+	|      |QWERTY|COLEMK|DVORAK|DVORMC|      ||      |      |      |      |      |      |
+	|------+------+------+------+------+------||------+------+------+------+------+------|
+	|      |      |      |      |      |      ||      |      |      |      |      | RESET|
+	`-----------------------------------------'`-----------------------------------------'
+