# iooosef/webdisplays18 architecture

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

- Interactive diagram: https://gitdiagram.com/iooosef/webdisplays18
- Repository: https://github.com/iooosef/webdisplays18

## Overview

##### Project type and purpose
- This is a Minecraft “mod” (plugin) targeting Minecraft 1.18.2 (back-ported from 1.19), named WebDisplays.
- It injects new blocks, items, GUIs and an embedded micro-webserver (“miniserv”) into both the client and server sides of Minecraft, enabling in-game web pages to be viewed and interacted with on custom screen blocks.

##### File structure
- Top-level build files: Gradle wrapper, build.gradle, settings.gradle.
- src/main/java/net/montoyo/wd – core Java packages.
- init: block/item/tile registration classes
- block, item, entity: definitions of in-game content
- client: client-only entry point, GUI handlers, renderers, JS dispatcher
- net: packet definitions and custom network registry
- miniserv: embedded webserver client & server tasks
- controls, core, config, data, utilities: game logic, data models, helper classes
- src/main/resources – mod metadata (mods.toml, mixin.json), assets (models, textures, blockstates, GUI JSON), web assets (HTML/JS), data packs (recipes, advancements), sound files, language packs.

##### README for additional insights
- Confirms it’s a fork/backport of an existing WebDisplays mod.
- Lists planned features (Plugin API, Shop, CC interface) indicating a plugin-style architecture.
- Focuses on web-to-Minecraft integration via a mini web service and JS-to-Java callbacks.

##### Capturing essential architectural elements
– Don’t just list all packages; focus on how they collaborate at runtime.
– Show the flow of data: user input → JS → Java → server logic → back to screen.
– Include asset/resource loading path (mods.toml → JSON → game engine).
– Detail custom network channels and packet handlers as separate components.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Mod Loader
    ML["Mod Loader"]:::external

    %% Shared/Common
    WD["WebDisplays Entry Point"]:::shared
    SP["SharedProxy"]:::shared

    %% Client Side
    subgraph "Client Side"
        CP["ClientProxy"]:::client
        GUI["GUI Layer\n(WDScreen + Gui* + Controls)"]:::client
        REND["Renderer Layer\n(ScreenRenderer, ModelLoader)"]:::client
        JS["JSQueryDispatcher"]:::client
    end

    %% Server Side
    subgraph "Server Side"
        SRVPROXY["ServerProxy"]:::server
        MS["miniserv.server"]:::server
        CORE["Core Logic & Models"]:::server
        DATA["Data Storage Classes"]:::server
    end

    %% Networking
    subgraph "Networking Module"
        NETREG["WDNetworkRegistry"]:::shared
        PACKETS["C2S/S2C Packets"]:::shared
        HANDLER["PacketHandler"]:::shared
    end

    %% Assets & HTTP
    subgraph "Assets & External HTTP"
        WEB["Web Assets\n(HTML/JS)"]:::external
        JSONAS["JSON Assets\n(models, GUIs)"]:::external
    end

    %% Configuration
    subgraph "Configuration"
        CONF["ModConfig"]:::shared
        META["fabric.mod.json / mixins"]:::shared
    end

    %% Initialization Flow
    ML --> WD
    WD --> SP
    SP --> CP
    SP --> SRVPROXY

    %% Client Flow
    CP --> GUI
    CP --> REND
    GUI --> JS
    JS --> NETREG

    %% Networking Flow
    NETREG --> PACKETS
    PACKETS --> HANDLER
    HANDLER --> SRVPROXY

    %% Server Flow
    SRVPROXY --> MS
    SRVPROXY --> CORE
    CORE --> DATA

    %% Asset & HTTP interactions
    MS -->|HTTP| WEB
    GUI -->|renders| JSONAS

    %% Config interactions
    CONF --> WD
    META --> WD

    %% Click Events
    click WD "https://github.com/iooosef/webdisplays18/blob/master/src/main/java/net/montoyo/wd/WebDisplays.java"
    click SP "https://github.com/iooosef/webdisplays18/blob/master/src/main/java/net/montoyo/wd/SharedProxy.java"
    click CP "https://github.com/iooosef/webdisplays18/blob/master/src/main/java/net/montoyo/wd/client/ClientProxy.java"
    click JS "https://github.com/iooosef/webdisplays18/blob/master/src/main/java/net/montoyo/wd/client/JSQueryDispatcher.java"
    click GUI "https://github.com/iooosef/webdisplays18/blob/master/src/main/java/net/montoyo/wd/client/gui/WDScreen.java"
    click NETREG "https://github.com/iooosef/webdisplays18/blob/master/src/main/java/net/montoyo/wd/net/WDNetworkRegistry.java"
    click MS "https://github.com/iooosef/webdisplays18/blob/master/src/main/java/net/montoyo/wd/miniserv/server/Server.java"
    click CORE "https://github.com/iooosef/webdisplays18/blob/master/src/main/java/net/montoyo/wd/core/WDDCapability.java"
    click DATA "https://github.com/iooosef/webdisplays18/blob/master/src/main/java/net/montoyo/wd/data/ServerData.java"
    click CONF "https://github.com/iooosef/webdisplays18/blob/master/src/main/java/net/montoyo/wd/config/ModConfig.java"
    click META "https://github.com/iooosef/webdisplays18/blob/master/src/main/resources/fabric.mod.json"

    %% Styles
    classDef client fill:#ADD8E6,stroke:#000
    classDef server fill:#FFA500,stroke:#000
    classDef shared fill:#D3D3D3,stroke:#000
    classDef external fill:#90EE90,stroke:#000
```
