keyboards/atreus/keymaps/xyverz/readme.md

   1 # Xyverz's Atreus Keymap
   2
   3 ## About this keymap:
   4
   5 This is the second iteration of my Atreus keymap. The first one was as close to the planck as I could get at the
   6 time, but still very much like the original Atreus keymap. I've managed to get things working better now and have
   7 implemented (more like copied) the RAISE/LOWER/ADJUST layers. This is a work in progress, but I think I'm closer
   8 to a final go with this.
   9
  10 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
  11 and their normal keys when tapped. In addition, ESC and TAB are also set as Ctrl and ALT respectively when held,
  12 and Enter/ALT on the right thumb key for all layers.
  13
  14 I've enabled persistent keymaps for Qwerty, Dvorak and Colemak layers, similar to the default Planck layouts.
  15
  16 Recently added: Documentation, Formatting, and another Dvorak layer that has Command on the left thumb, instead of
  17 Control.
  18
  19 ## Still to do:
  20
  21  * Enjoy this revision; figure out new things later.
  22
  23 ### Layer 0: Dvorak layer
  24
  25         ,----------------------------------.              ,----------------------------------.
  26         |   '  |   ,  |   .  |   P  |   Y  |              |   F  |   G  |   C  |   R  |   L  |
  27         |------+------+------+------+------|              |------+------+------+------+------|
  28         |   A  |   O  |   E  |   U  |   I  |              |   D  |   H  |   T  |   N  |   S  |
  29         |------+------+------+------+------|------.,------|------+------+------+------+------|
  30         |Shft ;|   Q  |   J  |   K  |   X  | CTRL ||Alt / |   B  |   M  |   W  |   V  |Shft Z|
  31         |------+------+------+------+------|      ||Enter |------+------+------+------+------|
  32         |  Esc |  Tab |  GUI | LOWER| BkSp |------'`------|  Spc | RAISE|   -  |   /  |   \  |
  33         `----------------------------------'              `----------------------------------'
  34
  35 ### Layer 1: QWERTY layer
  36
  37         ,----------------------------------.              ,----------------------------------.
  38         |   Q  |   W  |   E  |   R  |   T  |              |   Y  |   U  |   I  |   O  |   P  |
  39         |------+------+------+------+------|              |------+------+------+------+------|
  40         |   A  |   S  |   D  |   F  |   G  |              |   H  |   J  |   K  |   L  |   ;  |
  41         |------+------+------+------+------|------.,------|------+------+------+------+------|
  42         |Shft Z|   X  |   C  |   V  |   B  | CTRL ||Alt / |   N  |   M  |   ,  |   .  |Shft /|
  43         |------+------+------+------+------|      ||Enter |------+------+------+------+------|
  44         |  Esc |  Tab |  GUI | LOWER| BkSp |------'`------|  Spc | RAISE|   -  |   '  |   \  |
  45         `----------------------------------'              `----------------------------------'
  46
  47 ### Keymap 2: Colemak layer
  48
  49         ,----------------------------------.              ,----------------------------------.
  50         |   Q  |   W  |   F  |   P  |   G  |              |   J  |   L  |   U  |   Y  |   L  |
  51         |------+------+------+------+------|              |------+------+------+------+------|
  52         |   A  |   R  |   S  |   T  |   D  |              |   H  |   N  |   E  |   I  |   S  |
  53         |------+------+------+------+------|------.,------|------+------+------+------+------|
  54         |Shft Z|   X  |   C  |   V  |   B  | CTRL ||Alt / |   K  |   M  |   ,  |   .  |Shft /|
  55         |------+------+------+------+------|      ||Enter |------+------+------+------+------|
  56         |  Esc |  Tab |  GUI | LOWER| BkSp |------'`------|  Spc | RAISE|   -  |   '  |   \  |
  57         `----------------------------------'              `----------------------------------'
  58
  59 ### Keymap 3: Dvorak for Mac layout
  60
  61         ,----------------------------------.              ,----------------------------------.
  62         |   '  |   ,  |   .  |   P  |   Y  |              |   F  |   G  |   C  |   R  |   L  |
  63         |------+------+------+------+------|              |------+------+------+------+------|
  64         |   A  |   O  |   E  |   U  |   I  |              |   D  |   H  |   T  |   N  |   S  |
  65         |------+------+------+------+------|------.,------|------+------+------+------+------|
  66         |SFT/ ;|   Q  |   J  |   K  |   X  | CMD  ||Alt / |   B  |   M  |   W  |   V  |SFT/ Z|
  67         |------+------+------+------+------|      ||Enter |------+------+------+------+------|
  68         |  Esc |  Tab |  GUI | LOWER| BkSp |------'`------|  Spc | RAISE|   -  |   /  |   \  |
  69         `----------------------------------'              `----------------------------------'
  70
  71 ### Keymap 4: LOWER layer
  72
  73         ,----------------------------------.              ,----------------------------------.
  74         |   !  |   @  |   #  |   $  |   %  |              |   ^  |   &  |   *  |   (  |   )  |
  75         |------+------+------+------+------|              |------+------+------+------+------|
  76         | CAPS |      |  UP  |      | Home |              | PgDn |      |   +  |   {  |   }  |
  77         |------+------+------+------+------|------.,------|------+------+------+------+------|
  78         |      | Left | Down | Right| End  |      ||      | PgUp | Mute | Vol- | Vol+ |      |
  79         |------+------+------+------+------|      ||      |------+------+------+------+------|
  80         |   ~  |      |      |      | Del  |------'`------| Ins  |      |      |      |      |
  81         `----------------------------------'              `----------------------------------'
  82
  83
  84 ### Keymap 5: RAISE layer
  85
  86         ,----------------------------------.              ,----------------------------------.
  87         |   1  |   2  |   3  |   4  |   5  |              |   6  |   7  |   8  |   9  |   0  |
  88         |------+------+------+------+------|              |------+------+------+------+------|
  89         | CAPS |      |  UP  |      | Home |              | PgDn |      |   =  |   [  |   ]  |
  90         |------+------+------+------+------|------.,------|------+------+------+------+------|
  91         |      | Left | Down | Right| End  |      ||      | PgUp | Prev | Play | Next |      |
  92         |------+------+------+------+------|      ||      |------+------+------+------+------|
  93         |   `  |      |      |      | Del  |------'`------| Ins  |      |      |      |      |
  94         `----------------------------------'              `----------------------------------'
  95
  96 ### Keymap 6: ADJUST layer
  97
  98         ,----------------------------------.              ,----------------------------------.
  99         |  F1  |  F2  |  F3  |  F4  |  F5  |              |  F6  |  F7  |  F8  |  F9  | F10  |
 100         |------+------+------+------+------|              |------+------+------+------+------|
 101         |  F11 |      |      |      |      |              |      | PScr | SLck | Paus | F12  |
 102         |------+------+------+------+------|------.,------|------+------+------+------+------|
 103         |      |QWERTY|COLEMK|DVORAK|DVORMC|      ||      |      |      |      |      |      |
 104         |------+------+------+------+------|      ||      |------+------+------+------+------|
 105         |      |      |      |      |      |------'`------|      |      |      |      | RESET|
 106         `----------------------------------'              `----------------------------------'
 107