How manna-harbour/miryoku works
This project is a repository for the Miryoku universal keyboard layout – a collection of ergonomic, minimal, orthogonal key mappings that can be deployed across multiple firmware implementations (like QMK, ZMK, KMonad, KMK, and Babel) as well as configuration tools (such as the Miryoku configurator and Oryx). The repository is largely a data/configuration resource rather than a conventional “application” with runtime logic.
Main Components
• Core Data Assets:
• Layers (JSON files defining various layout layers such as base, button, features, etc.)
• Mapping files (different mappings for various keyboard models and layouts)
• Configurators (files in the “configurator” directory, offering layout export in different formats)
• KMonad configurations (within the “kmonad” directory)
• Cover assets (which may be packaging or visual representation files)
• Implementations:
• Direct pointers to external repositories (Miryoku QMK, Miryoku ZMK, etc.) that “use” these configuration files.
• The “oryx” folder (likely a specialized interface or tool as part of the ecosystem).
• Supporting Documentation:
• User Guides, Reference Manuals and other org-mode documents within “docs” and “readme.org”.
• Contributor & Project Support Materials:
• GitHub configurations (".github" directory) such as issue templates, funding configurations, etc.
Relationships and Interactions
• Central Concept: At the heart is the “Miryoku Keyboard Layout” concept, which is defined by a collection of JSON data files (layers, mappings, kmonad configurations, etc.).
• Documentation: Include a documentation node that ties into both the core layout (providing reference information) and the implementation guides for each firmware adaptation.
Architectural Patterns and Design Principles
• Modularity: The structure clearly embraces modularity with separate directories for layers, mappings, and firmware-specific configurations.
• Reusability: The same layout definitions are used across multiple target firmware projects, suggesting a layered or plug-in style architecture where the central layout details can be “plugged in” to various systems.
• Separation of Concerns: Documentation, data, and integration points have been cleanly separated into different folders.
Relevant Technologies and Domains
• JSON configuration files as the primary data representation.
• Integration with various open-source keyboard firmware repositories.
• Organizational tools such as org-mode for documentation.
• GitHub infrastructure for community contributions and support.