Skip to content
This repository has been archived by the owner on Sep 30, 2024. It is now read-only.

Latest commit

 

History

History
 
 

reference

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 

Miryoku Reference Manual ../../data/logos/miryoku-roa-32.png

Miryoku is an ergonomic, minimal, orthogonal, and universal keyboard layout.

Layout

General Principles

  • Use layers instead of reaching.
  • Use both hands instead of contortions.
  • Use the home positions as much as possible.
  • Make full use of the thumbs.
  • Avoid unnecessary complication.

Details

  • 5 columns, 3 rows, 3 thumb keys, 2 hands.
  • Can be used on almost any split or non-split ergo or ortho keyboard.
  • Includes all keys found on a US layout TKL keyboard, plus media keys and mouse emulation.
  • Home row is the middle row, home thumb key is the middle thumb key.
  • Maximum 1-u movement from home position for fingers and thumbs, and only along one axis (except for the inner index finger column which is deprioritised compared with the home columns).
  • Dual-function modifiers on home row, mirrored on both hands.
  • Dual-function layer change on thumbs.
  • Layers are designed orthogonally with a single purpose per hand and are accessed by holding a thumb key on the opposite hand.
  • All layers on the same hand are based on the same basic key arrangement.
  • Holding layer change and modifiers on one hand combined with a single key press on the other hand can produce any combination of modifiers and single keys without any finger contortions.
  • Single function mods are also defined on layers on the same hand as the layer change thumb key so layer change and mods can be held in any order or simultaneously without race conditions.
  • As mods are only enabled on the opposite hand, auto-repeat is available on the home row on layers for use with cursor and mouse keys.
  • Tap-hold auto-repeat is disabled to permit faster tap-hold switching on thumbs, but thumb tap keys are mirrored onto some layers for use with auto-repeat. On other layers thumb keys are redefined with important functions for that layer.
  • Auto Shift for numbers and symbols.
  • Reset is available on sub layers on the same hand as the layer change thumb key. Hold any thumb key and tap the top row pinkie column key on the same hand.

Layers

../../data/layers/miryoku-kle-reference.png

Base

../../data/layers/miryoku-kle-base.png

The base layer alphas are Colemak Mod-DH. Comma, Dot, and Slash, are included with the alphas, plus Apostrophe replacing Semicolon. Combine with Shift for Less Than, Greater Than, Question Mark, and Quote, as usual. The primary, secondary, and tertiary thumb keys are Backspace, Enter, and Delete on the right, and Space, Tab, and Escape on the left, respectively.

Alternative alpha arrangements are also available.

Nav

../../data/layers/miryoku-kle-nav.png

Primary right-hand layer (left home thumb) is navigation and editing. Cursor keys are on the home position, line and page movement below, clipboard above, Caps Lock and Insert on the inner column. Thumb keys are duplicated from the base layer to avoid having to layer change mid edit and to enable auto-repeat.

Alternative clipboard key mappings and navigation key arrangements are available.

Mouse

../../data/layers/miryoku-kle-mouse.png

Secondary right-hand layer is mouse emulation. Mouse movement mirrors cursor navigation on home and wheel mirrors line / page movement below. Mouse buttons are on the thumbs. Left, right, and middle mouse buttons are on the primary, secondary, and tertiary thumb keys, respectively. Mouse movement, click, and drag, with modifiers, can be performed from the home position. Clipboard keys are duplicated from the Nav layer.

Button

../../data/layers/miryoku-kle-button.png

Provides mouse buttons, mods, and clipboard keys for use with integrated or external pointing devices, used with either hand. The layer is available for automatic activation depending on hardware and configuration. It can also be activated manually by holding a bottom row pinkie key (however Super and Undo will be unavailable).

Media

../../data/layers/miryoku-kle-media.png

Tertiary right-hand layer is media control, with Volume Up / Volume Down and Next / Prev mirroring the navigation keys. Pause, Stop and Mute are on the primary, secondary, and tertiary thumbs, respectively.

Keyboard hardware controls are also present, and depend on hardware and firmware support.

RGB control is on the top row. RGB Toggle is on the inner index column key. Combine with Shift for RGB Off. RGB Mode, RGB Hue, RGB Saturation, and RGB Value are on index, middle, ring, and pinkie column keys, respectively. Tapping will increase the corresponding value. Combine with Shift to decrease.

External Power Toggle is on the middle row inner index column key. Combine with Shift for External Power Off

