How iooosef/webdisplays18 works
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.