Skip to content

Instantly share code, notes, and snippets.

@jrod-disco
Created November 19, 2020 04:23
Show Gist options
  • Save jrod-disco/e71da1ecce4409d906095d29b5409b22 to your computer and use it in GitHub Desktop.
Save jrod-disco/e71da1ecce4409d906095d29b5409b22 to your computer and use it in GitHub Desktop.
Planck Key Map for QMK
#include "../../config.h"
#pragma once
#ifdef AUDIO_ENABLE
# define STARTUP_SONG SONG(E1M1_DOOM)
# define GOODBYE_SONG SONG(ZELDA_PUZZLE)
# define MUSIC_ON_SONG SONG(CABBAGE_SONG)
// #define MUSIC_OFF_SONG SONG(MARIO_GAMEOVER)
// #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
// Most tactile encoders have detents every 4 stages
#define ENCODER_RESOLUTION 4
// Enable clicky sounds
#define AUDIO_CLICKY
#ifndef CONFIG_USER_H
# define CONFIG_USER_H
#endif
// Layout picture at http://www.keyboard-layout-editor.com/#/gists/b1849c3de3e27b7ff62f4ed1df172baf
#include QMK_KEYBOARD_H
#include "eeconfig.h"
#include "muse.h"
extern keymap_config_t keymap_config;
// Each layer gets a name for readability, which is then used in the keymap matrix below.
// The underscores don't mean anything - you can have a layer called STUFF or any other name.
// Layer names don't all need to be of the same length, obviously, and you can also skip them
// entirely and just use numbers.
#define _QWERTY 0
#define _NUMPAD 1
#define _LOCKED 2
#define _RAISE 3
#define _LOWER 4
#define _FUNCTN 5
#define _MEDIA 6
#define _ONESHOT 7
enum planck_keycodes {
QWERTY = SAFE_RANGE,
NUMPAD,
RAISE,
LOWER,
MEDIA,
ONESHOT,
DYNAMIC_MACRO_RANGE,
// Custom Code Macros
CODE_ARROWFN,
GIT_ADD,
GIT_COMMIT,
GIT_STATUS,
GIT_RESET,
};
#include "dynamic_macro.h"
// Key code names
#define SFT_ENT MT(MOD_RSFT, KC_ENT) // Tap for enter, hold for right shift
#define LOCK TG(_LOCKED)
#define KC_PSTE KC_PASTE
#define ZOOM_IN LGUI(KC_PPLS)
#define ZOOM_OUT LGUI(KC_MINS)
#define ZOOM_NML LGUI(KC_0)
#define ITERM LGUI(S(KC_I))
#define SS_SEL LGUI(LCTL(S(KC_4)))
#define SS_FUL LGUI(S(KC_3))
#ifdef TAP_DANCE_ENABLE
#define SFT_CAP TD(0) // Left shift, double tap for caps
#endif
#ifndef TAP_DANCE_ENABLE
#define SFT_CAP KC_LSFT // Regular left shift
#endif
// Tap Dance Definitions
#ifdef TAP_DANCE_ENABLE
qk_tap_dance_action_t tap_dance_actions[] = {
[0] = ACTION_TAP_DANCE_DOUBLE(KC_LSFT, KC_CAPS)
};
#endif
// Layout definitions
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/* QWERTY
* ,-----------------------------------------------------------------------------------.
* | Esc | Q | W | E | R | T | Y | U | I | O | P | BKSP |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | Tab | A | S | D | F | G | H | J | K | L | ; | ' |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* |*Shift| Z | X | C | V | B | N | M | , | . | Up |SftEnt|
* |------+------+------+------+------+-------------+------+------+------+------+------|
* | Mute | Ctrl | Alt | GUI | Lower| Space | Raise| / | Left | Down | Right|
* `-----------------------------------------------------------------------------------'
*/
[_QWERTY] = LAYOUT_planck_grid(KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
SFT_CAP, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_UP, SFT_ENT,
MEDIA, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_SLSH, KC_LEFT, KC_DOWN, KC_RGHT),
/* NUMPAD
* ,-----------------------------------------------------------------------------------.
* |QWERTY| NULL | Up | NULL | NULL | NULL | NULL | / | 7 | 8 | 9 | - |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | | Left | Down | Right| NULL | NULL | NULL | * | 4 | 5 | 6 | + |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | |NumLck| NULL | NULL | NULL | NULL | NULL |BckSp | 1 | 2 | 3 | Ent |
* |------+------+------+------+------+-------------+------+------+------+------+------|
* | | | | | | | | 0 | . | , | = |
* `-----------------------------------------------------------------------------------'
*/
[_NUMPAD] = LAYOUT_planck_grid(
QWERTY, XXXXXXX, KC_UP, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_PSLS, KC_P7, KC_P8, KC_P9, KC_PMNS,
_______, KC_LEFT, KC_DOWN, KC_RGHT, XXXXXXX, XXXXXXX, XXXXXXX, KC_PAST, KC_P4, KC_P5, KC_P6, KC_PPLS,
_______, KC_NLCK, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_BSPC, KC_P1, KC_P2, KC_P3, KC_PENT,
_______, _______, _______, _______, _______, _______, _______, _______, KC_P0, KC_PDOT, KC_PCMM, KC_PEQL
),
/* LOCK
* ,-----------------------------------------------------------------------------------.
* | | | | | | | | | | | | |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | | | | | | | | | | | | |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | Shift| | | | | | | | | | | Enter|
* |------+------+------+------+------+-------------+------+------+------+------+------|
* | NULL | | | | | | | | | | |
* `-----------------------------------------------------------------------------------'
*/
[_LOCKED] = LAYOUT_planck_grid(
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
KC_LSFT, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_ENT,
XXXXXXX, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
),
/* RAISE
* ,-----------------------------------------------------------------------------------.
* | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Del |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | | | |SS_FUL|SS_SEL| | | - | = | [ | ] | \ |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* |LShift| | | | | | |ISO # |ISO / | NULL | | Enter|
* |------+------+------+------+------+-------------+------+------+------+------+------|
* | | | | | | | | | | | |
* `-----------------------------------------------------------------------------------'
*/
[_RAISE] = LAYOUT_planck_grid(
KC_GRV , KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_DEL,
_______ , _______, _______, SS_FUL, SS_SEL, _______, _______, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS,
KC_LSFT, _______, _______, _______, _______, _______, _______, KC_NUHS, KC_NUBS, XXXXXXX, _______, KC_ENT,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
),
/* LOWER
* ,-----------------------------------------------------------------------------------.
* | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Del |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | | F1 | F2 | F3 | F4 | F5 | | _ | + | { | } | | |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* |LShift| F6 | F7 | F8 | F9 | F10 | |ISO ~ |ISO | | NULL | PgUp | Enter|
* |------+------+------+------+------+-------------+------+------+------+------+------|
* | | | | | | | | | Home | PgDn | End |
* `-----------------------------------------------------------------------------------'
*/
[_LOWER] = LAYOUT_planck_grid(
KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_DEL ,
_______ , KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, _______, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE,
KC_LSFT, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, _______, S(KC_NUHS), S(KC_NUBS), XXXXXXX, KC_PGUP, KC_ENT ,
_______, _______, _______, _______, _______, _______, _______, _______, _______, KC_HOME, KC_PGDN, KC_END
),
/* MEDIA, COMMANDS, AND CODE MACROS
* ,-----------------------------------------------------------------------------------.
* | NULL | NULL | NULL | NULL | gRes | iTrm | NULL | NULL |Insert| NULL |PrntSc| NULL |›
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | NULL | gAdd | gStat| NULL | ()=> | NULL | NULL | NULL | NULL | NULL |PlyMc1|PlyMc2|
* |------+------+------+------+------+------+------+------+------+------+------+------|
* |ONESHT| NULL | NULL |gComit| NULL | NULL | NULL | NULL |ZoomOu|ZoomIn| Prev |RecStp|
* |------+------+------+------+------+-------------+------+------+------+------+------|
* | | NULL | NULL | | Vol- | Mute | Vol+ |Zoom 0| Stop | Next | Play |
* `-----------------------------------------------------------------------------------'
*/
[_MEDIA] = LAYOUT_planck_grid(
XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, GIT_RESET, ITERM, XXXXXXX, XXXXXXX, KC_INS, XXXXXXX, KC_PSCR, XXXXXXX,
XXXXXXX, GIT_ADD, GIT_STATUS, XXXXXXX, CODE_ARROWFN, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, DYN_MACRO_PLAY1, DYN_MACRO_PLAY2,
ONESHOT, XXXXXXX, XXXXXXX, GIT_COMMIT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, ZOOM_OUT, ZOOM_IN, KC_MPRV, DYN_REC_STOP,
_______, XXXXXXX, XXXXXXX, _______, KC_VOLD, KC_MUTE, KC_MUTE, KC_VOLU, ZOOM_NML, KC_MSTP, KC_MNXT, KC_MPLY
),
/* ONESHOT
* ,-----------------------------------------------------------------------------------.
* | | | | | | | | | | | | |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | | | | | | | | | | |RecMc1|RecMc2|
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | | | | | | | | | | | | |
* |------+------+------+------+------+-------------+------+------+------+------+------|
* | | | | | | | | | | | |
* `-----------------------------------------------------------------------------------'
*/
[_ONESHOT] = LAYOUT_planck_grid(
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, DYN_REC_START1, DYN_REC_START2,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
),
/* FUNCTIONS
* ,-----------------------------------------------------------------------------------.
* | SLEEP| RGB |RGBMOD| HUE+ | HUE- | SAT+ | SAT- |BRGTH+|BRGTH-| CTog | CUp | POWER|
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | WAKE | NULL | NULL | NULL | NULL | NULL | NULL | MMod | NULL | CRes | CDn | NULL |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | NULL | NULL | NULL |AudOff|MusOff|QWERTY|NUMPAD|Mus On|Aud On| NULL |Voice+|SysReq|
* |------+------+------+------+------+-------------+------+------+------+------+------|
* | Reset| NULL | LOCK | NULL | | NULL | | NULL |AGNorm|Voice-|AGSwap|
* `-----------------------------------------------------------------------------------'
*/
[_FUNCTN] = LAYOUT_planck_grid(
KC_SLEP, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, CK_TOGG, CK_UP, KC_PWR,
KC_WAKE, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, MU_MOD, XXXXXXX, CK_RST, CK_DOWN, XXXXXXX,
XXXXXXX, XXXXXXX, XXXXXXX, AU_OFF, MU_OFF, QWERTY, NUMPAD, MU_ON, AU_ON, XXXXXXX, MUV_IN, KC_SYSREQ,
RESET, XXXXXXX, LOCK, XXXXXXX, _______, XXXXXXX, XXXXXXX, _______, XXXXXXX, AG_NORM, MUV_DE, AG_SWAP
)
};
#ifdef AUDIO_ENABLE
float tone_startup[][2] = SONG(STARTUP_SOUND);
float tone_qwerty[][2] = SONG(QWERTY_SOUND);
float tone_numpad[][2] = SONG(NUM_LOCK_ON_SOUND);
float tone_oneshot[][2] = SONG(TERMINAL_SOUND);
float tone_dyn_macro_rec[][2] = SONG(SONIC_RING);
float tone_dyn_macro_stop[][2] = SONG(SONIC_RING);
float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
#endif
void press_key(uint16_t key) {
register_code(key);
unregister_code(key);
}
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
// uint16_t macro_kc = (keycode == ONESHOT ? DYN_REC_STOP : keycode);
if (!process_record_dynamic_macro(keycode, record)) {
switch(keycode) {
case DYN_REC_START1:
case DYN_REC_START2:
#ifdef AUDIO_ENABLE
PLAY_SONG(tone_dyn_macro_rec);
#endif
break;
case DYN_REC_STOP:
#ifdef AUDIO_ENABLE
PLAY_SONG(tone_dyn_macro_stop);
#endif
break;
}
return false;
}
switch (keycode) {
case ONESHOT:
if (record->event.pressed) {
layer_on(_ONESHOT);
set_oneshot_layer(_ONESHOT, ONESHOT_START);
clear_oneshot_layer_state(ONESHOT_PRESSED);
#ifdef AUDIO_ENABLE
PLAY_SONG(tone_oneshot);
#endif
}
return false;
break;
case QWERTY:
if (record->event.pressed) {
if (IS_LAYER_ON(_NUMPAD)) {
#ifdef AUDIO_ENABLE
PLAY_SONG(tone_qwerty);
#endif
layer_off(_NUMPAD);
}
}
return false;
break;
case NUMPAD:
if (record->event.pressed) {
if (!IS_LAYER_ON(_NUMPAD)) {
#ifdef AUDIO_ENABLE
PLAY_SONG(tone_numpad);
#endif
layer_on(_NUMPAD);
}
}
return false;
break;
case RAISE:
if (record->event.pressed) {
layer_on(_RAISE);
update_tri_layer(_RAISE, _LOWER, _FUNCTN);
} else {
layer_off(_RAISE);
update_tri_layer(_RAISE, _LOWER, _FUNCTN);
}
return false;
break;
case LOWER:
if (record->event.pressed) {
layer_on(_LOWER);
update_tri_layer(_RAISE, _LOWER, _FUNCTN);
} else {
layer_off(_LOWER);
update_tri_layer(_RAISE, _LOWER, _FUNCTN);
}
return false;
break;
case MEDIA:
if (record->event.pressed) {
layer_on(_MEDIA);
} else {
layer_off(_MEDIA);
}
return false;
break;
case CODE_ARROWFN:
if (record->event.pressed) {
SEND_STRING("()=>{};" SS_TAP(X_LEFT) SS_TAP(X_LEFT));
}
return false;
break;
case GIT_ADD:
if (record->event.pressed) {
SEND_STRING("git add -A \n");
}
return false;
break;
case GIT_STATUS:
if (record->event.pressed) {
SEND_STRING("git status \n");
}
return false;
break;
case GIT_COMMIT:
if (record->event.pressed) {
SEND_STRING("git commit -m ''"SS_TAP(X_LEFT));
}
return false;
break;
case GIT_RESET:
if (record->event.pressed) {
SEND_STRING("git reset HEAD");
}
return false;
break;
}
return true;
}
# From Default - assuming this is important to audio/music
SRC += muse.c
# Build Options
# change to "no" to disable the options, or define them in the makefile.mk in
# the appropriate keymap folder that will get included automatically
#
BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000)
MOUSEKEY_ENABLE = no # Mouse keys(+4700)
EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
CONSOLE_ENABLE = no # Console for debug(+400)
COMMAND_ENABLE = yes # Commands for debug and configuration
NKRO_ENABLE = yes # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
MIDI_ENABLE = no # MIDI controls
AUDIO_ENABLE = yes # Audio output on port C6
UNICODE_ENABLE = no # Unicode
BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
RGBLIGHT_ENABLE = yes # Enable WS2812 RGB underlight.
TAP_DANCE_ENABLE = yes # Enables the double-tap functionality of keys
# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment