keyboards/atreus62/keymaps/xyverz/readme.md

   1 # Xyverz's Atreus62 Keymap
   2
   3 ## About this keymap:
   4
   5 This is the Atreus62 keyboard layout by Xyverz aka u/Zrevyx on r/mk. I've blatantly stolen what works for me from the Planck and Preonic layouts and modified this file to fit me. Initial credet goes to u/profet23 for the doing all the work and adding this keyboard to QMK in the first place.
   6
   7 I've got Dvorak, Qwerty, and Colemak layouts at this time, with the possibility of adding more in the future.
   8
   9 The bottom row is fairly Kinesis-ish since the Contour and Advantage keyboards have been my daily drivers for the last 17 years. I hope You can get some enjoyment out of this layout should you chose it!
  10
  11 ### CHANGELOG:
  12
  13 #### 0.1
  14  *  Initial commit. Based off of Profet's default keymap.
  15 #### 0.2
  16  * Converted to a more Planck/Preonic keymap style file with persistent layers enabled. Renamed layers to reflect OLKB maps.
  17  * Added a TODO list.
  18 #### 0.3
  19  * Moved location of media & volume keys. Added Print Screen, Scroll Lock and Pause keys.
  20  * Added a WOW gaming layer that changes the location of Ctrl & Alt to the thumb keys. Right thumb is Ctrl when held, Enter when tapped.
  21  * Added readme.
  22 #### 0.4
  23  * Moved location of Escape key to Caps Lock position. Moved Caps Lock to same position on Raise/Lower Layers.
  24  * Put Tilde/Grave in the upper-left corner
  25  * Added code to turn off the red LEDs on the Pro Micro after flashing. They were annoying me.
  26
  27 ### TODO:
  28
  29  * Make the layout more efficient, even if it means changing the RAISE
  30    and LOWER functionality.
  31  * Add legends in comments for each layer. Maybe.
  32  * Enjoy this revision; figure out new things later.
  33
  34 ### Layer 0: Dvorak layer
  35
  36         ,-----------------------------------------.              ,-----------------------------------------.
  37         | Grv  |   1  |   2  |   3  |   4  |   5  |              |   6  |   7  |   8  |   9  |   0  |   \  |
  38         |------+------+------+------+------+------|              |------+------+------+------+------+------|
  39         | Tab  |   '  |   ,  |   .  |   P  |   Y  |              |   F  |   G  |   C  |   R  |   L  |   /  |
  40         |------+------+------+------+------+------|              |------+------+------+------+------+------|
  41         | Esc  |   A  |   O  |   E  |   U  |   I  |              |   D  |   H  |   T  |   N  |   S  |   -  |
  42         |------+------+------+------+------+------|------.,------|------+------+------+------+------+------|
  43         | Shft |   ;  |   Q  |   J  |   K  |   X  | Gui  ||Enter |   B  |   M  |   W  |   V  |   Z  | Shft |
  44         |------+------+------+------+------+------|      ||      |------+------+------+------+------+------|
  45         | Ctrl |  Alt | Left | Rght | LOWER| BkSp |------'`------|  Spc | RAISE|  Up  | Down |  Gui | Ctrl |
  46         `-----------------------------------------'              `-----------------------------------------'
  47
  48 ### Layer 1: QWERTY layer
  49
  50         ,-----------------------------------------.              ,-----------------------------------------.
  51         | Grv  |   1  |   2  |   3  |   4  |   5  |              |   6  |   7  |   8  |   9  |   0  |   -  |
  52         |------+------+------+------+------+------|              |------+------+------+------+------+------|
  53         | Tab  |   Q  |   W  |   E  |   R  |   T  |              |   Y  |   U  |   I  |   O  |   P  | Del  |
  54         |------+------+------+------+------+------|              |------+------+------+------+------+------|
  55         | Esc  |   A  |   S  |   D  |   F  |   G  |              |   D  |   H  |   T  |   N  |   S  |   '  |
  56         |------+------+------+------+------+------|------.,------|------+------+------+------+------+------|
  57         | Shft |   Z  |   X  |   C  |   V  |   B  | Gui  ||Enter |   N  |   M  |   ,  |   .  |   /  | Shft |
  58         |------+------+------+------+------+------|      ||      |------+------+------+------+------+------|
  59         | Ctrl |  Alt | Left | Rght | LOWER| BkSp |------'`------|  Spc | RAISE|  Up  | Down |  Gui | Ctrl |
  60         `-----------------------------------------'              `-----------------------------------------'
  61
  62 ### Keymap 2: Colemak layer
  63
  64         ,-----------------------------------------.              ,-----------------------------------------.
  65         | Grv  |   1  |   2  |   3  |   4  |   5  |              |   6  |   7  |   8  |   9  |   0  |   -  |
  66         |------+------+------+------+------+------|              |------+------+------+------+------+------|
  67         | Tab  |   Q  |   W  |   F  |   P  |   G  |              |   J  |   U  |   U  |   Y  |   ;  | Del  |
  68         |------+------+------+------+------+------|              |------+------+------+------+------+------|
  69         | Esc  |   A  |   R  |   S  |   T  |   D  |              |   H  |   N  |   E  |   I  |   O  |   '  |
  70         |------+------+------+------+------+------|------.,------|------+------+------+------+------+------|
  71         | Shft |   Z  |   X  |   C  |   V  |   B  | Gui  ||Enter |   K  |   M  |   ,  |   .  |   /  | Shft |
  72         |------+------+------+------+------+------|      ||      |------+------+------+------+------+------|
  73         | Ctrl |  Alt | Left | Rght | LOWER| BkSp |------'`------|  Spc | RAISE|  Up  | Down |  Gui | Ctrl |
  74         `-----------------------------------------'              `-----------------------------------------'
  75
  76 ### Keymap 3: WoW gaming layer
  77
  78         ,-----------------------------------------.              ,-----------------------------------------.
  79         | Esc  |   1  |   2  |   3  |   4  |   5  |              |   6  |   7  |   8  |   9  |   0  |   \  |
  80         |------+------+------+------+------+------|              |------+------+------+------+------+------|
  81         | Tab  |   '  |   ,  |   .  |   P  |   Y  |              |   F  |   G  |   C  |   R  |   L  |   /  |
  82         |------+------+------+------+------+------|              |------+------+------+------+------+------|
  83         | Caps |   A  |   O  |   E  |   U  |   I  |              |   D  |   H  |   T  |   N  |   S  |   -  |
  84         |------+------+------+------+------+------|------.,------|------+------+------+------+------+------|
  85         | Shft |   ;  |   Q  |   J  |   K  |   X  | Alt  ||Ctrl/ |   B  |   M  |   W  |   V  |   Z  | Shft |
  86         |------+------+------+------+------+------|      ||Enter |------+------+------+------+------+------|
  87         | Ctrl |  Alt | Left | Rght | LOWER| BkSp |------'`------|  Spc | RAISE|  Up  | Down |  Gui | Ctrl |
  88         `-----------------------------------------'              `-----------------------------------------'
  89
  90 ### Keymap 4: LOWER layer
  91
  92         ,-----------------------------------------.              ,-----------------------------------------.
  93         | F11  |  F1  |  F2  |  F3  |  F4  |  F5  |              |  F6  |  F7  |  F8  |  F9  | F10  | F12  |
  94         |------+------+------+------+------+------|              |------+------+------+------+------+------|
  95         |  ~   |  `   |      |      |      |      |              |      |      |      |      |      |   |  |
  96         |------+------+------+------+------+------|              |------+------+------+------+------+------|
  97         | Caps |      | Mute | Vol- | Vol+ |      |              |      |      |   +  |   {  |   }  |      |
  98         |------+------+------+------+------+------|------.,------|------+------+------+------+------+------|
  99         |      |      | Prev | Play | Next |      |      ||      |      |      | PScr | ScLk | Pause|      |
 100         |------+------+------+------+------+------|      ||      |------+------+------+------+------+------|
 101         |      |      | Home | End  |      | Del  |------'`------|  Ins |      | PgUp | PgDn |      |      |
 102         `-----------------------------------------'              `-----------------------------------------'
 103
 104
 105 ### Keymap 5: RAISE layer
 106
 107         ,-----------------------------------------.              ,-----------------------------------------.
 108         | F11  |  F1  |  F2  |  F3  |  F4  |  F5  |              |  F6  |  F7  |  F8  |  F9  | F10  | F12  |
 109         |------+------+------+------+------+------|              |------+------+------+------+------+------|
 110         |  ~   |  `   |      |      |      |      |              |      |      |      |      |      |   \  |
 111         |------+------+------+------+------+------|              |------+------+------+------+------+------|
 112         | Caps |      | Mute | Vol- | Vol+ |      |              |      |      |   =  |   [  |   ]  |      |
 113         |------+------+------+------+------+------|------.,------|------+------+------+------+------+------|
 114         |      |      | Prev | Play | Next |      |      ||      |      |      | PScr | ScLk | Pause|      |
 115         |------+------+------+------+------+------|      ||      |------+------+------+------+------+------|
 116         |      |      | Home | End  |      | Del  |------'`------|  Ins |      | PgUp | PgDn |      |      |
 117         `-----------------------------------------'              `-----------------------------------------'
 118
 119 ### Keymap 6: ADJUST layer
 120
 121         ,-----------------------------------------.              ,-----------------------------------------.
 122         |      |      |      |      |      |      |              |      |      |      |      |      |      |
 123         |------+------+------+------+------+------|              |------+------+------+------+------+------|
 124         |      |RESET |      |      |      |      |              |      |      |      |      |      |      |
 125         |------+------+------+------+------+------|              |------+------+------+------+------+------|
 126         |      |      |      |      |      |      |              |      |Qwerty|Colemk|Dvorak|      | WoW  |
 127         |------+------+------+------+------+------|------.,------|------+------+------+------+------+------|
 128         |      |      |      |      |      |      |      ||      |      |      |      |      |      |      |
 129         |------+------+------+------+------+------|      ||      |------+------+------+------+------+------|
 130         |      |      |      |      |      |      |------'`------|      |      |      |      |      |      |
 131         `-----------------------------------------'              `-----------------------------------------'