Miryoku is an ergonomic, minimal, orthogonal, and universal keyboard layout. Miryoku ZMK is the Miryoku implementation for ZMK.
This document describes Miryoku ZMK only. For Miryoku documentation, implementations, and discussions and support, see Miryoku.
See the Miryoku ZMK Quickstart Guide to have a personalised build running on your keyboard in a few minutes without installing any software or editing any files.
Building can be performed locally, or via GitHub Actions workflows without use of a local build environment. Many keyboards are supported, and building out-of-tree keyboards is automatically supported by the workflows.
Workflow builds can be customised by copying and editing one of the example workflows or by filling out a form, and specifying options. Local and workflow builds can be customised by editing a config file, and an example is included.
The keyboard keymaps are composed of the config file, a mapping for the physical layout, and the Miryoku keymap.
Additional and Experimental Features include caps word, customisation, double tap boot, global shift functions, key emulation combos, mouse keys, soft off, tap delay, and 𝑥MK. Open issues are also noted.
First set up the ZMK build environment and build and flash the default keymap for your keyboard.
Clone this repository and set ZMK_CONFIG to the absolute path of the config subdirectory. Use the config file to select alternative layout and mapping options.
Firmware can be built via GitHub Actions workflows without use of a local build environment.
First log in to GitHub, fork the Miryoku ZMK repository, and enable workflows.
To access a workflow, visit the Actions tab and select the workflow. To download the firmware from a workflow run, select the workflow, select the workflow run, select the desired Artifacts, and unzip the downloaded zip file.
See the Miryoku ZMK Quickstart Guide for step by step instructions.
Workflow files are in .github/workflows.
To enable Miryoku ZMK workflow debugging, set the following secret in the repository: MIRYOKU_DEBUG to MIRYOKU_DEBUG_TRUE. Optionally also enable step debugging.
Copy one of the included Build Example workflow files, edit the name value, edit and add options and values as desired, and push changes. Access the workflow, select Run workflow, select the Branch if desired, and activate Run workflow.
Options are specified in the with section and are of the following form.
option: '["value"]'
For multiple values per option use the following form, and a matrix build will be performed for each combination of values across all options.
option: '["value1","value2"]'
See Options below for a description of each option.
The Build Inputs workflow can be used without editing workflow files. Access the workflow, Select Run workflow, select the Branch and fill out the form as desired, and activate Run workflow.
Most options are specified by entering values directly in the corresponding field. Multiple comma separated values can be entered per option and a matrix build will be performed for each combination of values across all options.
Values for Miryoku alternative layout options are selected from a list. As multiple selection is not supported, matrix builds across multiple values are not possible for these options, and the Test Inputs or Build Example workflows should be used instead.
See Options below for a description of each option.
All workflow options are described below.
The board option is required and all others are optional.
See Supported Keyboards for details of supported keyboards.
Specifies the ZMK board.
For onboard controller keyboards (keyboards with an integrated controller), enter the keyboard name, e.g. ahokore, ble_chiffre, technikable, zaphod.
For split onboard controller keyboards (keyboards with an integrated controller on each side), enter the keyboard side name, e.g. corneish_zen_v1_left, corneish_zen_v1_right. To build both sides in the same run, enter both keyboard side names separated by a comma, e.g. corneish_zen_v1_left,corneish_zen_v1_right.
For composite keyboards (keyboards with a separate controller), enter the controller name, e.g. nice_nano, nice_nano_v2, seeeduino_xiao, seeeduino_xiao_ble. Also specify the shield.
Specifies the ZMK shield.
For onboard controller keyboards (keyboards with an integrated controller), leave as default.
For composite keyboards (keyboards with a separate controller), enter the keyboard name, e.g. absolem, chocv, eek, osprette.
For split composite keyboards (keyboards with a separate controller on each side), enter the keyboard side name, e.g. corne_left, corne_right, cradio_left, cradio_right. To build both sides in the same run, enter both keyboard side names separated by a comma, e.g. corne_left,corne_right, cradio_left,cradio_right.
Also use to specify optional non-keyboard shields, e.g. nice_view. To combine shields, separate with space, e.g. nice_view_adapter nice_view, corne_left nice_view_adapter nice_view. For multiple builds of combined shields in the same run, use both comma and space separators, e.g. corne_left nice_view_adapter nice_view,corne_right nice_view_adapter nice_view.
The alphas, extra, tap, nav, clipboard, and layers options correspond to the Miryoku alternative layout options. See the default layers and alternative layouts documentation for details. See the Test All Configs workflow file for a list of all supported values.
The mapping option corresponds to the alternative mapping options.
Alternative layout and mapping options are given in the documentation in the form MIRYOKU_OPTION=VALUE, e.g. MIRYOKU_ALPHAS=QWERTY. To use here, use the value with the corresponding option. Use default to represent the default value. Values for these five options are case-insensitive.
Select an alternative alphas layout, e.g. colemak, dvorak, halmak, qwerty. For Colemak Mod-DH, leave as default.
Select an alternative Nav layout, e.g. invertedt, vi. For home position line nav, leave as default.
Select an alternative layers layout, e.g. flip. For right hand Nav, leave as default.
Select an alternative mapping, e.g. extended_thumbs, pinkie_stagger. For the default mapping, leave as default.
Appends to the config file, e.g. #define MIRYOKU_CLIPBOARD_WIN. Join multiple lines with \n, e.g. #define MIRYOKU_EXTRA_DVORAK\n#define MIRYOKU_TAP_QWERTY\n#define MIRYOKU_CLIPBOARD_WIN. For no additional config, leave as default.
These options are not available in the Build Inputs workflow due to platform limitations. Use the custom_config option instead.
Select an alternative alphas layout for the Extra layer, e.g. colemak, dvorak, halmak, qwerty. For QWERTY, leave as default.
Select an alternative alphas layout for the Tap layer, e.g. colemak, dvorak, halmak, qwerty. For Colemak Mod-DH, leave as default.
Select an alternative clipboard type, e.g. mac, win. For CUA bindings, leave as default.
Appends to Kconfig configuration. Join multiple lines with \n. For no additional config, leave as default.
Used to select an alternative ZMK branch for building, and to merge branches into ZMK at build time.
Branches are specified in the form <user>/<repo>/<branch>. E.g. the default ZMK branch would be specified as zmkfirmware/zmk/main.
Multiple space separated branches can be specified. The first branch specified is used as an alternative ZMK branch for building. Any additional branches will be merged. Automatic merging is only possible where there are no conflicts. If there are conflicts, build from the branch directly, or request a rebase from the branch maintainer.
For no changes, leave as default.
Used to build with external modules.
Modules are specified in the form <user>/<repo>/<branch>.
Multiple space separated modules can be specified.
For no changes, leave as default.
In-tree keyboards are maintained as part of ZMK. See the ZMK Supported Hardware documentation for details.
Supporting an in-tree keyboard in Miryoku ZMK requires only adding the keyboard keymap and mapping files.
Out-of-tree keyboards are not maintained as part of ZMK or Miryoku ZMK. Keyboard definitions for out-of-tree keyboards are located in separate repositories. Some keyboards also require ZMK forks or external modules. Keyboard definitions, ZMK forks, and external modules are maintained by the maintainers of those repositories.
To build an out-of-tree keyboard the repositories need be checked out and used appropriately. For local builds these steps must be performed manually. For workflow builds the Miryoku ZMK build workflows perform these steps automatically at build time using outboards.
Supporting an out-of-tree keyboard in Miryoku ZMK requires adding the keymap, mapping, and outboards files.
See the Test All Controllers, Boards, and Shields workflow files for lists of supported keyboards.
See outboards for details of supported out-of-tree keyboards.
See manna-harbour/miryoku#81 for available and supported in-tree and out-of-tree keyboards.
Outboards are files containing out-of-tree board and shield definition metadata.
Files are at .github/workflows/outboards. Outboards for boards and shields are contained in the corresponding subdirectories. Files are named after the base board or shield name (i.e. without revision or _left / _right suffixes).
Outboards contain Bourne shell variable assignments. Supported variables are described below. See the files for samples.
Board or shield definitions stored in an external repository are cloned and symlinked at build time according to the following variables. All are required.
The repository containing the board or shield definition. For GitHub repositories, the https://github.com/ prefix can be omitted.
The name of the branch containing the board or shield definition.
The path to the directory containing the board or shield definition.
The path to the directory below config/ where the board or shield definition should be located.
Specify if the board or shield requires or is defined in one or more ZMK forks. Use is the same as for the workflow branches option.
If the board or shield definition is contained in a specified branch, repository and symlink variables are not required.
If branches are also specified via the workflow branches option or in other outboards, all branches will be used.
Specify if the board or shield requires or is defined in one or more external modules. Use is the same as for the workflow modules option.
If the board or shield definition is contained in a specified module, repository and symlink variables are not required.
If modules are also specified via the workflow modules option or in other outboards, all modules will be used.
Notes are provided below for individual keyboards where required.
For Corne-ish Zen v1 (GB R1 and R2) build with board corneish_zen_v1_left,corneish_zen_v1_right, and for Corne-ish Zen v2 (GB R3) build with board corneish_zen_v2_left,corneish_zen_v2_right.
A custom branch is also available at https://github.com/caksoylar/zmk/tree/caksoylar/zen-v1+v2 that includes additional display improvements and options. Documentation is at https://gist.github.com/caksoylar/c411313990978e1903c244f03039187a. Options can be selected with Kconfig configuration. For workflow builds using the Build Inputs workflow, use caksoylar/zmk/caksoylar/zen-v1+v2 with the branches option. For workflow builds using Build Example workflows, see the Build Example Corne-ish Zen Custom workflow. For local builds, make the changes locally.
The config file is used to specify alternative layout and mapping options for local builds. Options are given in the documentation in the form MIRYOKU_OPTION=VALUE. Convert to the form #define MIRYOKU_OPTION_VALUE and add to the config file.
The config file can also be used to set default alternative layout and mapping options for workflow builds, as an alternative to using the corresponding alternative layout and mapping workflow options. In this case setting different values for the same option in the config file and in the workflow options may lead to undefined behaviour.
The config file can also be used to set other Miryoku ZMK configuration options for local and workflow builds.
Config file entries can also be specified in the custom_config option for workflow builds.
The file is miryoku/custom_config.h. See the example config file. The config file is included into the keyboard’s keymap file before the mapping with:
#include "../miryoku/custom_config.h"Below is an example config file with the following alternative layout and mapping options:
MIRYOKU_ALPHAS=QWERTYMIRYOKU_TAP=QWERTYMIRYOKU_EXTRA=COLEMAKDHMIRYOKU_NAV=INVERTEDTMIRYOKU_CLIPBOARD=WINMIRYOKU_LAYERS=FLIPMIRYOKU_MAPPING=EXTENDED_THUMBS
// Copyright 2022 Manna Harbour
// https://github.com/manna-harbour/miryoku
#define MIRYOKU_ALPHAS_QWERTY
#define MIRYOKU_TAP_QWERTY
#define MIRYOKU_EXTRA_COLEMAKDH
#define MIRYOKU_NAV_INVERTEDT
#define MIRYOKU_CLIPBOARD_WIN
#define MIRYOKU_LAYERS_FLIP
#define MIRYOKU_MAPPING_EXTENDED_THUMBSThe Miryoku keymap is a ZMK DT keymap file using C preprocessor macros for configuration options and to abstract the physical layout. The Miryoku keymap file is miryoku/miryoku.dtsi. The file is included into the keyboard’s keymap after the config file and mapping with:
#include "../miryoku/miryoku.dtsi"Macros are included from miryoku/miryoku.h. Layer data is generated by Miryoku Babel and is included from files in the miryoku/miryoku_babel directory.
The keymap is mapped onto keyboards with different physical layouts. The keymap is specified in terms of the MIRYOKU_MAPPING macro. The macro is defined in a C header file for each physical layout. Unused keys are mapped to &none. The files are below miryoku/mapping/. The mapping file is included into the keyboard keymap file before the Miryoku keymap with e.g.
#include "../miryoku/mapping/36/minidox.h"On each hand, only the main alpha block of 3 rows by 5 columns and the 3 most appropriate thumb keys are used.
Notes or diagrams are provided below where the selection of keys is not obvious or where alternatives are provided via mapping configuration options.
Bottom row combos and thumb combos are enabled.
Thumb combos are enabled.
MIRYOKU_MAPPING=2X2U
Supports Bruce/Le Chiffre 2x2u configuration. Thumb combos are enabled.
Default. 3x1U thumb keys.
MIRYOKU_MAPPING=PIM447RIGHT
For use with PIM447 installed in the right secondary thumb key position. The right tertiary thumb key is replaced with the secondary and thumb combos are enabled. Note that the right secondary thumb key is in the opposite position from usual, relative to the primary.
The outer pinkie column key can be used as an alternative to the top row pinkie column key.
The thumbs keys, from left to right, are as follows: left secondary, left primary, right secondary, right primary, right tertiary. Thumb combos are enabled for the left thumbs. The left thumb keys are also duplicated on the left outer pinkie column, from top to bottom, as follows: primary, tertiary, secondary. Note that the left secondary thumb key is in the opposite position from usual, relative to the primary. For MIRYOKU_LAYERS=FLIP, substitute left and right above.
The middle 2 columns are unused.
Supports ortho and MIT configurations.
MIRYOKU_MAPPING=2X2U
Supports 2x2u configuration.
MIRYOKU_MAPPING=EXTENDED_THUMBS
The thumb keys are moved 1u to extend the thumbs. Supports ortho configuration.
MIRYOKU_MAPPING=EXTENDED_THUMBS
MIRYOKU_MAPPING=PINKIE_STAGGER
MIRYOKU_MAPPING=EXTENDED_THUMBS
An angled ortho split layout is mapped onto the row-staggered keyboard. The rows are moved up to better position the thumb keys, the hands are separated as much as possible, and the left hand column angle is reversed to reduce ulnar deviation of the wrists.
MIRYOKU_MAPPING=NOREVERSEANGLE
An alternative subset mapping is also provided without reverse column angle.
MIRYOKU_MAPPING=LITE
Another alternative subset mapping is provided mapping only the 3x10 alphas, plus spacebar for space / Nav, with the remainder being the default keymap with semicolon in place of quote.
The keyboard keymaps include the config file, a mapping for the physical layout, and the Miryoku keymap. Keyboard keymap files are in config.
Kconfig keyboard configuration options can be set in config/<keyboard>.conf as usual for local and workflow builds.
Examples include CONFIG_ZMK_SLEEP=y, CONFIG_ZMK_DISPLAY=y, CONFIG_BT_CTLR_TX_PWR_PLUS_8=y.
Also see the default <keyboard>.conf included in the keyboard definition, e.g. corne.conf.
Kconfig configuration can also be specified in the kconfig option for workflow builds.
Caps word is used in place of Caps Lock. Combine with Shift for Caps Lock.
Double tap is used with Additional features. Double tap for the bootloader behavior is not supported in ZMK on split keyboards. See zmkfirmware/zmk#1494. By default, double tap for bootloader is disabled. Use a single tap instead.
Double tap for bootloader can be enabled for use with non-split keyboards. For local builds, add #define MIRYOKU_KLUDGE_DOUBLETAPBOOT to the config file. For workflow builds, use #define MIRYOKU_KLUDGE_DOUBLETAPBOOT with the custom_config option.
Use with split keyboards will result in the bootloader function only taking effect on the central side. Use a reset button to enter the bootloader on the peripheral side.
Shift functions are used on Media. Shift functions are not supported in ZMK for RGB and EP behaviors on split keyboards. See zmkfirmware/zmk#1494. By default, shift functions for RGB and EP are disabled. Only the unshifted functions are available.
Shift functions for RGB and EP can be enabled for use with non-split keyboards. For local builds, add #define MIRYOKU_KLUDGE_GLOBALSHIFTFUNCTIONS to the config file. For workflow builds, use #define MIRYOKU_KLUDGE_GLOBALSHIFTFUNCTIONS with the custom_config option.
Use with split keyboards will result in the shifted as well as the unshifted functions for RGB and EP only taking effect on the central side.
Emulate a key with a combo of two other keys. Enabled automatically on keyboards with a missing key. Can be enabled on other keyboards for use with hard to reach keys, or for compatibility.
On the top row on each hand, combo the ring and middle finger keys to emulate the pinkie key, and combo the middle and index finger keys to emulate the inner index key.
Requires CONFIG_ZMK_COMBO_MAX_COMBOS_PER_KEY=16 Kconfig configuration.
On the bottom row on each hand, combo the ring and middle finger keys to emulate the pinkie key, and combo the middle and index finger keys to emulate the inner index key.
Requires CONFIG_ZMK_COMBO_MAX_COMBOS_PER_KEY=16 Kconfig configuration.
On each hand, combo the primary and secondary thumb keys to emulate the tertiary thumb key. Requires suitable keycaps to enable the thumb to press both keys simultaneously.
ZMK supports mouse buttons only.
Mouse movement requires enabling mouse keys on the host. Mouse scroll is not supported.
Mouse movement and scroll is supported with https://github.com/petejohanson/zmk/tree/feat/pointers-move-scroll from zmkfirmware/zmk#2027.
To build, add #define MIRYOKU_KLUDGE_MOUSEKEYSPR to the config file, add CONFIG_ZMK_MOUSE=y to the Kconfig configuration, and switch to or merge the mousekeys branch.
For workflow builds using the Build Inputs workflow, use #define MIRYOKU_KLUDGE_MOUSEKEYSPR with the custom_config option, CONFIG_ZMK_MOUSE=y with the kconfig option, and petejohanson/zmk/feat/pointers-move-scroll with the branches option. Alternatively, use zmkfirmware/zmk/main petejohanson/zmk/feat/pointers-move-scroll to attempt an automatic merge of the branch into ZMK main.
For workflow builds using Build Example workflows, see the Build Example mousekeyspr workflow.
For local builds, make the changes locally.
Support for soft off can be enabled.
Soft off takes the place of the boot key.
For local builds, add #define MIRYOKU_KLUDGE_SOFT_OFF to the config file and CONFIG_ZMK_PM_SOFT_OFF=y to the Kconfig configuration.
For workflow builds using the Build Inputs workflow, use #define MIRYOKU_KLUDGE_SOFT_OFF with the custom_config option, and CONFIG_ZMK_PM_SOFT_OFF=y with the kconfig option.
For workflow builds using Build Example workflows, see the Build Example soft_off workflow.
Adds a delay between press and release of hold-tap taps, as a work around for zmkfirmware/zmk#1444.
For local builds, add #define MIRYOKU_KLUDGE_TAPDELAY to the config file. For workflow builds, use #define MIRYOKU_KLUDGE_TAPDELAY with the custom_config option.
Use Miryoku ZMK with any keyboard with 𝑥MK.
For local builds, first switch to or merge zmkfirmware/zmk#1318. Add https://github.com/manna-harbour/xmk/tree/main/zmk/boards/shields/xmk as config/boards/shields/xmk. Build with shield xmk and the appropriate board.
For workflow builds using the Build Inputs workflow, use xmk with the shield option, the appropriate board with the board option, and petejohanson/zmk/shell/tap-command with the branches option. Alternatively, use zmkfirmware/zmk/main petejohanson/zmk/shell/tap-command to attempt an automatic merge of the branch into ZMK main.
For workflow builds using Build Example workflows, see the Build Example 𝑥MK xmk workflow.
For local builds, first switch to or merge zmkfirmware/zmk#1318. Add #define MIRYOKU_KLUDGE_TAPDELAY to the config file. Build with board native_posix_64.
For workflow builds using the Build Inputs workflow, use native_posix_64 with the board option, #define MIRYOKU_KLUDGE_TAPDELAY with the custom_config option, and petejohanson/zmk/shell/tap-command with the branches option. Alternatively, use zmkfirmware/zmk/main petejohanson/zmk/shell/tap-command to attempt an automatic merge of the branch into ZMK main.
For workflow builds using Build Example workflows, see the Build Example 𝑥MK native_posix_64 workflow.
Current layer lock is not supported in ZMK. Use opposite layer lock with the opposite hand instead. See zmkfirmware/zmk#1299.
