ClaytonWWilson/miryoku_zmk
1
0
Fork 0
mirror of https://github.com/ClaytonWWilson/miryoku_zmk.git synced 2025-12-13 09:48:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Miryoku is an ergonomic, minimal, orthogonal, and universal keyboard layout. Miryoku ZMK is the Miryoku implementation for ZMK.
33 Commits 1 Branch 0 Tags 668 KiB
C 100%
c4394254f6
Go to file
Manna Harbour c4394254f6 Change everything 
-add keymaps for all zmk splergos
-add mappings
-move babel to miryoku/miryoku-zmk-babel.org
-generate only miryoku.dtsi from babel
-move status to status.org
-move docs to readme.org
-change mapping macro names
-add everything to build
2022-06-02 16:03:50 +10:00
.github/workflows Change everything 2022-06-02 16:03:50 +10:00
config Change everything 2022-06-02 16:03:50 +10:00
miryoku Change everything 2022-06-02 16:03:50 +10:00
readme.org Change everything 2022-06-02 16:03:50 +10:00
status.org Change everything 2022-06-02 16:03:50 +10:00

readme.org

Miryoku ZMK https://raw.githubusercontent.com/manna-harbour/miryoku/master/data/logos/miryoku-roa-32.png

https://raw.githubusercontent.com/manna-harbour/miryoku/master/data/cover/miryoku-kle-cover.png

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

Contents   TOC_3

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/split_3x5_3.dtsi"

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.

Generic Layouts

These mappings can be used by multiple keyboards with functionally identical physical layouts.

jian

Used by:

  • jian
  • jorne

ortho_4x12

https://raw.githubusercontent.com/manna-harbour/miryoku/master/data/mapping/miryoku-kle-mapping-ortho_4x12.png

split_3x5_2

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.

split_3x5_3

split_3x6_3

Keyboard-Specific Layouts

kyria

https://raw.githubusercontent.com/manna-harbour/miryoku/master/data/mapping/miryoku-kle-mapping-kyria.png

Keyboard Keymaps

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

Contact

To request 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)

https://raw.githubusercontent.com/manna-harbour/miryoku/master/data/logos/manna-harbour-boa-32.png