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 editing one of the examples, or by filling out a form. Local builds can be customised by editing a config file, and an example is included.
The keyboard keymap includes the config file, the Miryoku keymap, and a mapping for the physical layout.
Additional and Experimental Features include mouse keys on the host and key emulation combos.
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.
Workflow files are in .github/workflows.
Copy one of the included Build Example workflow files, edit the name value, and edit and add options and values as desired. 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"]'
The board option specifies the ZMK board and is required. All other options are optional.
The shield option specifies the ZMK shield.
The alphas, nav, clipboard, and layers options correspond to the alternative layout options. 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. To use here, convert to the form specified above. Use default to represent the default value. Values for these five options are case-insensitive.
See the Test All workflow files for all supported values for each option.
The kconfig option can be used to for Kconfig configuration. Join multiple lines with \n.
The zmk option can be used to build from an alternative ZMK branch. The branch is specified as <user>/<repo>/<branch>.
The merge option can be used to merge branches into ZMK at build time. Branches are specified as <user>/<repo>/<branch>. To merge multiple branches, separate with space.
The Build Inputs workflow can be used without editing workflow files. Select Run workflow, select the Branch and fill out the form as desired, and activate Run workflow.
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.
The Board option specifies the ZMK board and is required. All other options are optional.
The Shield option specifies the ZMK shield.
The Miryoku Alphas, Miryoku Nav, Miryoku Clipboard, and Miryoku Layers options correspond to the alternative layout options. The Miryoku Mapping option corresponds to the alternative mapping options. Alternative layout and mapping options are given in the documentation in the form MIRYOKU_OPTION=VALUE. To use here, enter the value in the corresponding Miryoku Option field. Use default to represent the default value. Values for these five options are case-insensitive.
The Kconfig option can be used to for Kconfig configuration. Join multiple lines with \n.
The ZMK option can be used to build from an alternative ZMK branch. The branch is specified as <user>/<repo>/<branch>.
The Merge option can be used to merge branches into ZMK at build time. Branches are specified as <user>/<repo>/<branch>. To merge multiple branches, separate with space.
Any board supported by ZMK with a keymap in Miryoku ZMK. See the Test All Boards workflow file for a list of all supported boards (including outboards).
Any compatible combination of board supported by ZMK and shield supported by ZMK with a keymap in Miryoku ZMK. See the Test All Shields workflow file for a list of all supported shields (including outboards).
Additionally, building some out of tree boards and shields is automatically supported by the included workflows. See .github/workflows/outboards.
For local builds, copy the board or shield definition to the appropriate location under config.
The config file specifies alternative layout and mapping options for all local builds. The config file is not used in workflow 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 file is miryoku/config.h. See the example config file. The config file is included into the keyboard’s keymap file before the mapping with:
#include "../miryoku/config.h"Below is an example config file with the following configuration options:
MIRYOKU_ALPHAS=QWERTYMIRYOKU_NAV=INVERTEDTMIRYOKU_CLIPBOARD=WINMIRYOKU_LAYERS=FLIPMIRYOKU_MAPPING=EXTENDED_THUMBS
// Copyright 2021 Manna Harbour
// https://github.com/manna-harbour/miryoku
#define MIRYOKU_ALPHAS_QWERTY
#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 in 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.
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
Keymap files for many keyboards are provided in config.
Kconfig configuration can be set in config/<keyboard>.conf for local and workflow builds, or in the kconfig / Kconfig option for workflow builds.
Additional Kconfig documentation is available at https://deploy-preview-722–zmk.netlify.app/docs/config/index/.
The Mouse and Button layers use mouse keys on the host. Middle button, right button, and scroll are not supported.
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.
