# gtnewhorizons/modularui2 architecture

> Architecture diagram of the GitHub repository gtnewhorizons/modularui2, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/gtnewhorizons/modularui2
- Repository: https://github.com/gtnewhorizons/modularui2

## Overview

ModularUI is a Minecraft GUI library. A mod or application opens a GUI through a factory; the resulting screen manages panels containing a tree of widgets, whose layout, rendering, and interactions provide the user-facing result. Optional branches cover client-server value synchronization, themes, overlays, inventory slots, recipe-viewer compatibility, and in-world holographic screens. The source excerpts show key orchestration and synchronization links; README statements support the broader widget workflow. Some subsystem internals were not sampled, so uncertain connections are omitted.

Main entry points: [`src/main/java/com/cleanroommc/modularui/screen/ModularScreen.java`](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/screen/ModularScreen.java) (Modular screen), [`src/main/java/com/cleanroommc/modularui/api/widget/IWidget.java`](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/api/widget/IWidget.java) (Widget tree), [`src/main/java/com/cleanroommc/modularui/factory/GuiManager.java`](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/factory/GuiManager.java) (GUI manager), [`src/main/java/com/cleanroommc/modularui/value/sync/ModularSyncManager.java`](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/value/sync/ModularSyncManager.java) (Value synchronization)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_lifecycle["GUI lifecycle"]
  node_factory["GUI factories<br/>[GuiFactories.java]"]
  node_manager["GUI manager<br/>[GuiManager.java]"]
  node_screen["Modular screen<br/>[ModularScreen.java]"]
  node_client["Client handler"]
end

subgraph group_ui["UI composition"]
  node_panels["Panel manager<br/>[PanelManager.java]"]
  node_panel["Panels<br/>[ModularPanel.java]"]
  node_widgets["Widget tree<br/>[IWidget.java]"]
  node_layout["Layout widgets<br/>[ILayoutWidget.java]"]
  node_context["GUI context"]
  node_drawables["Dynamic drawing<br/>[GuiDraw.java]"]
  node_slots["Inventory slots<br/>[ItemSlot.java]"]
end

subgraph group_services["UI services"]
  node_sync["Value synchronization"]
  node_panel_sync["Panel sync"]
  node_network["Packet transport"]
  node_themes["JSON themes<br/>[ThemeManager.java]"]
  node_config["GUI configuration<br/>[ConfigPanel.java]"]
  node_overlays["Overlays"]
end

subgraph group_integrations["Integrations"]
  node_holo["Holographic UI<br/>[HoloUI.java]"]
  node_nei["NEI compatibility"]
  node_recipe["Recipe viewer"]
end

node_app(("Mod application"))

node_app -.->|"defines GUI"| node_factory
node_factory -.->|"registers factory"| node_manager
node_manager -->|"creates screen"| node_screen
node_client -->|"draws screen"| node_screen
node_screen -->|"manages panels"| node_panels
node_panels -->|"opens panels"| node_panel
node_panel -->|"contains widget tree"| node_widgets
node_widgets -->|"uses layout"| node_layout
node_screen -->|"updates context"| node_context
node_context -->|"tracks interaction"| node_widgets
node_widgets -->|"renders dynamically"| node_drawables
node_widgets -.->|"includes slot widgets"| node_slots
node_manager -->|"creates sync manager"| node_sync
node_sync -->|"opens panel sync"| node_panel_sync
node_panel_sync -->|"sends sync packets"| node_network
node_network -->|"transports sync packets"| node_sync
node_screen -.->|"selects theme"| node_themes
node_themes -.->|"loads theme textures"| node_drawables
node_screen -.->|"offers configuration"| node_config
node_client -.->|"handles overlay input"| node_overlays
node_app -.->|"may open in-world UI"| node_holo
node_screen -.->|"integrates with NEI"| node_nei
node_screen -.->|"supports recipe transfer"| node_recipe

