Skip to content

MCDxAI/meteor-client-webgui

Repository files navigation

Meteor WebGUI

icon

Real-time, bi-directional web interface for every Meteor Client module and setting.

Full control of Meteor Client from within the browser

Feature Highlights

Capability Details
Bi-directional sync NanoHTTPD-powered WebSocket channel mirrors module toggles & setting edits in real time.
Automatic catalog Dynamically maps every Meteor Client module (plus installed addons) into category groups & favorites.
Type-aware settings UI components adapt to 30+ setting types including Bool, Int, Double, String, Enum, Color, Keybind, Font, Potion, List types (blocks, items, entities), and Map types with full validation and type-specific controls.
Registry streaming Server streams block/item/entity registry pages on demand so advanced list editors have the data they need, without bogging down Meteor or the WebGUI
Fully Bundled Gradle builds the Vue 3 + TypeScript front-end, where it's served from within the addon
Real-time HUD display Live text previews of active HUD elements with automatic updates, state synchronization, and full settings control from the browser.

Quick Start

Step Instructions
1. Requirements • Java 21+
• Node.js 18+ (only for web UI development)
• Minecraft 1.21.10 with Fabric Loader 0.17.3+
• Meteor Client 1.21.10-32
2. Download the addon Download the latest .jar release from the GitHub Releases page.
3. Install into Minecraft 1. Copy the downloaded .jar file to .minecraft/mods/.
2. Ensure the required Meteor Client version is installed.
3. Launch Minecraft with your Fabric profile.
4. Start the WebGUI server 1. Press Right Shift to open the Meteor GUI.
2. Open the WebGUI tab.
3. Configure Host (default 127.0.0.1) and Port (default 8080) plus Auto Start if desired.
4. Click Start Server.

Log output:
[Meteor WebGUI] Starting WebGUI server on 127.0.0.1:8080
[Meteor WebGUI] Event monitoring started for N modules
[Meteor WebGUI] Access the WebGUI at: http://127.0.0.1:8080
5. Open the interface Production – Visit http://127.0.0.1:8080 (or your configured host/port). Static assets and the /ws WebSocket endpoint are served by the addon itself.

Development – For hot reloading, run:
cd webui
npm install
npm run dev

Visit http://localhost:3000. Vite proxies /ws to localhost:8080, so the development UI still talks to the in-game server.

Development Workflow

Component Commands / Actions
Java / Fabric side ./gradlew build – Builds the addon and packages the latest WebUI.
./gradlew runClient – Launches a Fabric development client with the addon loaded.
./gradlew test – Runs the JUnit test suite.
./gradlew clean – Removes generated class files and packaged WebUI artifacts.
WebGUI (Vue 3 + Vite) npm install – Install dependencies in webui/.
npm run dev – Hot-reload development server on port 3000 (with /ws proxying).
npm run build – Generates the static bundle consumed by Gradle.
npm run preview – Serve the production bundle locally for smoke tests.