ClaytonWWilson/miryoku_zmk
1
0
Fork 0
mirror of https://github.com/ClaytonWWilson/miryoku_zmk.git synced 2025-12-13 17:58:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Cleanup

Browse Source
This commit is contained in:
Manna Harbour 2020-10-27 21:57:56 +11:00
parent 2a8f927a3b
commit 2b5529ae96
2 changed files with 74 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

115
miryoku-zmk.org
View File

@ -27,12 +27,13 @@ Miryoku is an ergonomic, minimal, orthogonal, and universal keyboard layout.
- [[#table-layout-full][table-layout-full]] - [[#table-layout-full][table-layout-full]]
- [[#table-layer-defines][table-layer-defines]] - [[#table-layer-defines][table-layer-defines]]
- [[#data][Data]] - [[#data][Data]]
- [[#layers-1][layers]]
- [[#symbol-names][symbol-names]] - [[#symbol-names][symbol-names]]
- [[#mods][mods]] - [[#mods][mods]]
- [[#nonkc][nonkc]] - [[#nonkp][nonkp]]
- [[#header][header]] - [[#header][header]]
- [[#subset-mapping][Subset Mapping]] - [[#subset-mapping][Subset Mapping]]
- [[#userspace][Userspace]] - [[#miryoku-include][miryoku include]]
- [[#miryokukeymap][[[./miryoku.keymap]]]] - [[#miryokukeymap][[[./miryoku.keymap]]]]
- [[#documentation][Documentation]] - [[#documentation][Documentation]]
- [[#contact][Contact]] - [[#contact][Contact]]
@ -331,10 +332,10 @@ Duplicate base layer tap keys on thumbs rather than trans to enable auto-repeat.
Produce base layer from separate tap and hold tables. Produce base layer from separate tap and hold tables.
#+NAME: table-layout-taphold #+NAME: table-layout-taphold
#+BEGIN_SRC python :var layer_name="BASE" :var tap_table=colemakdhm :var hold_table=hold :var symbol_names_table=symbol-names :var mods_table=mods :var nonkc_table=nonkc :tangle no :results verbatim #+BEGIN_SRC python :var tap_table=colemakdhm :var hold_table=hold :var symbol_names_table=symbol-names :var mods_table=mods :var nonkp_table=nonkp :tangle no :results verbatim
width = 14 width = 14
mods_dict = dict.fromkeys(mods_table[0]) mods_dict = dict.fromkeys(mods_table[0])
nonkc_tuple = tuple(nonkc_table[0]) nonkp_tuple = tuple(nonkp_table[0])
symbol_names_dict = {} symbol_names_dict = {}
results = '' results = ''
for symbol, name, shifted_symbol, shifted_name in symbol_names_table: for symbol, name, shifted_symbol, shifted_name in symbol_names_table:
@ -350,9 +351,9 @@ for tap_row, hold_row in map(None, tap_table, hold_table):
code = tap code = tap
if hold in mods_dict: if hold in mods_dict:
code = '&hm ' + str(hold) + ' ' + code code = '&hm ' + str(hold) + ' ' + code
elif hold != '' and not str(hold).startswith(nonkc_tuple): elif hold != '' and not str(hold).startswith(nonkp_tuple):
code = '&lt ' + str(hold) + ' ' + code code = '&lt ' + str(hold) + ' ' + code
elif not str(code).startswith(nonkc_tuple): elif not str(code).startswith(nonkp_tuple):
code = '&kp ' + str(code) code = '&kp ' + str(code)
results += (code + ', ').ljust(width) results += (code + ', ').ljust(width)
results = results.rstrip(' ') + '\n' results = results.rstrip(' ') + '\n'
@ -374,10 +375,10 @@ incorporating mods and reset from base layer. Layer names must end with 'R' or
'L'. A layer with shifted symbols can also be generated. 'L'. A layer with shifted symbols can also be generated.
#+NAME: table-layout-half #+NAME: table-layout-half
#+BEGIN_SRC python :var hold_table=hold :var layer_name="NSL" :var half_table=nsl :var symbol_names_table=symbol-names :var mods_table=mods :var nonkc_table=nonkc :var shift="false" :tangle no :results verbatim #+BEGIN_SRC python :var hold_table=hold :var mode="l" :var half_table=nsl :var symbol_names_table=symbol-names :var mods_table=mods :var nonkp_table=nonkp :var shift="false" :tangle no :results verbatim
width = 10 width = 10
mods_dict = dict.fromkeys(mods_table[0]) mods_dict = dict.fromkeys(mods_table[0])
nonkc_tuple = tuple(nonkc_table[0]) nonkp_tuple = tuple(nonkp_table[0])
symbol_names_dict = {} symbol_names_dict = {}
shifted_symbol_names_dict = {} shifted_symbol_names_dict = {}
for symbol, name, shifted_symbol, shifted_name in symbol_names_table: for symbol, name, shifted_symbol, shifted_name in symbol_names_table:
@ -385,7 +386,6 @@ for symbol, name, shifted_symbol, shifted_name in symbol_names_table:
symbol_names_dict[shifted_symbol] = shifted_name symbol_names_dict[shifted_symbol] = shifted_name
shifted_symbol_names_dict[symbol] = shifted_name shifted_symbol_names_dict[symbol] = shifted_name
length = len(half_table[0]) length = len(half_table[0])
mode = layer_name[-1:].lower()
results = '' results = ''
for half_row, hold_row in map(None, half_table, hold_table): for half_row, hold_row in map(None, half_table, hold_table):
hold_row_l, hold_row_r = hold_row[:length], hold_row[length:] hold_row_l, hold_row_r = hold_row[:length], hold_row[length:]
@ -400,16 +400,16 @@ for half_row, hold_row in map(None, half_table, hold_table):
code = symbol_names_dict[half] code = symbol_names_dict[half]
else: else:
code = half code = half
if not str(code).startswith(nonkc_tuple): if not str(code).startswith(nonkp_tuple):
code = '&kp ' + str(code) code = '&kp ' + str(code)
results += (str(code) + ', ').ljust(width) results += (str(code) + ', ').ljust(width)
else: else:
for hold in hold_row_lr: for hold in hold_row_lr:
if hold == '' or not str(hold).startswith(nonkc_tuple) and hold not in mods_dict: if hold == '' or not str(hold).startswith(nonkp_tuple) and hold not in mods_dict:
code = 'X_NA' code = 'X_NA'
else: else:
code = hold code = hold
if not str(code).startswith(nonkc_tuple): if not str(code).startswith(nonkp_tuple):
code = '&kp ' + str(code) code = '&kp ' + str(code)
results += (str(code) + ', ').ljust(width) results += (str(code) + ', ').ljust(width)
results = results.rstrip(' ') + '\n' results = results.rstrip(' ') + '\n'
@ -429,10 +429,10 @@ return results
Produce full layer from single table. Fill for unused keys is configurable. Produce full layer from single table. Fill for unused keys is configurable.
#+NAME: table-layout-full #+NAME: table-layout-full
#+BEGIN_SRC python :var table=mbo :var layer_name="MBO" :var fill="&trans" :var symbol_names_table=symbol-names :var nonkc_table=nonkc :tangle no :results verbatim #+BEGIN_SRC python :var table=mbo :var fill="&trans" :var symbol_names_table=symbol-names :var nonkp_table=nonkp :tangle no :results verbatim
width = 10 width = 10
symbol_names_dict = {} symbol_names_dict = {}
nonkc_tuple = tuple(nonkc_table[0]) nonkp_tuple = tuple(nonkp_table[0])
for symbol, name, shifted_symbol, shifted_name in symbol_names_table: for symbol, name, shifted_symbol, shifted_name in symbol_names_table:
symbol_names_dict[symbol] = name symbol_names_dict[symbol] = name
symbol_names_dict[shifted_symbol] = shifted_name symbol_names_dict[shifted_symbol] = shifted_name
@ -445,7 +445,7 @@ for row in table:
code = symbol_names_dict[key] code = symbol_names_dict[key]
else: else:
code = key code = key
if not str(code).startswith(nonkc_tuple): if not str(code).startswith(nonkp_tuple):
code = '&kp ' + str(code) code = '&kp ' + str(code)
results += (code + ', ').ljust(width) results += (code + ', ').ljust(width)
results = results.rstrip(' ') + '\n' results = results.rstrip(' ') + '\n'
@ -465,33 +465,36 @@ return results
Produce layer defines from layer names in hold table. Produce layer defines from layer names in hold table.
#+NAME: table-layer-defines #+NAME: table-layer-defines
#+BEGIN_SRC python :var hold_table=hold :var mods_table=mods :var nonkc_table=nonkc :tangle no #+BEGIN_SRC python :var layers_table=layers :tangle no
width = 5 width = 5
mods_dict = dict.fromkeys(mods_table[0]) layers_list = layers_table[0]
nonkc_tuple = tuple(nonkc_table[0]) results = ''
results = '#define BASE 0\n#define MBO 1\n' i = 0
i = 2 for layer in layers_list:
for hold_row in hold_table: results += '#define ' + ( layer + ' ').ljust(width) + str(i) + '\n'
for hold in hold_row: i += 1
if hold not in mods_dict and hold != '' and not str(hold).startswith(nonkc_tuple):
results += '#define ' + (hold + ' ').ljust(width) + str(i) + '\n'
i += 1
return results return results
#+END_SRC #+END_SRC
#+RESULTS: table-layer-defines #+RESULTS: table-layer-defines
: #define BASE 0 : #define BASE 0
: #define MBO 1 : #define MBO 1
: #define MEDR 2 : #define NAVR 2
: #define NAVR 3 : #define MOUR 3
: #define MOUR 4 : #define MEDR 4
: #define NSSL 5 : #define NSL 5
: #define NSL 6 : #define NSSL 6
: #define FUNL 7 : #define FUNL 7
** Data ** Data
*** layers
#+NAME: layers
| BASE | MBO | NAVR | MOUR | MEDR | NSL | NSSL | FUNL |
*** symbol-names *** symbol-names
Symbol, name, and shifted symbol mappings for use in tables. Symbol, name, and shifted symbol mappings for use in tables.
@ -529,12 +532,12 @@ versions.
| LSFT | LCTL | LALT | LGUI | ALGR | | LSFT | LCTL | LALT | LGUI | ALGR |
*** nonkc *** nonkp
Keycodes that match any of these prefixes will not have ~KC_~ automatically Keycodes that match any of these prefixes will not have ~KC_~ automatically
prepended. prepended.
#+NAME: nonkc #+NAME: nonkp
| X_ | & | | X_ | & |
@ -553,7 +556,7 @@ generated from miryoku_zmk.org -*- buffer-read-only: t -*-
The keymap, build options, and configuration are shared between keyboards. The The keymap, build options, and configuration are shared between keyboards. The
layout is mapped onto keyboards with different physical layouts as a subset. layout is mapped onto keyboards with different physical layouts as a subset.
** Userspace ** miryoku include
*** [[./miryoku.keymap]] *** [[./miryoku.keymap]]
@ -598,31 +601,31 @@ layout is mapped onto keyboards with different physical layouts as a subset.
bindings = < bindings = <
#if defined MIRYOKU_ALPHAS_COLEMAK #if defined MIRYOKU_ALPHAS_COLEMAK
SUBMAP( SUBMAP(
<<table-layout-taphold(layer_name="BASE", tap_table=colemak, hold_table=hold)>> <<table-layout-taphold(tap_table=colemak)>>
) )
#elif defined MIRYOKU_ALPHAS_COLEMAKDH #elif defined MIRYOKU_ALPHAS_COLEMAKDH
SUBMAP( SUBMAP(
<<table-layout-taphold(layer_name="BASE", tap_table=colemakdh, hold_table=hold)>> <<table-layout-taphold(tap_table=colemakdh)>>
) )
#elif defined MIRYOKU_ALPHAS_DVORAK #elif defined MIRYOKU_ALPHAS_DVORAK
SUBMAP( SUBMAP(
<<table-layout-taphold(layer_name="BASE", tap_table=dvorak, hold_table=hold)>> <<table-layout-taphold(tap_table=dvorak)>>
) )
#elif defined MIRYOKU_ALPHAS_HALMAK #elif defined MIRYOKU_ALPHAS_HALMAK
SUBMAP( SUBMAP(
<<table-layout-taphold(layer_name="BASE", tap_table=halmak, hold_table=hold)>> <<table-layout-taphold(tap_table=halmak)>>
) )
#elif defined MIRYOKU_ALPHAS_WORKMAN #elif defined MIRYOKU_ALPHAS_WORKMAN
SUBMAP( SUBMAP(
<<table-layout-taphold(layer_name="BASE", tap_table=workman, hold_table=hold)>> <<table-layout-taphold(tap_table=workman)>>
) )
#elif defined MIRYOKU_ALPHAS_QWERTY #elif defined MIRYOKU_ALPHAS_QWERTY
SUBMAP( SUBMAP(
<<table-layout-taphold(layer_name="BASE", tap_table=qwerty, hold_table=hold)>> <<table-layout-taphold(tap_table=qwerty)>>
) )
#else #else
SUBMAP( SUBMAP(
<<table-layout-taphold(layer_name="BASE", tap_table=colemakdhm, hold_table=hold)>> <<table-layout-taphold(tap_table=colemakdhm)>>
) )
#endif #endif
>; >;
@ -630,7 +633,7 @@ layout is mapped onto keyboards with different physical layouts as a subset.
MBO_layer { MBO_layer {
bindings = < bindings = <
SUBMAP( SUBMAP(
<<table-layout-full(layer_name="MBO", table=mbo, fill="&trans")>> <<table-layout-full(table=mbo)>>
) )
>; >;
}; };
@ -638,11 +641,11 @@ layout is mapped onto keyboards with different physical layouts as a subset.
bindings = < bindings = <
#if defined MIRYOKU_NAV_VI #if defined MIRYOKU_NAV_VI
SUBMAP( SUBMAP(
<<table-layout-half(layer_name="NAVR", half_table=navr-vi)>> <<table-layout-half(mode="r", half_table=navr-vi)>>
) )
#else #else
SUBMAP( SUBMAP(
<<table-layout-half(layer_name="NAVR", half_table=navr)>> <<table-layout-half(mode="r", half_table=navr)>>
) )
#endif #endif
>; >;
@ -651,11 +654,11 @@ layout is mapped onto keyboards with different physical layouts as a subset.
bindings = < bindings = <
#if defined MIRYOKU_NAV_VI #if defined MIRYOKU_NAV_VI
SUBMAP( SUBMAP(
<<table-layout-half(layer_name="MOUR", half_table=mour-vi)>> <<table-layout-half(mode="r", half_table=mour-vi)>>
) )
#else #else
SUBMAP( SUBMAP(
<<table-layout-half(layer_name="MOUR", half_table=mour)>> <<table-layout-half(mode="r", half_table=mour)>>
) )
#endif #endif
>; >;
@ -664,33 +667,33 @@ layout is mapped onto keyboards with different physical layouts as a subset.
bindings = < bindings = <
#if defined MIRYOKU_NAV_VI #if defined MIRYOKU_NAV_VI
SUBMAP( SUBMAP(
<<table-layout-half(layer_name="MEDR", half_table=medr-vi)>> <<table-layout-half(mode="r", half_table=medr-vi)>>
) )
#else #else
SUBMAP( SUBMAP(
<<table-layout-half(layer_name="MEDR", half_table=medr)>> <<table-layout-half(mode="r", half_table=medr)>>
) )
#endif #endif
>; >;
}; };
FUNL_layer {
bindings = <
SUBMAP(
<<table-layout-half(layer_name="FUNL", half_table=funl)>>
)
>;
};
NSL_layer { NSL_layer {
bindings = < bindings = <
SUBMAP( SUBMAP(
<<table-layout-half(layer_name="NSL", half_table=nsl)>> <<table-layout-half(mode="l", half_table=nsl)>>
) )
>; >;
}; };
NSSL_layer { NSSL_layer {
bindings = < bindings = <
SUBMAP( SUBMAP(
<<table-layout-half(layer_name="NSSL", half_table=nssl)>> <<table-layout-half(mode="l", half_table=nssl)>>
)
>;
};
FUNL_layer {
bindings = <
SUBMAP(
<<table-layout-half(mode="l", half_table=funl)>>
) )
>; >;
}; };

30
miryoku.keymap
View File

@ -17,11 +17,11 @@
#define BASE 0 #define BASE 0
#define MBO 1 #define MBO 1
#define MEDR 2 #define NAVR 2
#define NAVR 3 #define MOUR 3
#define MOUR 4 #define MEDR 4
#define NSSL 5 #define NSL 5
#define NSL 6 #define NSSL 6
#define FUNL 7 #define FUNL 7
#define X_NP &none // key is not present #define X_NP &none // key is not present
@ -162,16 +162,6 @@ X_NP, X_NP, X_NA, X_NA, X_NA, &kp MSTP, &kp MPLY, &kp MUTE,
#endif #endif
>; >;
}; };
FUNL_layer {
bindings = <
SUBMAP(
&kp F12, &kp F7, &kp F8, &kp F9, &kp PSCR, X_NA, X_NA, X_NA, X_NA, &rst,
&kp F11, &kp F4, &kp F5, &kp F6, &kp SLCK, X_NA, &kp LSFT, &kp LCTL, &kp LALT, &kp LGUI,
&kp F10, &kp F1, &kp F2, &kp F3, &kp PAUS, X_NA, X_NA, X_NA, &kp ALGR, X_NA,
X_NP, X_NP, &kp APP, &kp SPC, &kp TAB, X_NA, X_NA, X_NA, X_NP, X_NP
)
>;
};
NSL_layer { NSL_layer {
bindings = < bindings = <
SUBMAP( SUBMAP(
@ -192,6 +182,16 @@ X_NP, X_NP, &kp LPRN, &kp RPRN, &kp UNDS, X_NA, X_NA, X_NA,
) )
>; >;
}; };
FUNL_layer {
bindings = <
SUBMAP(
&kp F12, &kp F7, &kp F8, &kp F9, &kp PSCR, X_NA, X_NA, X_NA, X_NA, &rst,
&kp F11, &kp F4, &kp F5, &kp F6, &kp SLCK, X_NA, &kp LSFT, &kp LCTL, &kp LALT, &kp LGUI,
&kp F10, &kp F1, &kp F2, &kp F3, &kp PAUS, X_NA, X_NA, X_NA, &kp ALGR, X_NA,
X_NP, X_NP, &kp APP, &kp SPC, &kp TAB, X_NA, X_NA, X_NA, X_NP, X_NP
)
>;
};
}; };
}; };
}; };