Viewing keymap file generated in workflow

[plo009]

Hi there,

New to mryoku, I have successfully built a firmware for reviung41 using github flow following the guides, but is there any way to view the keymap files generated during the workflow so I can have an idea if the keymap?

Since the reviung41 only has 5 thumb keys, I'd like to see what keymap has miryoku created for it.

Cheers

[manna-harbour]

Reviung41 was added before thumb combos and wasn't updated. I've just updated the mapping and added a description. Please update your fork, rebuild, and re-flash. Unfortunately the Reviung boards are missing thumb keys and the ones they do have do not match the Miryoku thumb key comfort order, so there are compromises.

[manna-harbour]

There are other possibilities for the mapping. These were being trialled earlier. To customise the mapping, see #85.

// Copyright 2021 Manna Harbour
// https://github.com/manna-harbour/miryoku

#define XXX &none

// Reviung41 thumb keys: A B C D E F
// Miryoku thumb keys: L3 L1 L2 R2 R1 R3

// For all options, swap L-R with MIRYOKU_LAYERS_FLIP

#if defined (MIRYOKU_MAPPING_A)
// option A
// L2 L1 R2 R1 R3, combo L1+L2=L3
// - relative position of L2 is changed
//   thumb combo
// + fully functional
  #if defined (MIRYOKU_LAYERS_FLIP)
    #define MIRYOKU_MAPPING( \
     K00, K01, K02, K03, K04,      K05, K06, K07, K08, K09, \
     K10, K11, K12, K13, K14,      K15, K16, K17, K18, K19, \
     K20, K21, K22, K23, K24,      K25, K26, K27, K28, K29, \
     N30, N31, K32, K33, K34,      K35, K36, K37, N38, N39 \
) \
XXX  K00  K01  K02  K03  K04       K05  K06  K07  K08  K09  XXX \
XXX  K10  K11  K12  K13  K14       K15  K16  K17  K18  K19  XXX \
XXX  K20  K21  K22  K23  K24       K25  K26  K27  K28  K29  XXX \
                    K32  K33  K34  K36  K35
    #define MIRYOKU_KLUDGE_THUMBCOMBOS_RIGHT 39 40
  #else
    #define MIRYOKU_MAPPING( \
     K00, K01, K02, K03, K04,      K05, K06, K07, K08, K09, \
     K10, K11, K12, K13, K14,      K15, K16, K17, K18, K19, \
     K20, K21, K22, K23, K24,      K25, K26, K27, K28, K29, \
     N30, N31, K32, K33, K34,      K35, K36, K37, N38, N39 \
) \
XXX  K00  K01  K02  K03  K04       K05  K06  K07  K08  K09  XXX \
XXX  K10  K11  K12  K13  K14       K15  K16  K17  K18  K19  XXX \
XXX  K20  K21  K22  K23  K24       K25  K26  K27  K28  K29  XXX \
                    K34  K33  K35  K36  K37
    #define MIRYOKU_KLUDGE_THUMBCOMBOS_LEFT 36 37
  #endif
  #define MIRYOKU_KLUDGE_THUMBCOMBOS
#elif defined (MIRYOKU_MAPPING_B)
// option B
// L2 L1 - R1 R2, combo L1+L2=L3 R1+R2=R3
// - relative position of L2 and R2 are changed
// - wastes middle thumb key
//   thumb combos
// + fully functional
// + compatible with other boards with missing secondary thumbs such as ble_chiffre
  #define MIRYOKU_MAPPING( \
     K00, K01, K02, K03, K04,      K05, K06, K07, K08, K09, \
     K10, K11, K12, K13, K14,      K15, K16, K17, K18, K19, \
     K20, K21, K22, K23, K24,      K25, K26, K27, K28, K29, \
     N30, N31, K32, K33, K34,      K35, K36, K37, N38, N39 \
) \
XXX  K00  K01  K02  K03  K04       K05  K06  K07  K08  K09  XXX \
XXX  K10  K11  K12  K13  K14       K15  K16  K17  K18  K19  XXX \
XXX  K20  K21  K22  K23  K24       K25  K26  K27  K28  K29  XXX \
                    K34  K33  XXX  K36  K35
  #define MIRYOKU_KLUDGE_THUMBCOMBOS_LEFT 36 37
  #define MIRYOKU_KLUDGE_THUMBCOMBOS_RIGHT 39 40
  #define MIRYOKU_KLUDGE_THUMBCOMBOS
