[Keymap] Planck Keymap :: rjhiglefort (#5059)

* copy default over as starting point

* Getting rid of dvorak and colemak for now, added a couple changes to the
keymap

* removed refs to bad layers, formatting comments

* First version of my ergodox ported layout!

* Symbols layer, media layer, updated comments

* Hyper as a single key

* Fix stuck hyper key when switching layers

* Tweak some annoying things about the layout.

- move raise left and promote alt
- remove swap keys on the last layer
- reorganize media keys so they're easier to reach and more intuitive
- fix some comment template things

* Add readme for rjhilgefort planck layout

* readme tweak

* PR feedback changes
This commit is contained in:
Rob Hilgefort 2019-03-23 18:22:40 -06:00 committed by Drashna Jaelre
parent f077204fae
commit 74e05f3451
4 changed files with 251 additions and 0 deletions

View file

@ -0,0 +1,35 @@
#pragma once
#ifdef AUDIO_ENABLE
#define STARTUP_SONG SONG(PLANCK_SOUND)
// #define STARTUP_SONG SONG(NO_SOUND)
#define DEFAULT_LAYER_SONGS { SONG(QWERTY_SOUND), \
SONG(COLEMAK_SOUND), \
SONG(DVORAK_SOUND) \
}
#endif
/*
* MIDI options
*/
/* Prevent use of disabled MIDI features in the keymap */
//#define MIDI_ENABLE_STRICT 1
/* enable basic MIDI features:
- MIDI notes can be sent when in Music mode is on
*/
#define MIDI_BASIC
/* enable advanced MIDI features:
- MIDI notes can be added to the keymap
- Octave shift and transpose
- Virtual sustain, portamento, and modulation wheel
- etc.
*/
//#define MIDI_ADVANCED
/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
//#define MIDI_TONE_KEYCODE_OCTAVES 2

View file