Bluetooth profile and output selection are on the bottom row. Output Toggle is on the inner index column key. Combine with Shift for Output USB. Bluetooth profile selection BT 0, BT 1, BT 2, and BT 3 are on the index, middle, ring, and pinkie column keys, respectively. Combine with Shift to select and clear the corresponding profile.

Num

../../data/layers/miryoku-kle-num.png

Primary left-hand layer (right home thumb) is numerals and symbols. Numerals are in the standard numpad locations with symbols in the remaining positions. Dot is duplicated from the base layer.

Sym

../../data/layers/miryoku-kle-sym.png

Secondary left-hand layer has shifted symbols in the same locations to reduce chording when using mods with shifted symbols. Open Parenthesis is duplicated next to Close Parenthesis.

Fun

../../data/layers/miryoku-kle-fun.png

Tertiary left-hand layer has function keys mirroring the numerals on the primary layer with extras on the pinkie column, plus system keys on the inner column. App is on the tertiary thumb key and other thumb keys are duplicated from the base layer to enable auto-repeat.

Additional Features

../../data/layers/miryoku-kle-features.png

During thumb key layer-tap hold, keys on the same hand as the hold, other than mods, are used for additional features that are not needed during normal typing.

The top row pinkie column key activates the bootloader.

The top row index, middle, and ring column keys are used to switch between and return to alternate Base layers. Index is Base, middle is Extra, and ring is Tap. The Extra alpha arrangement defaults to QWERTY. Tap has only the tap functions of Base with no dual-function keys. Returning from Tap requires a reset or adding a custom keybinding. The Tap alpha arrangement defaults to Colemak Mod-DH. Alternative alpha arrangements are also available.

The bottom row index and middle column keys are used for layer lock. Index is for the current layer. Middle is for the opposite layer (normally activated with the corresponding primary, secondary, or tertiary thumb key on the opposite hand) and can be used for single handed lock and layer use.

To prevent accidental activation, all additional features require a double tap to activate.

Alternative Layouts

The defaults are recommended, but alternative layouts are provided to accommodate existing muscle memory and platform differences.

Alphas

Standard alpha arrangements, plus Comma / Less Than, Dot / Greater Than, Slash / Question Mark, and Apostrophe / Quote.

Base
AZERTY

MIRYOKU_ALPHAS=AZERTY

Colemak

MIRYOKU_ALPHAS=COLEMAK

Colemak Mod-DHk

MIRYOKU_ALPHAS=COLEMAKDHK

Dvorak

MIRYOKU_ALPHAS=DVORAK

Halmak

MIRYOKU_ALPHAS=HALMAK

Workman

MIRYOKU_ALPHAS=WORKMAN

QWERTY

MIRYOKU_ALPHAS=QWERTY

QWERTZ

MIRYOKU_ALPHAS=QWERTZ

Extra

The same alpha arrangements are available as for Base. Use MIRYOKU_EXTRA e.g. MIRYOKU_EXTRA=COLEMAKDH.

Tap

The same alpha arrangements are available as for Base. Use MIRYOKU_TAP e.g. MIRYOKU_TAP=QWERTY.

Nav

vi-Style

MIRYOKU_NAV=VI

Columns are moved left one position to match hjkl positions, and the inner index column is moved to the pinkie column. All same hand sub layers are modified in the same way. The clipboard row is unchanged.

Not available with MIRYOKU_LAYERS=FLIP.

Inverted-T

MIRYOKU_NAV=INVERTEDT

Cursor keys are in an inverted-T arrangement with Down on the middle finger home position, Home / End to the left / right of Up, and Page Up / Page Down on the pinkie column. Clipboard keys are on the bottom row. Insert moves to the top row. Caps Lock is unchanged. All same hand sub layers are modified in the same way.

Clipboard

Default

The main clipboard keys (Cut, Copy, and Paste) use the CUA bindings and should work in general unix and windows applications, emacs, and terminal emulators. The additional keys (Undo, Redo) use Fun Cluster keycodes and usually require rebinding in the application.

Fun Cluster

MIRYOKU_CLIPBOARD=FUN

Mac

MIRYOKU_CLIPBOARD=MAC

Windows

MIRYOKU_CLIPBOARD=WIN

Layers

Flip

MIRYOKU_LAYERS=FLIP

Flip base layer thumb keys and sub layers between right and left hands.

Flip Layers Inverted-T Nav

../../data/layers/miryoku-kle-reference-flip-invertedt.png

MIRYOKU_NAV=INVERTEDT

As per Inverted-T Nav but with Flip Layers transformation.

../../data/logos/manna-harbour-boa-32.png