click node_factory "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/factory/GuiFactories.java"
click node_manager "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/factory/GuiManager.java"
click node_screen "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/screen/ModularScreen.java"
click node_client "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/screen/ClientScreenHandler.java"
click node_panels "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/screen/PanelManager.java"
click node_panel "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/screen/ModularPanel.java"
click node_widgets "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/api/widget/IWidget.java"
click node_layout "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/api/layout/ILayoutWidget.java"
click node_context "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/screen/viewport/ModularGuiContext.java"
click node_drawables "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/drawable/GuiDraw.java"
click node_slots "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/widgets/slot/ItemSlot.java"
click node_sync "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/value/sync/ModularSyncManager.java"
click node_panel_sync "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/value/sync/PanelSyncManager.java"
click node_network "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/network/NetworkHandler.java"
click node_themes "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/theme/ThemeManager.java"
click node_config "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/config/ConfigPanel.java"
click node_overlays "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/overlay/OverlayManager.java"
click node_holo "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/holoui/HoloUI.java"
click node_nei "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/integration/nei/ModularUINEIGuiHandler.java"
click node_recipe "https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/integration/recipeviewer/RecipeViewerRecipeTransferHandler.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_factory,node_manager,node_screen,node_client toneBlue
class node_panels,node_panel,node_widgets,node_layout,node_context,node_drawables,node_slots toneAmber
class node_sync,node_panel_sync,node_network,node_themes,node_config,node_overlays toneMint
class node_holo,node_nei,node_recipe toneRose
class node_app toneIndigo
```

## Components

### GUI lifecycle

- [GUI factories](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/factory/GuiFactories.java): `src/main/java/com/cleanroommc/modularui/factory/GuiFactories.java`
- [GUI manager](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/factory/GuiManager.java): `src/main/java/com/cleanroommc/modularui/factory/GuiManager.java`
- [Modular screen](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/screen/ModularScreen.java): `src/main/java/com/cleanroommc/modularui/screen/ModularScreen.java`
- [Client handler](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/screen/ClientScreenHandler.java): `src/main/java/com/cleanroommc/modularui/screen/ClientScreenHandler.java`

### UI composition

- [Panel manager](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/screen/PanelManager.java): `src/main/java/com/cleanroommc/modularui/screen/PanelManager.java`
- [Panels](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/screen/ModularPanel.java): `src/main/java/com/cleanroommc/modularui/screen/ModularPanel.java`
- [Widget tree](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/api/widget/IWidget.java): `src/main/java/com/cleanroommc/modularui/api/widget/IWidget.java`
- [Layout widgets](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/api/layout/ILayoutWidget.java): `src/main/java/com/cleanroommc/modularui/api/layout/ILayoutWidget.java`
- [GUI context](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/screen/viewport/ModularGuiContext.java): `src/main/java/com/cleanroommc/modularui/screen/viewport/ModularGuiContext.java`
- [Dynamic drawing](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/drawable/GuiDraw.java): `src/main/java/com/cleanroommc/modularui/drawable/GuiDraw.java`
- [Inventory slots](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/widgets/slot/ItemSlot.java): `src/main/java/com/cleanroommc/modularui/widgets/slot/ItemSlot.java`

### UI services

- [Value synchronization](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/value/sync/ModularSyncManager.java): `src/main/java/com/cleanroommc/modularui/value/sync/ModularSyncManager.java`
- [Panel sync](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/value/sync/PanelSyncManager.java): `src/main/java/com/cleanroommc/modularui/value/sync/PanelSyncManager.java`
- [Packet transport](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/network/NetworkHandler.java): `src/main/java/com/cleanroommc/modularui/network/NetworkHandler.java`
- [JSON themes](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/theme/ThemeManager.java): `src/main/java/com/cleanroommc/modularui/theme/ThemeManager.java`
- [GUI configuration](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/config/ConfigPanel.java): `src/main/java/com/cleanroommc/modularui/config/ConfigPanel.java`
- [Overlays](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/overlay/OverlayManager.java): `src/main/java/com/cleanroommc/modularui/overlay/OverlayManager.java`

### Integrations

- [Holographic UI](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/holoui/HoloUI.java): `src/main/java/com/cleanroommc/modularui/holoui/HoloUI.java`
- [NEI compatibility](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/integration/nei/ModularUINEIGuiHandler.java): `src/main/java/com/cleanroommc/modularui/integration/nei/ModularUINEIGuiHandler.java`
- [Recipe viewer](https://github.com/gtnewhorizons/modularui2/blob/master/src/main/java/com/cleanroommc/modularui/integration/recipeviewer/RecipeViewerRecipeTransferHandler.java): `src/main/java/com/cleanroommc/modularui/integration/recipeviewer/RecipeViewerRecipeTransferHandler.java`

### Other components

- **Mod application**

## Connections

- Mod application → GUI factories: defines GUI
- GUI factories → GUI manager: registers factory
- GUI manager → Modular screen: creates screen (evidence: `src/main/java/com/cleanroommc/modularui/factory/GuiManager.java`)
- Client handler → Modular screen: draws screen (evidence: `src/main/java/com/cleanroommc/modularui/screen/ClientScreenHandler.java`)
- Modular screen → Panel manager: manages panels (evidence: `src/main/java/com/cleanroommc/modularui/screen/PanelManager.java`)
- Panel manager → Panels: opens panels (evidence: `src/main/java/com/cleanroommc/modularui/screen/PanelManager.java`)
- Panels → Widget tree: contains widget tree (evidence: `README.md`)
- Widget tree → Layout widgets: uses layout (evidence: `README.md`)
- Modular screen → GUI context: updates context (evidence: `src/main/java/com/cleanroommc/modularui/screen/ModularScreen.java`)
- GUI context → Widget tree: tracks interaction (evidence: `src/main/java/com/cleanroommc/modularui/screen/viewport/ModularGuiContext.java`)
- Widget tree → Dynamic drawing: renders dynamically (evidence: `README.md`)
- Widget tree → Inventory slots: includes slot widgets
- GUI manager → Value synchronization: creates sync manager (evidence: `src/main/java/com/cleanroommc/modularui/factory/GuiManager.java`)
- Value synchronization → Panel sync: opens panel sync (evidence: `src/main/java/com/cleanroommc/modularui/value/sync/ModularSyncManager.java`)
- Panel sync → Packet transport: sends sync packets (evidence: `src/main/java/com/cleanroommc/modularui/value/sync/PanelSyncManager.java`)
- Packet transport → Value synchronization: transports sync packets (evidence: `src/main/java/com/cleanroommc/modularui/network/NetworkHandler.java`)
- Modular screen → JSON themes: selects theme
- JSON themes → Dynamic drawing: loads theme textures
- Modular screen → GUI configuration: offers configuration
- Client handler → Overlays: handles overlay input
- Mod application → Holographic UI: may open in-world UI
- Modular screen → NEI compatibility: integrates with NEI
- Modular screen → Recipe viewer: supports recipe transfer