@ -0,0 +1,153 @@
/* Copyright 2015-2017 Jack Humbert
*
* 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/>.
*/
#include QMK_KEYBOARD_H
extern keymap_config_t keymap_config;
enum planck_layers {
_QWERTY,
_LOWER,
_RAISE,
_ADJUST
};
enum planck_keycodes {
// QWERTY = SAFE_RANGE,
BACKLIT,
EXT_PLV
};
#define LOWER MO(_LOWER)
#define RAISE MO(_RAISE)
#define CTRL_ESC MT(MOD_LCTL, KC_ESC)
#define HYPER LCTL(LALT(QK_LGUI))
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/* Qwerty
* ,-------------------------------------------------------------------------------------------------------.
* | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
* |--------+--------+--------+--------+--------+-------+-------+------+--------+--------+--------+--------|
* | Ct/Esc | A | S | D | F | G | H | J | K | L | ; | " |
* |--------+--------+--------+--------+--------+-------+-------+------+--------+--------+--------+--------|
* | Shift | Z | X | C | V | B | N | M | , | . | / | Enter |
* |--------+--------+--------+--------+--------+-------+-------+------+--------+--------+--------+--------|
* | | Ctrl | Raise | Alt | GUI | Space | Lowr | Hyper | | | Raise |
* `-------------------------------------------------------------------------------------------------------'
*/
[_QWERTY] = LAYOUT_planck_grid(
{KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC},
{CTRL_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
{KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT },
{_______, KC_LCTL, RAISE, KC_LALT, KC_LGUI, KC_SPC, KC_SPC, LOWER, HYPER, _______, _______, RAISE }
),
/* Lower
* ,-----------------------------------------------------------------------------------------------------------.
* | | \ | / | [ | ] | ~ | | | = | + | - | _ | |
* |-------+--------+--------+--------+--------+--------+--------+--------+--------+---------+--------+--------|
* | | { | } | ( | ) | ` | | | | | Alt | |
* |-------+--------+--------+--------+--------+--------+--------+--------+--------+---------+--------+--------|
* | | ! | @ | # | $ | % | ^ | & | * | ( | ) | |
* |-------+--------+--------+--------+--------+--------+--------+--------+--------+---------+--------+--------|
* | | | | | | | | | | | |
* `-----------------------------------------------------------------------------------------------------------'
*/
[_LOWER] = LAYOUT_planck_grid(
{_______, KC_BSLS, KC_SLSH, KC_LBRC, KC_RBRC, KC_TILD, KC_PIPE, KC_EQL, KC_PLUS, KC_MINS, KC_UNDS, _______},
{_______, KC_LCBR, KC_RCBR, KC_LPRN, KC_RPRN, KC_GRV, KC_LEFT, KC_DOWN, KC_UP, KC_RIGHT, KC_LALT, _______},
{_______, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, _______},
{_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
),
/* Raise
* ,----------------------------------------------------------------------------------------------------------.
* | | | | | | | | 7 | 8 | 9 | | |
* |-------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
* | | VolMte | Vol - | Vol + | Ply/Pse| | | 4 | 5 | 6 | | |
* |-------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
* | | Trak | Trak | Scrn - | Scrn + | | | 1 | 2 | 3 | | |
* |-------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
* | | | | | | | | 0 | . | | |
* `----------------------------------------------------------------------------------------------------------'
*/
[_RAISE] = LAYOUT_planck_grid(
{_______, _______, _______, _______, _______, _______, _______, KC_7, KC_8, KC_9, _______, _______},
{_______, KC_MUTE, KC_VOLD, KC_VOLU, KC_MPLY, _______, _______, KC_4, KC_5, KC_6, _______, _______},
{_______, KC_MRWD, KC_MFFD, KC_SLCK, KC_PAUS, _______, _______, KC_1, KC_2, KC_3, _______, _______},
{_______, _______, _______, _______, _______, _______, _______, KC_0, KC_0, KC_DOT, _______, _______}
),
/* Adjust (Lower + Raise)
* ,----------------------------------------------------------------------------------------------------------.
* | | Reset | | | | | | | | | | Del |
* |-------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
* | | | MuMod | AudOn | AudOff | | | Qwerty | | | | |
* |-------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
* | | Voice- | Voice+ | MusOn | Musoff | MIDIon | MIDIof | TermOn | TermOff| | | |
* |-------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
* | | | | | | | | | | | |
* `----------------------------------------------------------------------------------------------------------'
*/
[_ADJUST] = LAYOUT_planck_grid(
{_______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL },
{_______, _______, MU_MOD, AU_ON, AU_OFF, _______, _______, QWERTY, _______, _______, _______, _______},
{_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, TERM_ON, TERM_OFF, _______, _______, _______},
{_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
)
};
#ifdef AUDIO_ENABLE
float plover_song[][2] = SONG(PLOVER_SOUND);
float plover_gb_song[][2] = SONG(PLOVER_GOODBYE_SOUND);
#endif
uint32_t layer_state_set_user(uint32_t state) {
return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
}
bool music_mask_user(uint16_t keycode) {
switch (keycode) {
case RAISE:
case LOWER:
return false;
default:
return true;
}
}
/*
* Example
* ,----------------------------------------------------------------------------------------------------------.
* | | | | | | | | | | | | |
* |-------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
* | | | | | | | | | | | | |
* |-------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
* | | | | | | | | | | | | |
* |-------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
* | | | | | | | | | | | |
* `----------------------------------------------------------------------------------------------------------'
*
[_EXAMPLE] = LAYOUT_planck_grid(
{_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
{_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
{_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
{_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
),
*/

View file

@ -0,0 +1,63 @@
# [🐦 @rjhilgefort](https://twitter.com/rjhilgefort) Planck Layout
A simple and practical layout featuring:
- Hyper Key === CTRL + ALT + GUI
- Ctrl/Esc key that is CTRL when held and ESC when tapped
- Symbols layer that focuses on coding
- Numpad + media layer
![Imgur](https://i.imgur.com/elygxAb.jpg)
## Main
```
,-------------------------------------------------------------------------------------------------------.
| Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
|--------|--------|--------|--------|--------|-------|-------|------|--------|--------|--------|--------|
| Ct/Esc | A | S | D | F | G | H | J | K | L | ; | " |
|--------|--------|--------|--------|--------|-------|-------|------|--------|--------|--------|--------|
| Shift | Z | X | C | V | B | N | M | , | . | / | Enter |
|--------|--------|--------|--------|--------|-------|-------|------|--------|--------|--------|--------|
| | Ctrl | Raise | Alt | GUI | Space | Lowr | Hyper | | | Raise |
`-------------------------------------------------------------------------------------------------------'
```
## Lower
```
,-----------------------------------------------------------------------------------------------------------.
| | \ | / | [ | ] | ~ | | | = | + | - | _ | |
|-------|--------|--------|--------|--------|--------|--------|--------|--------|---------|--------|--------|
| | { | } | ( | ) | ` | ← | ↓ | ↑ | → | Alt | |
|-------|--------|--------|--------|--------|--------|--------|--------|--------|---------|--------|--------|
| | ! | @ | # | $ | % | ^ | & | * | ( | ) | |
|-------|--------|--------|--------|--------|--------|--------|--------|--------|---------|--------|--------|
| | | | | | | | | | | |
`-----------------------------------------------------------------------------------------------------------'
```
## Raise
```
,----------------------------------------------------------------------------------------------------------.
| | | | | | | | 7 | 8 | 9 | | |
|-------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
| | VolMte | Vol - | Vol + | Ply/Pse| | | 4 | 5 | 6 | | |
|-------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
| | Trak ← | Trak → | Scrn - | Scrn + | | | 1 | 2 | 3 | | |
|-------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
| | | | | | | | 0 | . | | |
`----------------------------------------------------------------------------------------------------------'
```
## Adjust (Lower + Raise)
```
,----------------------------------------------------------------------------------------------------------.
| | Reset | | | | | | | | | | Del |
|-------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
| | | MuMod | AudOn | AudOff | | | Qwerty | | | | |
|-------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
| | Voice- | Voice+ | MusOn | Musoff | MIDIon | MIDIof | TermOn | TermOff| | | |
|-------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
| | | | | | | | | | | |
`----------------------------------------------------------------------------------------------------------'
```