feat(users/flokli/kb/dilemma): configure miryoku

The original layout is pretty far from Miryoku. It's not using Colemak
DH, but QWERTY, and the rest also looks quite different.

Align with the official Miryoku reference, from
https://github.com/manna-harbour/miryoku/tree/master/docs/reference.

Notable differences:

 - Button layer left out (normally activated by holding a bottom row
   pinkie key)
 - Media layer is missing external power and bluetooth-related keys
   (understandably).

Change-Id: Icd8b2222c9a68650d9d4ee81aa96df0f4bc3bc99
Reviewed-on: https://cl.tvl.fyi/c/depot/+/10673
Reviewed-by: flokli <flokli@flokli.de>
Autosubmit: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
This commit is contained in:
Florian Klink 2024-01-20 18:45:16 +02:00 committed by clbot
parent da99d6db46
commit a27edf6405

View file

@ -20,21 +20,22 @@
enum dilemma_keymap_layers { enum dilemma_keymap_layers {
LAYER_BASE = 0, LAYER_BASE = 0,
LAYER_FUNCTION,
LAYER_NAVIGATION, LAYER_NAVIGATION,
LAYER_POINTER, LAYER_MOUSE,
LAYER_MEDIA,
LAYER_NUMERAL, LAYER_NUMERAL,
LAYER_SYMBOLS, LAYER_SYMBOLS,
LAYER_FUNCTION,
}; };
// Automatically enable sniping-mode on the pointer layer. // Automatically enable sniping-mode on the pointer layer.
// #define DILEMMA_AUTO_SNIPING_ON_LAYER LAYER_POINTER #define DILEMMA_AUTO_SNIPING_ON_LAYER LAYER_MOUSE
#define ESC_MED LT(LAYER_MEDIA, KC_ESC)
#define SPC_NAV LT(LAYER_NAVIGATION, KC_SPC) #define SPC_NAV LT(LAYER_NAVIGATION, KC_SPC)
#define TAB_FUN LT(LAYER_FUNCTION, KC_TAB) #define TAB_MOU LT(LAYER_MOUSE, KC_TAB)
#define ENT_SYM LT(LAYER_SYMBOLS, KC_ENT) #define ENT_SYM LT(LAYER_SYMBOLS, KC_ENT)
#define BSP_NUM LT(LAYER_NUMERAL, KC_BSPC) #define BSP_NUM LT(LAYER_NUMERAL, KC_BSPC)
#define _L_PTR(KC) LT(LAYER_POINTER, KC) #define DEL_FUN LT(LAYER_FUNCTION, KC_DEL)
#ifndef POINTING_DEVICE_ENABLE #ifndef POINTING_DEVICE_ENABLE
# define DRGSCRL KC_NO # define DRGSCRL KC_NO
@ -46,10 +47,10 @@ enum dilemma_keymap_layers {
// clang-format off // clang-format off
/** \brief QWERTY layout (3 rows, 10 columns). */ /** \brief QWERTY layout (3 rows, 10 columns). */
#define LAYOUT_LAYER_BASE \ #define LAYOUT_LAYER_BASE \
KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, \ KC_Q, KC_W, KC_F, KC_P, KC_B, KC_J, KC_L, KC_U, KC_Y, KC_QUOT, \
KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_QUOT, \ KC_A, KC_R, KC_S, KC_T, KC_G, KC_M, KC_N, KC_E, KC_I, KC_O, \
KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, \ KC_Z, KC_X, KC_C, KC_D, KC_V, KC_K, KC_H, KC_COMMA, KC_DOT, KC_SLSH, \
CW_TOGG, TAB_FUN, SPC_NAV, ENT_SYM, BSP_NUM, KC_MUTE ESC_MED, SPC_NAV, TAB_MOU, ENT_SYM, BSP_NUM, DEL_FUN
/** Convenience row shorthands. */ /** Convenience row shorthands. */
#define _______________DEAD_HALF_ROW_______________ XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX #define _______________DEAD_HALF_ROW_______________ XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
@ -66,53 +67,70 @@ enum dilemma_keymap_layers {
* See https://github.com/manna-harbour/miryoku for the original layout. * See https://github.com/manna-harbour/miryoku for the original layout.
*/ */
/**
* \brief Function layer.
*
* Secondary right-hand layer has function keys mirroring the numerals on the
* primary layer with extras on the pinkie column, plus system keys on the inner
* column. App is on the tertiary thumb key and other thumb keys are duplicated
* from the base layer to enable auto-repeat.
*/
#define LAYOUT_LAYER_FUNCTION \
_______________DEAD_HALF_ROW_______________, KC_PSCR, KC_F7, KC_F8, KC_F9, KC_F12, \
______________HOME_ROW_GACS_L______________, KC_SCRL, KC_F4, KC_F5, KC_F6, KC_F11, \
_______________DEAD_HALF_ROW_______________, KC_PAUS, KC_F1, KC_F2, KC_F3, KC_F10, \
XXXXXXX, _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
/** \brief Mouse emulation and pointer functions. */
#define LAYOUT_LAYER_POINTER \
QK_BOOT, EE_CLR, XXXXXXX, DPI_MOD, S_D_MOD, S_D_MOD, DPI_MOD, XXXXXXX, EE_CLR, QK_BOOT, \
______________HOME_ROW_GACS_L______________, ______________HOME_ROW_GACS_R______________, \
_______, DRGSCRL, SNIPING, KC_BTN3, XXXXXXX, XXXXXXX, KC_BTN3, SNIPING, DRGSCRL, _______, \
KC_BTN3, KC_BTN2, KC_BTN1, KC_BTN1, KC_BTN2, KC_BTN3
/** /**
* \brief Navigation layer. * \brief Navigation layer.
* *
* Primary right-hand layer (left home thumb) is navigation and editing. Cursor * Primary right-hand layer (left home thumb) is navigation and editing. Cursor
* keys are on the home position, line and page movement below, clipboard above, * keys are on the home position, line and page movement below, clipboard
* caps lock and insert on the inner column. Thumb keys are duplicated from the * above, caps lock and insert on the inner column. Thumb keys are duplicated
* base layer to avoid having to layer change mid edit and to enable auto-repeat. * from the base layer to avoid having to layer change mid edit and to enable
* auto-repeat.
*/ */
#define LAYOUT_LAYER_NAVIGATION \ #define LAYOUT_LAYER_NAVIGATION \
_______________DEAD_HALF_ROW_______________, _______________DEAD_HALF_ROW_______________, \ _______________DEAD_HALF_ROW_______________, KC_AGAIN,KC_PSTE, KC_COPY, KC_CUT, KC_UNDO, \
______________HOME_ROW_GACS_L______________, KC_CAPS, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, \ ______________HOME_ROW_GACS_L______________, KC_CAPS, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, \
_______________DEAD_HALF_ROW_______________, KC_INS, KC_HOME, KC_PGDN, KC_PGUP, KC_END, \ _______________DEAD_HALF_ROW_______________, KC_INS, KC_HOME, KC_PGDN, KC_PGUP, KC_END, \
XXXXXXX, XXXXXXX, _______, KC_ENT, KC_BSPC, KC_DEL XXXXXXX, _______, XXXXXXX, KC_ENT, KC_BSPC, KC_DEL
/**
* \brief Mouse layer
*
* Secondary right-hand layer is mouse emulation. Mouse movement mirrors cursor
* navigation on home and wheel mirrors line / page movement below. Mouse
* buttons are on the thumbs. Left, right, and middle mouse buttons are on the
* primary, secondary, and tertiary thumb keys, respectively. Mouse movement,
* click, and drag, with modifiers, can be performed from the home position.
* Clipboard keys are duplicated from the Nav layer.
*/
#define LAYOUT_LAYER_MOUSE \
_______________DEAD_HALF_ROW_______________, KC_AGAIN,KC_PSTE, KC_COPY, KC_CUT, KC_UNDO, \
______________HOME_ROW_GACS_L______________, _______, KC_MS_L, KC_MS_D, KC_MS_U, KC_MS_R, \
_______________DEAD_HALF_ROW_______________, _______, KC_WH_L, KC_WH_D, KC_WH_U, KC_WH_R, \
XXXXXXX, XXXXXXX, _______, KC_BTN2, KC_BTN1, KC_BTN3
/**
* \brief Media layer
*
* Tertiary right-hand layer is media control, with volume up / volume down and
* next / prev mirroring the navigation keys. Pause, stop and mute are on the
* primary, secondary, and tertiary thumbs, respectively.
*
* Keyboard hardware controls are also present, and depend on hardware and
* firmware support.
*
* RGB control is on the top row. RGB Toggle is on the inner index column key.
* Combine with Shift for RGB Off. RGB Mode, RGB Hue, RGB Saturation, and RGB
* Value are on index, middle, ring, and pinkie column keys, respectively.
* Tapping will increase the corresponding value. Combine with Shift to
* decrease.
*/
#define LAYOUT_LAYER_MEDIA \
_______________DEAD_HALF_ROW_______________, RGB_TOG, RGB_MOD, RGB_HUI, RGB_SAI, RGB_VAI, \
______________HOME_ROW_GACS_L______________, _______, KC_MPRV, KC_VOLD, KC_VOLU, KC_MNXT, \
_______________DEAD_HALF_ROW_______________, _______, _______, _______, _______, _______, \
_______, XXXXXXX, XXXXXXX, KC_MSTP, KC_MPLY, KC_MUTE
/** /**
* \brief Numeral layout. * \brief Numeral layout.
* *
* Primary left-hand layer (right home thumb) is numerals and symbols. Numerals * Primary left-hand layer (right home thumb) is numerals and symbols. Numerals
* are in the standard numpad locations with symbols in the remaining positions. * are in the standard numpad locations with symbols in the remaining positions.
* `KC_DOT` is duplicated from the base layer.
*/ */
#define LAYOUT_LAYER_NUMERAL \ #define LAYOUT_LAYER_NUMERAL \
KC_LBRC, KC_7, KC_8, KC_9, KC_RBRC, _______________DEAD_HALF_ROW_______________, \ KC_LBRC, KC_7, KC_8, KC_9, KC_RBRC, _______________DEAD_HALF_ROW_______________, \
KC_SCLN, KC_4, KC_5, KC_6, KC_EQL, ______________HOME_ROW_GACS_R______________, \ KC_SCLN, KC_4, KC_5, KC_6, KC_EQL, ______________HOME_ROW_GACS_R______________, \
KC_DOT, KC_1, KC_2, KC_3, KC_BSLS, _______________DEAD_HALF_ROW_______________, \ KC_DOT, KC_1, KC_2, KC_3, KC_BSLS, _______________DEAD_HALF_ROW_______________, \
KC_DOT, KC_MINS, KC_0, XXXXXXX, _______, XXXXXXX KC_DOT, KC_0, KC_MINS, XXXXXXX, _______, XXXXXXX
/** /**
* \brief Symbols layer. * \brief Symbols layer.
@ -125,7 +143,21 @@ enum dilemma_keymap_layers {
KC_LCBR, KC_AMPR, KC_ASTR, KC_LPRN, KC_RCBR, _______________DEAD_HALF_ROW_______________, \ KC_LCBR, KC_AMPR, KC_ASTR, KC_LPRN, KC_RCBR, _______________DEAD_HALF_ROW_______________, \
KC_COLN, KC_DLR, KC_PERC, KC_CIRC, KC_PLUS, ______________HOME_ROW_GACS_R______________, \ KC_COLN, KC_DLR, KC_PERC, KC_CIRC, KC_PLUS, ______________HOME_ROW_GACS_R______________, \
KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_PIPE, _______________DEAD_HALF_ROW_______________, \ KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_PIPE, _______________DEAD_HALF_ROW_______________, \
KC_LPRN, KC_GRV, KC_UNDS, _______, XXXXXXX, XXXXXXX KC_LPRN, KC_RPRN, KC_UNDS, _______, XXXXXXX, XXXXXXX
/**
* \brief Function layer.
*
* Secondary right-hand layer has function keys mirroring the numerals on the
* primary layer with extras on the pinkie column, plus system keys on the inner
* column. App is on the tertiary thumb key and other thumb keys are duplicated
* from the base layer to enable auto-repeat.
*/
#define LAYOUT_LAYER_FUNCTION \
KC_F12, KC_F7, KC_F8, KC_F9, KC_PSCR, _______________DEAD_HALF_ROW_______________, \
KC_F11, KC_F4, KC_F5, KC_F6, KC_SCRL, ______________HOME_ROW_GACS_R______________, \
KC_F10, KC_F1, KC_F2, KC_F3, KC_PAUS, _______________DEAD_HALF_ROW_______________, \
KC_APP, KC_SPC, KC_TAB, XXXXXXX, XXXXXXX, _______
/** /**
* \brief Add Home Row mod to a layout. * \brief Add Home Row mod to a layout.
@ -133,9 +165,9 @@ enum dilemma_keymap_layers {
* Expects a 10-key per row layout. Adds support for GACS (Gui, Alt, Ctl, Shift) * Expects a 10-key per row layout. Adds support for GACS (Gui, Alt, Ctl, Shift)
* home row. The layout passed in parameter must contain at least 20 keycodes. * home row. The layout passed in parameter must contain at least 20 keycodes.
* *
* This is meant to be used with `LAYER_ALPHAS_QWERTY` defined above, eg.: * This is meant to be used with `LAYER_BASE` defined above, eg.:
* *
* HOME_ROW_MOD_GACS(LAYER_ALPHAS_QWERTY) * HOME_ROW_MOD_GACS(LAYER_BASE)
*/ */
#define _HOME_ROW_MOD_GACS( \ #define _HOME_ROW_MOD_GACS( \
L00, L01, L02, L03, L04, R05, R06, R07, R08, R09, \ L00, L01, L02, L03, L04, R05, R06, R07, R08, R09, \
@ -148,41 +180,19 @@ enum dilemma_keymap_layers {
__VA_ARGS__ __VA_ARGS__
#define HOME_ROW_MOD_GACS(...) _HOME_ROW_MOD_GACS(__VA_ARGS__) #define HOME_ROW_MOD_GACS(...) _HOME_ROW_MOD_GACS(__VA_ARGS__)
/**
* \brief Add pointer layer keys to a layout.
*
* Expects a 10-key per row layout. The layout passed in parameter must contain
* at least 30 keycodes.
*
* This is meant to be used with `LAYER_ALPHAS_QWERTY` defined above, eg.:
*
* POINTER_MOD(LAYER_ALPHAS_QWERTY)
*/
#define _POINTER_MOD( \
L00, L01, L02, L03, L04, R05, R06, R07, R08, R09, \
L10, L11, L12, L13, L14, R15, R16, R17, R18, R19, \
L20, L21, L22, L23, L24, R25, R26, R27, R28, R29, \
...) \
L00, L01, L02, L03, L04, \
R05, R06, R07, R08, R09, \
L10, L11, L12, L13, L14, \
R15, R16, R17, R18, R19, \
_L_PTR(L20), L21, L22, L23, L24, \
R25, R26, R27, R28, _L_PTR(R29), \
__VA_ARGS__
#define POINTER_MOD(...) _POINTER_MOD(__VA_ARGS__)
#define LAYOUT_wrapper(...) LAYOUT_split_3x5_3(__VA_ARGS__) #define LAYOUT_wrapper(...) LAYOUT_split_3x5_3(__VA_ARGS__)
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[LAYER_BASE] = LAYOUT_wrapper( [LAYER_BASE] = LAYOUT_wrapper(
POINTER_MOD(HOME_ROW_MOD_GACS(LAYOUT_LAYER_BASE)) HOME_ROW_MOD_GACS(LAYOUT_LAYER_BASE)
), ),
[LAYER_FUNCTION] = LAYOUT_wrapper(LAYOUT_LAYER_FUNCTION),
[LAYER_NAVIGATION] = LAYOUT_wrapper(LAYOUT_LAYER_NAVIGATION), [LAYER_NAVIGATION] = LAYOUT_wrapper(LAYOUT_LAYER_NAVIGATION),
[LAYER_MOUSE] = LAYOUT_wrapper(LAYOUT_LAYER_MOUSE),
[LAYER_MEDIA] = LAYOUT_wrapper(LAYOUT_LAYER_MEDIA),
[LAYER_NUMERAL] = LAYOUT_wrapper(LAYOUT_LAYER_NUMERAL), [LAYER_NUMERAL] = LAYOUT_wrapper(LAYOUT_LAYER_NUMERAL),
[LAYER_POINTER] = LAYOUT_wrapper(LAYOUT_LAYER_POINTER),
[LAYER_SYMBOLS] = LAYOUT_wrapper(LAYOUT_LAYER_SYMBOLS), [LAYER_SYMBOLS] = LAYOUT_wrapper(LAYOUT_LAYER_SYMBOLS),
[LAYER_FUNCTION] = LAYOUT_wrapper(LAYOUT_LAYER_FUNCTION),
}; };
// clang-format on // clang-format on
@ -199,11 +209,12 @@ layer_state_t layer_state_set_user(layer_state_t state) {
// clang-format off // clang-format off
const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][2] = { const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][2] = {
[LAYER_BASE] = {ENCODER_CCW_CW(KC_WH_D, KC_WH_U), ENCODER_CCW_CW(KC_VOLD, KC_VOLU)}, [LAYER_BASE] = {ENCODER_CCW_CW(KC_WH_D, KC_WH_U), ENCODER_CCW_CW(KC_VOLD, KC_VOLU)},
[LAYER_FUNCTION] = {ENCODER_CCW_CW(KC_DOWN, KC_UP), ENCODER_CCW_CW(KC_LEFT, KC_RGHT)},
[LAYER_NAVIGATION] = {ENCODER_CCW_CW(KC_PGDN, KC_PGUP), ENCODER_CCW_CW(KC_VOLU, KC_VOLD)}, [LAYER_NAVIGATION] = {ENCODER_CCW_CW(KC_PGDN, KC_PGUP), ENCODER_CCW_CW(KC_VOLU, KC_VOLD)},
[LAYER_POINTER] = {ENCODER_CCW_CW(RGB_HUD, RGB_HUI), ENCODER_CCW_CW(RGB_SAD, RGB_SAI)}, [LAYER_MOUSE] = {ENCODER_CCW_CW(RGB_HUD, RGB_HUI), ENCODER_CCW_CW(RGB_SAD, RGB_SAI)},
[LAYER_MEDIA] = {ENCODER_CCW_CW(KC_PGDN, KC_PGUP), ENCODER_CCW_CW(KC_VOLU, KC_VOLD)},
[LAYER_NUMERAL] = {ENCODER_CCW_CW(RGB_VAD, RGB_VAI), ENCODER_CCW_CW(RGB_SPD, RGB_SPI)}, [LAYER_NUMERAL] = {ENCODER_CCW_CW(RGB_VAD, RGB_VAI), ENCODER_CCW_CW(RGB_SPD, RGB_SPI)},
[LAYER_SYMBOLS] = {ENCODER_CCW_CW(RGB_RMOD, RGB_MOD), ENCODER_CCW_CW(KC_LEFT, KC_RGHT)}, [LAYER_SYMBOLS] = {ENCODER_CCW_CW(RGB_RMOD, RGB_MOD), ENCODER_CCW_CW(KC_LEFT, KC_RGHT)},
[LAYER_FUNCTION] = {ENCODER_CCW_CW(KC_DOWN, KC_UP), ENCODER_CCW_CW(KC_LEFT, KC_RGHT)},
}; };
// clang-format on // clang-format on
#endif // ENCODER_MAP_ENABLE #endif // ENCODER_MAP_ENABLE