# manna-harbour/miryoku architecture

> Architecture diagram of the GitHub repository manna-harbour/miryoku, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/manna-harbour/miryoku
- Repository: https://github.com/manna-harbour/miryoku

## Overview

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.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Main Core Node
    A["Miryoku Keyboard Layout"]:::core

    %% Core Data Assets Subgraph
    subgraph "Core Data Assets"
        B["Layers (JSON)"]:::data
        C["Keyboard Mappings"]:::data
        D["Configurator Files"]:::data
        E["KMonad Configurations"]:::data
        F["Cover Assets"]:::data
    end

    %% Firmware Implementations Subgraph
    subgraph "Firmware Implementations"
        G["Miryoku QMK"]:::impl
        H["Miryoku ZMK"]:::impl
        I["Miryoku KMonad"]:::impl
        J["Miryoku KMK"]:::impl
        K["Miryoku Babel"]:::impl
    end

    %% Customization Tools Subgraph
    subgraph "Customization Tools"
        M["Oryx Interface/Tool"]:::tool
    end

    %% Support & Documentation Subgraph
    subgraph "Support & Documentation"
        N["Documentation (Docs)"]:::doc
        P["Documentation Reference"]:::doc
        Q["Readme (org)"]:::doc
        R["Project Governance"]:::support
    end

    %% Connections from core layout to core data assets
    A --> B
    A --> C
    A --> D
    A --> E
    A --> F

    %% Connections from core layout to firmware implementations
    A --> G
    A --> H
    A --> I
    A --> J
    A --> K

    %% Connection from core layout to customization tool
    A --> M

    %% Connections from core layout to support & documentation
    A --> N
    A --> P
    A --> Q
    A --> R

    %% Styles for nodes
    classDef core fill:#AED6F1,stroke:#1B4F72,stroke-width:2px;
    classDef data fill:#ABEBC6,stroke:#1D8348,stroke-width:2px;
    classDef impl fill:#F5B7B1,stroke:#922B21,stroke-width:2px;
    classDef tool fill:#F9E79F,stroke:#B7950B,stroke-width:2px;
    classDef doc fill:#D2B4DE,stroke:#6C3483,stroke-width:2px;
    classDef support fill:#FAD7A0,stroke:#B9770E,stroke-width:2px;

    %% Click Events for Component Mapping
    click B "https://github.com/manna-harbour/miryoku/tree/master/data/layers"
    click C "https://github.com/manna-harbour/miryoku/tree/master/data/mapping"
    click D "https://github.com/manna-harbour/miryoku/tree/master/data/configurator"
    click E "https://github.com/manna-harbour/miryoku/tree/master/data/kmonad"
    click F "https://github.com/manna-harbour/miryoku/tree/master/data/cover"
    click M "https://github.com/manna-harbour/miryoku/tree/master/data/oryx"
    click N "https://github.com/manna-harbour/miryoku/tree/master/docs"
    click P "https://github.com/manna-harbour/miryoku/tree/master/docs/reference"
    click Q "https://github.com/manna-harbour/miryoku/blob/master/readme.org"
    click R "https://github.com/manna-harbour/miryoku/blob/master/.github"
```
