# blocamlimb/modernui architecture

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

- Interactive diagram: https://gitdiagram.com/blocamlimb/modernui
- Repository: https://github.com/blocamlimb/modernui

## Overview

##### Project type and purpose
- Modern UI is a multi-module, Java/Kotlin desktop application framework for real-time 2D/3D rendering (similar to JavaFX/Android).
- It bundles its own UI component library, event loop, text layout engine and integrates a low-level graphics engine (Arc3D).
- Optional extension modules (AWT integration, Markdown rendering, ViewPager) sit on top of the core.

##### File structure
- Top–level Gradle modules:
- core-ktx – Kotlin extension APIs over Modern UI core
- core – Java UI framework and component set
- x-awt – AWT platform bridge (GLCanvas, VKCanvas)
- x-markdown – Markdown to UI component renderer
- x-viewpager – ViewPager widget
- external/Arc3D – snapshot of the Arc3D low-level graphics engine
- Shared configuration (build.gradle, settings.gradle, Gradle wrapper) and external dependencies (LWJGL, fastutil, log4j, icu4j).
- Documentation (docs/javadoc) and tests under each module.

##### README for insights
- Core depends on Arc3D for GPU back‐end.
- Modules are pluggable: you choose only the platform/feature extensions you need.
- Build uses Gradle; target JDK 17+, OpenGL 3.3+/Vulkan 1.1.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Application Layer
    App["Application"]:::app

    %% Core Framework Layer
    subgraph "Core Framework"
        direction TB
        CoreKtx["Kotlin Extensions\n(core-ktx)"]:::core
        Core["Modern UI Core\n(core)"]:::core
    end

    %% Extension Modules Layer
    subgraph "Extension Modules"
        direction TB
        xAWT["AWT Integration\n(x-awt)"]:::ext
        xMarkdown["Markdown Rendering\n(x-markdown)"]:::ext
        xViewPager["ViewPager Widget\n(x-viewpager)"]:::ext
    end

    %% Rendering Engine Layer
    Arc3D["Arc3D Engine\n(external/Arc3D)"]:::engine

    %% Native Bindings & Dependencies
    LB["LWJGL & HarfBuzz\n(Native Bindings)"]:::native
    EL["External Libraries\n(fastutil, log4j, icu4j)"]:::native

    %% Development Assets
    subgraph "Development Assets"
        direction TB
        Docs["Documentation\n(docs/javadoc)"]:::docs
        CoreTests["Core Tests\n(core/src/test)"]:::tests
        KtxTests["Ktx Tests\n(core-ktx/src/test)"]:::tests
        ExtTests["Extension Tests\n(x-awt, x-markdown)"]:::tests
    end

    %% Build & Packaging
    Build["Build & Packaging\n(Gradle, Maven)"]:::build

    %% Data Flows and Dependencies
    App -->|"uses API"| CoreKtx
    CoreKtx -->|"extends"| Core
    Core -->|"render cmds"| Arc3D
    Arc3D -->|"via JNI"| LB
    LB -->|"drives"| GPU["GPU Driver"]:::native
    xAWT -->|"plugs into"| Core
    xMarkdown -->|"plugs into"| Core
    xViewPager -->|"plugs into"| Core
    Core -->|"depends on"| EL
    Build -->|"assembles modules"| Core
    Build --> CoreKtx
    Build --> xAWT
    Build --> xMarkdown
    Build --> xViewPager
    Build -->|"publishes to"| Maven["Maven Repository"]:::build
    Docs --> Build
    CoreTests --> Build
    KtxTests --> Build
    ExtTests --> Build

    %% Click Events
    click Core "https://github.com/blocamlimb/modernui/tree/master/core/src/main/java/icyllis/modernui"
    click CoreKtx "https://github.com/blocamlimb/modernui/tree/master/core-ktx/src/main/java/icyllis/modernui"
    click xAWT "https://github.com/blocamlimb/modernui/tree/master/x-awt/src/main/java/icyllis/modernui/core/awt"
    click xMarkdown "https://github.com/blocamlimb/modernui/tree/master/x-markdown/src/main/java/icyllis/modernui/markdown"
    click xViewPager "https://github.com/blocamlimb/modernui/blob/master/x-viewpager/src/main/java/icyllis/modernui/widget/ViewPager.java"
    click Arc3D "https://github.com/blocamlimb/modernui/tree/master/external/Arc3D/src/main/java/icyllis/arc3d"
    click Build "https://github.com/blocamlimb/modernui/blob/master/build.gradle"
    click Build "https://github.com/blocamlimb/modernui/blob/master/settings.gradle"
    click Build "https://github.com/blocamlimb/modernui/blob/master/gradle/wrapper/gradle-wrapper.properties"
    click CoreKtx "https://github.com/blocamlimb/modernui/blob/master/core-ktx/build.gradle"
    click Core "https://github.com/blocamlimb/modernui/blob/master/core/build.gradle"
    click xAWT "https://github.com/blocamlimb/modernui/blob/master/x-awt/build.gradle"
    click xMarkdown "https://github.com/blocamlimb/modernui/blob/master/x-markdown/build.gradle"
    click xViewPager "https://github.com/blocamlimb/modernui/blob/master/x-viewpager/build.gradle"
    click Docs "https://github.com/blocamlimb/modernui/tree/master/docs/javadoc"
    click CoreTests "https://github.com/blocamlimb/modernui/tree/master/core/src/test/java/icyllis/modernui/test"
    click KtxTests "https://github.com/blocamlimb/modernui/tree/master/core-ktx/src/test/java/icyllis/modernui/test"
    click ExtTests "https://github.com/blocamlimb/modernui/tree/master/x-awt/src/test/java/icyllis/modernui/test"
    click ExtTests "https://github.com/blocamlimb/modernui/tree/master/x-markdown/src/test/java/icyllis/modernui/test"

    %% Styles
    classDef app fill:#f9f,stroke:#333,stroke-width:1px
    classDef core fill:#bbdefb,stroke:#1e88e5,stroke-width:1px
    classDef ext fill:#c8e6c9,stroke:#43a047,stroke-width:1px
    classDef engine fill:#ffe0b2,stroke:#fb8c00,stroke-width:1px
    classDef native fill:#e0e0e0,stroke:#9e9e9e,stroke-width:1px
    classDef build fill:#e1bee7,stroke:#8e24aa,stroke-width:1px
    classDef docs fill:#fff9c4,stroke:#fbc02d,stroke-width:1px
    classDef tests fill:#d7ccc8,stroke:#6d4c41,stroke-width:1px
```
