explaingit

manna-harbour/miryoku

★ 3,700MakefileAudience · developerComplexity · 3/5Setup · moderate

TLDR

Miryoku is an ergonomic keyboard layout for small ortholinear keyboards that uses thumb-key layers to reach all characters with minimal finger movement. It has ports for QMK, ZMK, KMonad, and KMK.

Mindmap

mindmap
  root((repo))
    What it does
      Ergonomic layout
      Layer-based typing
      Minimal movement
    Tech stack
      Makefile
      QMK ZMK
      KMonad KMK
    Use cases
      Small keyboard setup
      Custom firmware flash
      Ergonomic typing
    Audience
      Keyboard hobbyists
      Custom kb builders
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Flash an ergonomic layer layout onto a 36-key ortholinear keyboard using QMK or ZMK

USE CASE 2

Configure a ZSA Moonlander or Ergodox with the Miryoku layout using the Oryx tool

USE CASE 3

Adopt a minimal-movement typing layout to reduce finger strain on a small custom keyboard

Tech stack

MakefileQMKZMKKMonadKMK

Getting it running

Difficulty · moderate Time to first run · 1h+

Requires a compatible ortholinear keyboard and familiarity with the relevant firmware platform (QMK, ZMK, etc.) to build and flash.

In plain English

Miryoku is a keyboard layout designed around a specific set of goals: ergonomic hand position, minimal finger movement, and compatibility with a wide range of keyboards. The layout is intended for small keyboards that have keys arranged in an orthogonal (straight columns and rows) grid rather than the staggered layout found on most standard keyboards. It is also designed to work with keyboards that have very few keys, sometimes as few as 34 or 36, by making heavy use of layers. The layout organizes characters, numbers, symbols, and functions across multiple layers that you switch between by holding thumb keys. This way a tiny keyboard can still reach the full range of keys without your fingers moving far from a small home area. The design philosophy is that you should be able to type everything you need with minimal effort once you have learned the layer structure. Miryoku is not a single firmware file but a layout specification that has been implemented for several different keyboard firmware projects. The README links to separate repositories for QMK, ZMK, KMonad, KMK, and Babel, which are the most common firmware platforms for custom mechanical keyboards. There is also a version for Oryx, which is the configuration tool for ZSA keyboards like the Moonlander and Ergodox. The project includes a reference manual with the full layout details and a discussion thread for questions and support. Building or flashing Miryoku requires familiarity with one of the supported firmware platforms and a compatible keyboard. The README itself is minimal, acting mainly as an index to the per-platform repositories.

Copy-paste prompts

Prompt 1
How do I flash the Miryoku layout onto my QMK-compatible keyboard and understand the layer structure?
Prompt 2
What is the Miryoku layer layout and which thumb keys switch between layers?
Prompt 3
How do I set up Miryoku on a ZSA Moonlander using the Oryx configuration tool?
Prompt 4
Compare Miryoku QMK vs ZMK implementations and tell me which one to use for my split keyboard
Open on GitHub → Explain another repo

← manna-harbour on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.