#elif defined (MIRYOKU_MAPPING_C)
// option C
// L1 L2 - R2 R1, combo L1+L2=L3 R1+R2=R3
// + relative positions of thumbs unchanged
// - absolute positions of thumbs are changed
// - wastes middle thumb key
//   thumb combos
// + fully functional
  #define MIRYOKU_MAPPING( \
     K00, K01, K02, K03, K04,      K05, K06, K07, K08, K09, \
     K10, K11, K12, K13, K14,      K15, K16, K17, K18, K19, \
     K20, K21, K22, K23, K24,      K25, K26, K27, K28, K29, \
     N30, N31, K32, K33, K34,      K35, K36, K37, N38, N39 \
) \
XXX  K00  K01  K02  K03  K04       K05  K06  K07  K08  K09  XXX \
XXX  K10  K11  K12  K13  K14       K15  K16  K17  K18  K19  XXX \
XXX  K20  K21  K22  K23  K24       K25  K26  K27  K28  K29  XXX \
                    K33  K34  XXX  K35  K36
  #define MIRYOKU_KLUDGE_THUMBCOMBOS_LEFT 36 37
  #define MIRYOKU_KLUDGE_THUMBCOMBOS_RIGHT 39 40
  #define MIRYOKU_KLUDGE_THUMBCOMBOS
#else
// default
// L3 L1 R2 R1 R3, L2 is L outer pinkie home row
// + relative positions of thumbs unchanged
//   no thumb combo required
// - precludes some combinations
  #if defined (MIRYOKU_LAYERS_FLIP)
    #define MIRYOKU_MAPPING( \
     K00, K01, K02, K03, K04,      K05, K06, K07, K08, K09, \
     K10, K11, K12, K13, K14,      K15, K16, K17, K18, K19, \
     K20, K21, K22, K23, K24,      K25, K26, K27, K28, K29, \
     N30, N31, K32, K33, K34,      K35, K36, K37, N38, N39 \
) \
XXX  K00  K01  K02  K03  K04       K05  K06  K07  K08  K09  XXX \
XXX  K10  K11  K12  K13  K14       K15  K16  K17  K18  K19  K35 \
XXX  K20  K21  K22  K23  K24       K25  K26  K27  K28  K29  XXX \
                    K32  K33  K34  K36  K37
  #else
    #define MIRYOKU_MAPPING( \
     K00, K01, K02, K03, K04,      K05, K06, K07, K08, K09, \
     K10, K11, K12, K13, K14,      K15, K16, K17, K18, K19, \
     K20, K21, K22, K23, K24,      K25, K26, K27, K28, K29, \
     N30, N31, K32, K33, K34,      K35, K36, K37, N38, N39 \
) \
XXX  K00  K01  K02  K03  K04       K05  K06  K07  K08  K09  XXX \
K34  K10  K11  K12  K13  K14       K15  K16  K17  K18  K19  XXX \
XXX  K20  K21  K22  K23  K24       K25  K26  K27  K28  K29  XXX \
                    K32  K33  K35  K36  K37
  #endif
#endif

[plo009]

Thanks for the speedy reply and update :).
How does one perform a thumb combo, do you put you thumb between the 2 keys and try to activate them together? I see you mentioned that suitable keycaps are required.

[manna-harbour]

@plo009 Yes, just press both keys simultaneously with one thumb. The timeout is very forgiving, so you just need to ensure that both switches actuate. If you're used to typing lightly just to actuation and not bottoming out, that's hard to do with a one finger combo, so I just bottom out the thumb combo to make sure.

It requires that the top surface of the caps are close enough together. All choc caps should be ok, and also MX caps such as G20 (recommended for thumbs in general), DSA, and KAT, but tall narrow caps like SA or MT3 won't be suitable.

For reviung41, the last option above doesn't require thumb combos, but some key combinations with super + tertiary thumb won't be possible as they both use the same finger, and others may not be comfortable.