mirror of https://github.com/ClaytonWWilson/miryoku_zmk.git synced 2025-12-13 17:58:47 +00:00

Miryoku is an ergonomic, minimal, orthogonal, and universal keyboard layout. Miryoku ZMK is the Miryoku implementation for ZMK.

Go to file

Manna Harbour b9f178edef Fix keycode translation for clipboard-mac Co-authored-by: Arte Ebrahimi <arteebrahimi@gmail.com>		2022-06-02 16:03:50 +10:00
.github/workflows	Change everything	2022-06-02 16:03:50 +10:00
config	Rename planck.keymap	2022-06-02 16:03:50 +10:00
miryoku	Fix keycode translation for clipboard-mac	2022-06-02 16:03:50 +10:00
readme.org	Minor text changes	2022-06-02 16:03:50 +10:00
status.org	Rename mapping files	2022-06-02 16:03:50 +10:00

readme.org

Miryoku ZMK

Contents
Miryoku Keymap
Configuration Options
Mapping
- Layouts
  - 34-ferris
  - 36-minidox
  - 42-corne
  - 44-jian
  - 48-planck
  - 50-kyria
  - 56-iris
  - 58-lily58
  - 60-sofle
  - 62-atreus62
  - 64-helix
Keyboard Keymaps
Prebuilt Firmware
Contact

Miryoku is an ergonomic, minimal, orthogonal, and universal keyboard layout. This is the miryoku implementation for ZMK.

Miryoku Keymap

The miryoku keymap is a ZMK DT keymap file using C preprocessor macros for configuration options and to abstract the physical layout. The file is miryoku/miryoku.dtsi. The file is included into the keyboard's keymap with

#include "../miryoku/miryoku.dtsi"

Configuration Options

todo

Mapping

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's 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 included where the selection of keys is not obvious or where options are provided.

Layouts

34-ferris

Combos of primary and secondary thumb keys emulate the missing tertiary thumb key. To enable with other subset mappings for compatibility, add #define MIRYOKU_COMBO_TPS_ENABLE to the keymap before the includes.

36-minidox

42-corne

44-jian

48-planck

50-kyria

56-iris

58-lily58

60-sofle

62-atreus62

64-helix

Keyboard Keymaps

Keymap files for many keyboards included in ZMK are provided in config/.

Prebuilt Firmware

Prebuilt firmware for supported keyboards can be downloaded from the repo when logged in. From the Actions tab select the latest successful workflow run, then select the keyboard in the Artifacts section.

Contact

For issues with the code, including requests for any of the following, please create an issue. Pull requests are also welcome.

Additional mapping and keyboard keymap files
Additional mapping options (see miryoku QMK for examples)
Populating unused keys in MIRYOKU_MAPPING_TAP (currently skipped for some mapping files)