hey, i just wanted to say miryoku is great. i was able to use the workflows to build my firmware but i had to add support for the colemakdh option. which i did. if you'd like i can add it to the zmk repo and i can update the miryoku docs. i figured other users, or the wylderbuild guy himself, may wanna flash his boards using miryoku but he was too busy to get it working so i took the liberty of pushing those changes here in case others would like miryoku.

Update build-inputs.yml; adding colemakdh as missing alpha Update wylderbulids config.h; trying to get the right thumb key assigned to the keymap update wylderbuild readmee change keymap given thumbkey mismapping

@bullwinkle3000

Currently when building I receive the following errors:

❯ make draculad:manna-harbour_miryoku MIRYOKU_CLIPBOARD=MAC
Making draculad with keymap manna-harbour_miryoku

avr-gcc (Homebrew AVR GCC 8.5.0) 8.5.0
Copyright (C) 2018 Free Software Foundation, Inc.
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Generating: .build/obj_draculad/src/info_config.h                                                   [OK]
Generating: .build/obj_draculad/src/default_keyboard.c                                              [OK]
Generating: .build/obj_draculad/src/default_keyboard.h                                              [OK]
Compiling: keyboards/draculad/draculad.c                                                            [OK]
Compiling: .build/obj_draculad/src/default_keyboard.c                                               [OK]
Compiling: quantum/keymap_introspection.c                                                          In file included from quantum/keymap_introspection.c:9:
users/manna-harbour_miryoku/manna-harbour_miryoku.c: In function 'u_td_fn_U_SYM':
users/manna-harbour_miryoku/manna-harbour_miryoku.c:29:23: error: unsigned conversion from 'int' to 'layer_state_t' {aka 'unsigned char'} changes value from '256' to '0' [-Werror=overflow]
     default_layer_set((layer_state_t)1 << U_##LAYER); \
                       ^~~~~~~~~~~~~~~~~~~~~~
users/manna-harbour_miryoku/miryoku_babel/miryoku_layer_list.h:20:1: note: in expansion of macro 'MIRYOKU_X'
 MIRYOKU_X(SYM,    "Sym") \
 ^~~~~~~~~
users/manna-harbour_miryoku/manna-harbour_miryoku.c:32:1: note: in expansion of macro 'MIRYOKU_LAYER_LIST'
 MIRYOKU_LAYER_LIST
 ^~~~~~~~~~~~~~~~~~
users/manna-harbour_miryoku/manna-harbour_miryoku.c: In function 'u_td_fn_U_FUN':
users/manna-harbour_miryoku/manna-harbour_miryoku.c:29:23: error: unsigned conversion from 'int' to 'layer_state_t' {aka 'unsigned char'} changes value from '512' to '0' [-Werror=overflow]
     default_layer_set((layer_state_t)1 << U_##LAYER); \
                       ^~~~~~~~~~~~~~~~~~~~~~
users/manna-harbour_miryoku/miryoku_babel/miryoku_layer_list.h:21:1: note: in expansion of macro 'MIRYOKU_X'
 MIRYOKU_X(FUN,    "Fun")
 ^~~~~~~~~
users/manna-harbour_miryoku/manna-harbour_miryoku.c:32:1: note: in expansion of macro 'MIRYOKU_LAYER_LIST'
 MIRYOKU_LAYER_LIST
 ^~~~~~~~~~~~~~~~~~
quantum/keymap_introspection.c: At top level:
quantum/keymap_introspection.c:20:1: error: static assertion failed: "Number of keymap layers exceeds maximum set by LAYER_STATE_(8|16|32)BIT"
 _Static_assert(NUM_KEYMAP_LAYERS <= MAX_LAYER, "Number of keymap layers exceeds maximum set by LAYER_STATE_(8|16|32)BIT");
 ^~~~~~~~~~~~~~
cc1: all warnings being treated as errors
 [ERRORS]
 |
 |
 |
make[1]: *** [.build/obj_draculad_manna-harbour_miryoku/quantum/keymap_introspection.o] Error 1
make: *** [draculad:manna-harbour_miryoku] Error 1
Make finished with errors

The assertion was introduced recently(ish) so I just commented that out.

For the type casting errors I just added a surrounding parenthesis to the shifted value.

I am not sure if this is the correct way to fix this, but it prevents the build errors for now.

This change allows the user to create custom combos.

To facilitate this, I

• added a new option MIRYOKU_CUSTOM_COMBO_COUNT and
• included the file custom_keymap.c from manna-harbour_miryoku.h
• created a stub for custom_keymap.c based on custom_config.h

To define custom combos, set MIRYOKU_CUSTOM_COMBO_COUNT to the amount of combos that are defined and define combos in custom_keymap.c

Example custom_keymap.c:

const uint16_t PROGMEM repeat_home[] = {KC_J, KC_K, COMBO_END};

#define MIRYOKU_CUSTOM_COMBOS \
  COMBO(repeat_home, KC_ESC)

custom_rules.mk:

MIRYOKU_CUSTOM_COMBO_COUNT=1

This change allows the user to flip individual layers.

To facilitate this, I

• changed the parameter MIRYOKU_LAYERS to
  • accept values of the form FLIP_$LAYER (e.g. MIRYOKU_LAYERS=FLIP_SYM)
  • accept a list of values separated by commas
• added a new parameter MIRYOKU_THUMBKEYS_LAYER, that
  • accepts values of the form $THUMBKEY=$LAYER (e.g. LO=MEDIA)
    • for now I've named the thumb keys by hand and relative position, though I'm open to changing that
      • (left outer) LO
      • (left middle) LM
      • (left inner) LI
      • (right inner) RI
      • (right middle) RM
      • (right outer) RO
  • accepts a list of values separated by commas

I've also added an additional parameter MIRYOKU_THUMBKEYS_KEYCODE that allows the user to rebind the thumb keys. This parameter accepts a comma-separated list of values of the form $THUMBKEY=$QMK_KEY_CODE.

At the same time, this change allows decoupling the flipping of layers from the flipping of layer change keys. If a user wishes to use the same hand for switching to a layer (to facilitate one-handed media control for example), this is now possible.

Further this also simplifies using the thumb keys in combos since all thumbkey bindings are now defined as MIRYOKU_THUMBKEY_$THUMBKEY for the Layer-Tap binding and MIRYOKU_THUMBKEY_$THUMBKEY_KC for the Tap binding.

Following an example configuration (custom_rules.mk)

MIRYOKU_LAYERS=FLIP_MEDIA
MIRYOKU_THUMBKEYS_LAYER=LO=MOUSE,LI=MEDIA
MIRYOKU_THUMBKEYS_KEYCODE=RM=KC_DEL,RO=KC_BSPC

This flips the media layer while keeping all other layers and the thumb keys in normal order. It also switches the bindings for the MEDIA and MOUSE layers and switches Backspace and Delete.