]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/ergodox/keymaps/xyverz/readme.md
One last formatting change
[qmk_firmware.git] / keyboards / ergodox / keymaps / xyverz / readme.md
1 # Xyverz's ErgoDox EZ Keymap
2
3 ## Please Note:
4
5 It will need **substantial** modification in order to work on the Infinity.
6
7 PLEASE NOTE: This keymap will NOT work with the Infinity ErgoDox due to the fact that the mappings are based on the Matrix Layout in the ez.h file. If you want to use this for the infinity, you'll need to figure out where the keys are in the matrix and redo the layout arrays below.
8
9 ## About this keymap:
10
11 The Dvorak layout shown herestems from my early Kinesis years, using the Contour PS/2 with a Dvorak software layout. Because of this, the RBRC and LBRC were on opposite sides of the board in the corner keys. I've decided to continue using this layout with my ErgoDox.
12
13 The QWERTY layout shown here is based entirely on the Kinesis Advantage layout, with the additional keys as shown in the diagrams. The Colemak layout is merely an adaptation of that.
14
15 I've enabled persistent keymaps for Qwerty, Dvorak and Colemak layers, similar to the default Planck layouts.
16
17 For a better explanation of the layout matrices shown below, take a look at ../../ez/ez.h where the keymap is defined, beginning on line 81.
18
19 ### Layer 0: Dvorak layer
20
21         ,--------------------------------------------------.,--------------------------------------------------.
22         |   ]    |   1  |   2  |   3  |   4  |   5  | ESC  || ESC  |   6  |   7  |   8  |   9  |   0  |   [    |
23         |--------+------+------+------+------+-------------||------+------+------+------+------+------+--------|
24         | Tab    |   '  |   ,  |   .  |   Y  |   Y  |      ||      |   F  |   G  |   C  |   R  |   L  |   \    |
25         |--------+------+------+------+------+------|      ||      |------+------+------+------+------+--------|
26         | CapsLk |   A  |   O  |   E  |   U  |   I  |------||------|   D  |   H  |   T  |   N  |   S  |   -    |
27         |--------+------+------+------+------+------| _MD  || _KP  |------+------+------+------+------+--------|
28         | LShift |   Z  |   X  |   C  |   V  |   X  |      ||      |   B  |   M  |   W  |   V  |   Z  | RShift |
29         `--------+------+------+------+------+-------------'`-------------+------+------+------+------+--------'
30           | LGUI |   `  |  INS | Left | Rght |                            |  Up  |  Dn  |   /  |   =  | RGUI |
31           `----------------------------------'                            `----------------------------------'
32                                              ,-------------.,-------------.
33                                              | LCtr | LAlt || Ralt | RCtr |
34                                       ,------|------|------||------+------+------.
35                                       |      |      | Home || PgUp |      |      |
36                                       | BkSp | Del  |------||------| Enter| Space|
37                                       |      |      | End  || PgDn |      |      |
38                                       `--------------------'`--------------------'
39
40 ### Layer 1: QWERTY layer
41
42         ,--------------------------------------------------.,--------------------------------------------------.
43         |   =    |   1  |   2  |   3  |   4  |   5  | ESC  || ESC  |   6  |   7  |   8  |   9  |   0  |   -    |
44         |--------+------+------+------+------+-------------||------+------+------+------+------+------+--------|
45         | Tab    |   Q  |   W  |   E  |   R  |   T  |      ||      |   Y  |   U  |   I  |   O  |   P  |   \    |
46         |--------+------+------+------+------+------|      ||      |------+------+------+------+------+--------|
47         | CapsLk |   A  |   S  |   D  |   F  |   G  |------||------|   H  |   J  |   K  |   L  |   ;  |   '    |
48         |--------+------+------+------+------+------| _MD  || _KP  |------+------+------+------+------+--------|
49         | LShift |   Z  |   X  |   C  |   V  |   B  |      ||      |   N  |   M  |   ,  |   .  |   /  | RShift |
50         `--------+------+------+------+------+-------------'`-------------+------+------+------+------+--------'
51           | LGUI |   `  |  INS | Left | Rght |                            |  Up  |  Dn  |   [  |   ]  | RGUI |
52           `----------------------------------'                            `----------------------------------'
53                                              ,-------------.,-------------.
54                                              | LCtr | LAlt || Ralt | RCtr |
55                                       ,------|------|------||------+------+------.
56                                       |      |      | Home || PgUp |      |      |
57                                       | BkSp | Del  |------||------| Enter| Space|
58                                       |      |      | End  || PgDn |      |      |
59                                       `--------------------'`--------------------'
60          
61 ### Keymap 2: Colemak layer
62
63         ,--------------------------------------------------.,--------------------------------------------------.
64         |   =    |   1  |   2  |   3  |   4  |   5  | ESC  || ESC  |   6  |   7  |   8  |   9  |   0  |   -    |
65         |--------+------+------+------+------+-------------||------+------+------+------+------+------+--------|
66         | Tab    |   Q  |   W  |   F  |   P  |   G  |      ||      |   J  |   L  |   U  |   Y  |   ;  |   \    |
67         |--------+------+------+------+------+------|      ||      |------+------+------+------+------+--------|
68         | BkSpc  |   A  |   R  |   S  |   T  |   D  |------||------|   H  |   N  |   E  |   I  |   O  |   '    |
69         |--------+------+------+------+------+------| _MD  || _KP  |------+------+------+------+------+--------|
70         | LShift |   Z  |   X  |   C  |   V  |   B  |      ||      |   K  |   M  |   ,  |   .  |   /  | RShift |
71         `--------+------+------+------+------+-------------'`-------------+------+------+------+------+--------'
72           | LGUI |   `  |  INS | Left | Rght |                            |  Up  |  Dn  |   [  |   ]  | RGUI |
73           `----------------------------------'                            `----------------------------------'
74                                              ,-------------.,-------------.
75                                              | LCtr | LAlt || Ralt | RCtr |
76                                       ,------|------|------||------+------+------.
77                                       |      |      | Home || PgUp |      |      |
78                                       | BkSp | Del  |------||------| Enter| Space|
79                                       |      |      | End  || PgDn |      |      |
80                                       `--------------------'`--------------------'
81
82 ### layer 3 : Media layer
83
84         ,--------------------------------------------------.,--------------------------------------------------.
85         | TEENSY |  F1  |  F2  |  F3  |  F4  |  F5  | F11  ||  F12 |  F6  |  F7  |  F8  |  F9  |  F10 |        |
86         |--------+------+------+------+------+-------------||------+------+------+------+------+------+--------|
87         |        |      | PrSc | ScLk | Paus |      |      ||      |      | Mute | Vol- | Vol+ |      |        |
88         |--------+------+------+------+------+------|      ||      |------+------+------+------+------+--------|
89         |        |      |      |      |      |      |------||------| Stop | Prev | Play | Next | Sel  |        |
90         |--------+------+------+------+------+------|      ||      |------+------+------+------+------+--------|
91         |        |      |Dvorak|Qwerty|Colemk|      |      ||      |      |      |      |      |      |        |
92         `--------+------+------+------+------+-------------'`-------------+------+------+------+------+--------'
93           |      |      |      |      |      |                            |      |      |      |      |      |
94           `----------------------------------'                            `----------------------------------'
95                                              ,-------------.,-------------.
96                                              |      |      ||      |      |
97                                       ,------|------|------||------+------+------.
98                                       |      |      |      ||      |      |      |
99                                       |      |      |------||------|      |      |
100                                       |      |      |      ||      |      |      |
101                                       `--------------------'`--------------------'
102
103
104
105 ### Keymap 4: Keypad layer
106
107         ,--------------------------------------------------.,--------------------------------------------------.
108         | Power  |      |      |      |      |      |      ||      |      | NmLk | KP / | KP * | KP - |        |
109         |--------+------+------+------+------+-------------||------+------+------+------+------+------+--------|
110         | Sleep  |      |      |      |      |      |      ||      |      | KP 7 | KP 8 | KP 9 | KP + |        |
111         |--------+------+------+------+------+------|      ||      |------+------+------+------+------+--------|
112         | Wake   |      |      |      |      |      |------||------|      | KP 4 | KP 5 | KP 6 | KP + |        |
113         |--------+------+------+------+------+------|      ||      |------+------+------+------+------+--------|
114         |        |      |      |      |      |      |      ||      |      | KP 1 | KP 2 | KP 3 |KP Ent|        |
115         `--------+------+------+------+------+-------------'`-------------+------+------+------+------+--------'
116           |      |      |      |      |      |                            | KP 0 |      | KP . |KP Ent|      |
117           `----------------------------------'                            `----------------------------------'
118                                              ,-------------.,-------------.
119                                              |      |      ||      |      |
120                                       ,------|------|------||------+------+------.
121                                       |      |      |      ||      |      |      |
122                                       |      |      |------||------|      |      |
123                                       |      |      |      ||      |      |      |
124                                       `--------------------'`--------------------'