diff options
author | Nik Richers <nrichers@elastic.co> | 2019-03-17 10:13:45 -0700 |
---|---|---|
committer | Drashna Jaelre <drashna@live.com> | 2019-03-17 10:13:45 -0700 |
commit | c62f6b0825b13d2791838154867c543f1f433030 (patch) | |
tree | c253a7643d65358b1dd1141f95cbf1f2806409e5 /keyboards/redox | |
parent | e30c993d75b2edd78c185a5d5f33f2fe10635eb5 (diff) | |
download | qmk_firmware-c62f6b0825b13d2791838154867c543f1f433030.tar.gz qmk_firmware-c62f6b0825b13d2791838154867c543f1f433030.zip |
[Keymap] Add a tweaked Redox keymap (#5422)
* Add nrichers keymap
* Additional keymap tweaks, add readme info
* Improve descriptions for changes from default keymap
* Add image of keymap, update .gitignore to
* Add image link
Adds an image of the modified keymap.
* Improve legibility of keymap changes with colour coding
* Tinker with color codes in Markdown
* Experiment with colour codes
* Tinker more with colour codes
* Figured out the easiest way to include colour coding
* Undo earlier .gitignore change
Diffstat (limited to 'keyboards/redox')
-rwxr-xr-x | keyboards/redox/keymaps/nrichers/config.h | 34 | ||||
-rwxr-xr-x | keyboards/redox/keymaps/nrichers/keymap.c | 92 | ||||
-rw-r--r-- | keyboards/redox/keymaps/nrichers/keymap.png | bin | 0 -> 146904 bytes | |||
-rwxr-xr-x | keyboards/redox/keymaps/nrichers/readme.md | 28 | ||||
-rwxr-xr-x | keyboards/redox/keymaps/nrichers/rules.mk | 2 |
5 files changed, 156 insertions, 0 deletions
diff --git a/keyboards/redox/keymaps/nrichers/config.h b/keyboards/redox/keymaps/nrichers/config.h new file mode 100755 index 000000000..a3ef209a0 --- /dev/null +++ b/keyboards/redox/keymaps/nrichers/config.h | |||
@@ -0,0 +1,34 @@ | |||
1 | /* | ||
2 | Copyright 2018 Mattia Dal Ben <matthewdibi@gmail.com> | ||
3 | |||
4 | This program is free software: you can redistribute it and/or modify | ||
5 | it under the terms of the GNU General Public License as published by | ||
6 | the Free Software Foundation, either version 2 of the License, or | ||
7 | (at your option) any later version. | ||
8 | |||
9 | This program is distributed in the hope that it will be useful, | ||
10 | but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
12 | GNU General Public License for more details. | ||
13 | |||
14 | You should have received a copy of the GNU General Public License | ||
15 | along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
16 | */ | ||
17 | |||
18 | #pragma once | ||
19 | |||
20 | /* Use I2C or Serial, not both */ | ||
21 | #define USE_SERIAL | ||
22 | // #define USE_I2C | ||
23 | |||
24 | /* Select hand configuration */ | ||
25 | #define MASTER_LEFT | ||
26 | // #define MASTER_RIGHT | ||
27 | // #define EE_HANDS | ||
28 | |||
29 | #undef RGBLED_NUM | ||
30 | #define RGBLIGHT_ANIMATIONS | ||
31 | #define RGBLED_NUM 14 | ||
32 | #define RGBLIGHT_HUE_STEP 8 | ||
33 | #define RGBLIGHT_SAT_STEP 8 | ||
34 | #define RGBLIGHT_VAL_STEP 8 | ||
diff --git a/keyboards/redox/keymaps/nrichers/keymap.c b/keyboards/redox/keymaps/nrichers/keymap.c new file mode 100755 index 000000000..7434b4368 --- /dev/null +++ b/keyboards/redox/keymaps/nrichers/keymap.c | |||
@@ -0,0 +1,92 @@ | |||
1 | #include QMK_KEYBOARD_H | ||
2 | |||
3 | extern keymap_config_t keymap_config; | ||
4 | |||
5 | // Each layer gets a name for readability, which is then used in the keymap matrix below. | ||
6 | // The underscores don't mean anything - you can have a layer called STUFF or any other name. | ||
7 | // Layer names don't all need to be of the same length, obviously, and you can also skip them | ||
8 | // entirely and just use numbers. | ||
9 | #define _QWERTY 0 | ||
10 | #define _SYMB 1 | ||
11 | #define _NAV 2 | ||
12 | #define _ADJUST 3 | ||
13 | |||
14 | enum custom_keycodes { | ||
15 | QWERTY = SAFE_RANGE, | ||
16 | SYMB, | ||
17 | NAV, | ||
18 | ADJUST, | ||
19 | }; | ||
20 | |||
21 | // Shortcut to make keymap more readable | ||
22 | #define SYM_L MO(_SYMB) | ||
23 | |||
24 | #define KC_ALAS LALT_T(KC_PAST) | ||
25 | #define KC_CTES LCTL_T(KC_ESC) | ||
26 | #define KC_CTQU RCTL_T(KC_QUOT) | ||
27 | |||
28 | #define KC_NAGR LT(_NAV, KC_GRV) | ||
29 | #define KC_NAMI LT(_NAV, KC_MINS) | ||
30 | |||
31 | #define KC_ADEN LT(_ADJUST, KC_END) | ||
32 | #define KC_ADPU LT(_ADJUST, KC_PGUP) | ||
33 | |||
34 | const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | ||
35 | |||
36 | [_QWERTY] = LAYOUT( | ||
37 | //┌────────┬────────┬────────┬────────┬────────┬────────┐ ┌────────┬────────┬────────┬────────┬────────┬────────┐ | ||
38 | KC_NAGR ,KC_1 ,KC_2 ,KC_3 ,KC_4 ,KC_5 , KC_6 ,KC_7 ,KC_8 ,KC_9 ,KC_0 ,KC_NAMI , | ||
39 | //├────────┼────────┼────────┼────────┼────────┼────────┼────────┐ ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┤ | ||
40 | KC_TAB ,KC_Q ,KC_W ,KC_E ,KC_R ,KC_T ,SYM_L , SYM_L ,KC_Y ,KC_U ,KC_I ,KC_O ,KC_P ,KC_EQL , | ||
41 | //├────────┼────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┼────────┤ | ||
42 | KC_CTES ,KC_A ,KC_S ,KC_D ,KC_F ,KC_G ,KC_LBRC , KC_RBRC ,KC_H ,KC_J ,KC_K ,KC_L ,KC_SCLN ,KC_CTQU , | ||
43 | //├────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┐ ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┤ | ||
44 | KC_LSFT ,KC_Z ,KC_X ,KC_C ,KC_V ,KC_B ,KC_ADPU ,KC_PGDN , KC_HOME ,KC_ADEN ,KC_N ,KC_M ,KC_COMM ,KC_DOT ,KC_SLSH ,KC_RSFT , | ||
45 | //├────────┼────────┼────────┼────────┼────┬───┴────┬───┼────────┼────────┤ ├────────┼────────┼───┬────┴───┬────┼────────┼────────┼────────┼────────┤ | ||
46 | KC_BSLS ,KC_PPLS ,KC_PMNS ,KC_ALAS , KC_LGUI , KC_SPC ,KC_BSPC , KC_DEL ,KC_ENT , KC_RGUI , KC_LEFT ,KC_DOWN ,KC_UP ,KC_RGHT | ||
47 | //└────────┴────────┴────────┴────────┘ └────────┘ └────────┴────────┘ └────────┴────────┘ └────────┘ └────────┴────────┴────────┴────────┘ | ||
48 | ), | ||
49 | |||
50 | [_SYMB] = LAYOUT( | ||
51 | //┌────────┬────────┬────────┬────────┬────────┬────────┐ ┌────────┬────────┬────────┬────────┬────────┬────────┐ | ||
52 | _______ ,KC_F1 ,KC_F2 ,KC_F3 ,KC_F4 ,KC_F5 , KC_F6 ,KC_F7 ,KC_F8 ,KC_F9 ,KC_F10 ,KC_F11 , | ||
53 | //├────────┼────────┼────────┼────────┼────────┼────────┼────────┐ ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┤ | ||
54 | _______ ,KC_EXLM ,KC_AT ,KC_LCBR ,KC_RCBR ,KC_PIPE ,_______ , _______ ,XXXXXXX ,KC_KP_7 ,KC_KP_8 ,KC_KP_9 ,XXXXXXX ,KC_F12 , | ||
55 | //├────────┼────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┼────────┤ | ||
56 | _______ ,KC_HASH ,KC_DLR ,KC_LBRC ,KC_RBRC ,KC_GRV ,_______ , _______ ,XXXXXXX ,KC_KP_4 ,KC_KP_5 ,KC_KP_6 ,XXXXXXX ,XXXXXXX , | ||
57 | //├────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┐ ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┤ | ||
58 | _______ ,KC_PERC ,KC_CIRC ,KC_LPRN ,KC_RPRN ,KC_TILD ,_______ ,_______ , _______ ,_______ ,XXXXXXX ,KC_KP_1 ,KC_KP_2 ,KC_KP_3 ,XXXXXXX ,XXXXXXX , | ||
59 | //├────────┼────────┼────────┼────────┼────┬───┴────┬───┼────────┼────────┤ ├────────┼────────┼───┬────┴───┬────┼────────┼────────┼────────┼────────┤ | ||
60 | _______ ,_______ ,_______ ,_______ , _______ , _______ ,_______ , _______ ,_______ , KC_KP_0 , KC_KP_0 ,KC_PDOT ,XXXXXXX ,XXXXXXX | ||
61 | //└────────┴────────┴────────┴────────┘ └────────┘ └────────┴────────┘ └────────┴────────┘ └────────┘ └────────┴────────┴────────┴────────┘ | ||
62 | ), | ||
63 | |||
64 | [_NAV] = LAYOUT( | ||
65 | //┌────────┬────────┬────────┬────────┬────────┬────────┐ ┌────────┬────────┬────────┬────────┬────────┬────────┐ | ||
66 | _______ ,_______ ,_______ ,_______ ,_______ ,_______ , _______ ,_______ ,_______ ,_______ ,_______ ,_______ , | ||
67 | //├────────┼────────┼────────┼────────┼────────┼────────┼────────┐ ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┤ | ||
68 | XXXXXXX ,XXXXXXX ,KC_MS_U ,XXXXXXX ,KC_WH_U ,XXXXXXX ,_______ , _______ ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX , | ||
69 | //├────────┼────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┼────────┤ | ||
70 | XXXXXXX ,KC_MS_L ,KC_MS_D ,KC_MS_R ,KC_WH_D ,XXXXXXX ,_______ , _______ ,KC_LEFT ,KC_DOWN ,KC_UP ,KC_RIGHT,XXXXXXX ,XXXXXXX , | ||
71 | //├────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┐ ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┤ | ||
72 | XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX ,_______ ,_______ , _______ ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX , | ||
73 | //├────────┼────────┼────────┼────────┼────┬───┴────┬───┼────────┼────────┤ ├────────┼────────┼───┬────┴───┬────┼────────┼────────┼────────┼────────┤ | ||
74 | XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX , KC_BTN1 , KC_BTN2 ,_______ , _______ ,_______ , XXXXXXX , XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX | ||
75 | //└────────┴────────┴────────┴────────┘ └────────┘ └────────┴────────┘ └────────┴────────┘ └────────┘ └────────┴────────┴────────┴────────┘ | ||
76 | ), | ||
77 | |||
78 | [_ADJUST] = LAYOUT( | ||
79 | //┌────────┬────────┬────────┬────────┬────────┬────────┐ ┌────────┬────────┬────────┬────────┬────────┬────────┐ | ||
80 | XXXXXXX ,KC_F1 ,KC_F2 ,KC_F3 ,KC_F4 ,KC_F5 , KC_F6 ,KC_F7 ,KC_F8 ,KC_F9 ,KC_F10 ,KC_F11 , | ||
81 | //├────────┼────────┼────────┼────────┼────────┼────────┼────────┐ ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┤ | ||
82 | XXXXXXX ,RESET ,RGB_M_P ,RGB_TOG ,RGB_MOD ,RGB_HUD ,RGB_HUI , RGB_SAD ,RGB_SAI ,RGB_VAD ,RGB_VAI ,XXXXXXX ,XXXXXXX ,KC_F12 , | ||
83 | //├────────┼────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┼────────┤ | ||
84 | XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX , XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX , | ||
85 | //├────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┐ ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┤ | ||
86 | XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX ,_______ ,XXXXXXX , XXXXXXX ,_______ ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX , | ||
87 | //├────────┼────────┼────────┼────────┼────┬───┴────┬───┼────────┼────────┤ ├────────┼────────┼───┬────┴───┬────┼────────┼────────┼────────┼────────┤ | ||
88 | XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX , XXXXXXX , XXXXXXX ,XXXXXXX , XXXXXXX ,XXXXXXX , XXXXXXX , XXXXXXX ,XXXXXXX ,XXXXXXX ,XXXXXXX | ||
89 | //└────────┴────────┴────────┴────────┘ └────────┘ └────────┴────────┘ └────────┴────────┘ └────────┘ └────────┴────────┴────────┴────────┘ | ||
90 | ) | ||
91 | |||
92 | }; | ||
diff --git a/keyboards/redox/keymaps/nrichers/keymap.png b/keyboards/redox/keymaps/nrichers/keymap.png new file mode 100644 index 000000000..8ef3fe4ea --- /dev/null +++ b/keyboards/redox/keymaps/nrichers/keymap.png | |||
Binary files differ | |||
diff --git a/keyboards/redox/keymaps/nrichers/readme.md b/keyboards/redox/keymaps/nrichers/readme.md new file mode 100755 index 000000000..6189e8e9b --- /dev/null +++ b/keyboards/redox/keymaps/nrichers/readme.md | |||
@@ -0,0 +1,28 @@ | |||
1 | # A tweaked keymap for Redox | ||
2 | |||
3 | This keymap modifies the [default keymap](https://github.com/qmk/qmk_firmware/tree/master/keyboards/redox) for the awesome [Redox keyboard](https://github.com/mattdibi/redox-keyboard) designed by Mattia Dal Ben. | ||
4 | |||
5 |  | ||
6 | |||
7 | ## Changes to the default keymap  | ||
8 | |||
9 | These keymap changes are meant to improve the usability of the layout in everyday use: | ||
10 | |||
11 | - Move `GUI` (`SUPER`) key to where default left `CTRL` and right `ALT` are - gives you two frequently used `CMD` keys on macOS where my brain expects them | ||
12 | - Move `/?` into usual location next to right `SHIFT` - the default flash from Falbatech put `\|` here (might not be the Redox default?), which felt unintuitive | ||
13 | - Put `\|` into bottom-left spot where `GUI` (`SUPER`) was - had to go somewhere and this bottom-left placement sort of balances with the almost bottom-right `/?` | ||
14 | - Change default `ESC` into `ESC` on tap, `CTRL` on hold - Love the UNIX-ey `CTRL` key location and wanted to keep `ESC` in the original position | ||
15 | - Change default `'` above right `SHIFT` into `'` on tap, `CTRL` on hold - Love the UNIX-ey CTRL key location, but it can give you 'left claw hand', which a second, mirrored `CTRL` key fixes | ||
16 | - Add `F11` and `F12` keys to two layers - needed on macOS if you want to control volume up and down from your keyboard (not shown, on a different layer) | ||
17 | - On thumb clusters: | ||
18 | - Left: Move `SPACE` closest to left thumb and move `BACKSPACE` to the right of that - put the key for 'getting it right' closest to your thumb and reduce usage of my right hand (purely personal preference) | ||
19 | - Right: Move `ENTER` closest to right thumb and move `DEL` to the left of that - put the key for 'getting it right' closest to your thumb | ||
20 | |||
21 | ## Changes to the Redox layout  | ||
22 | |||
23 | These are physical keycap changes on the board that make reaching the `Layer 1` keys easier and that, subjectively, look more balanced visually: | ||
24 | |||
25 | - Increase the `Layer 1` key sizes from 1U to 1.25U | ||
26 | - Decrease the 1.5 U key size for `[` and `]` to 1.25U | ||
27 | |||
28 | You could even make `[` and `]` 1U so that you can use keycaps from a standard ANSI key set and also increase the size of the `Layer 2` keys to 1.5U. | ||
diff --git a/keyboards/redox/keymaps/nrichers/rules.mk b/keyboards/redox/keymaps/nrichers/rules.mk new file mode 100755 index 000000000..a81250cdf --- /dev/null +++ b/keyboards/redox/keymaps/nrichers/rules.mk | |||
@@ -0,0 +1,2 @@ | |||
1 | RGBLIGHT_ENABLE = yes | ||
2 | |||