How itscola/promodule works
Project Type and Purpose
• This is a single‑repository Minecraft Forge “ghost client” mod called ProModule‑Client. It plugs into the Minecraft client via Forge and Mixin, injecting code at runtime to provide cheats, GUI enhancements, custom rendering, event‑driven modules, authentication, and integration with external services (Hypixel, Mojang, GitHub, etc.).
File‑Structure Analysis
• build.gradle, gradle wrapper, GitHub workflows: standard Java/Forge build & CI.
• src/main/java/me/ratsiel/*: standalone authentication and JSON sub‑libraries (abstract authenticator, models for Microsoft and Mojang, JSON parser/generator).
• src/main/java/top/whitecola/animationlib/*: independent animation engine (core Animation, functions, utilities).
• src/main/java/top/whitecola/promodule: the core mod, subdivided into:
• annotations & config (ModuleSetting, HiConfig, various config structs)
• event system (EventManager, adapters, event implementations)
• fonts & GUI (font loaders, GUI components, screens, notifications, widgets)
• injection layer (MixinLoader, mixin definitions targeting Minecraft classes)
• keybind definitions
• modules (IModule, AbstractModule, concrete cheat modules grouped by combat, movement, render, world, other)
• services (API wrappers for external REST endpoints, feature toggles like anti‑cheat, update checks, plus login flows)
• utilities (wide array of helper classes: rendering, math, networking, file I/O, threading)
• src/main/resources: Forge mod metadata, mixin JSON, assets (shaders, fonts, textures).
README Insights
• Confirms it’s a Forge‑based client mod with a click GUI, background artwork, and screenshots of in‑game UI.
a. Main Components
1. Host Platform: Minecraft Client (Forge Loader + Mixin Engine)
2. Mod Core: ProModule entrypoint & MixinLoader
3. Subsystems:
• Module Manager & Modules (combat, movement, render, world, other)
• Event System (EventManager, event dispatch & listeners)
• GUI Layer (font engine, screens, widgets, notifications)
• Configuration & Persistence (HiConfig, data structs)
• Services & API Wrappers (Hypixel, Mojang, GitHub, custom REST)
• Authentication Subsystem (me.ratsiel.auth package)
• Animation Library (independent engine used by GUI/modules)
• Utilities (shared helper classes)
4. External Services: Hypixel API, Mojang API, Microsoft OAuth.
5. Resources: shaders, fonts, textures.
b. Relationships & Interactions
• Forge Loader injects the mod JAR; MixinLoader applies bytecode patches to Minecraft classes.
• ProModule entrypoint initializes Config → registers EventManager → registers Modules.
• Minecraft game loop & network code raise events → EventManager dispatches to Modules & GUI.
• Modules invoke Utils, Services, and AnimationLib as needed.
• GUI Layer listens to render and input events → draws custom HUD, click GUI.
• Config subsystem serializes module settings to disk.
• Authentication subsystem calls Microsoft/Mojang endpoints via JSON lib.
• Services layer performs HTTP calls to external APIs, returns data models (e.g., HypixelPlayer).
• Utility classes assist with rendering (GLUtils), math, packets (PacketUtils), threading, etc.
c. Architectural Patterns / Principles
• Plugin pattern: modules implementing IModule loaded at runtime by ModuleManager.
• Event‑driven architecture: central EventManager decoupling producers (Minecraft, Services) and consumers (Modules, GUI).
• Mixin-based injection: modifies host classes without forking code.
• Layered design: core mod, modules, GUI, services, utils all clearly separated.
• Configuration as first‑class: annotation‑driven settings, persistent structs.
d. Key Technologies / Frameworks
• Java 8+, Gradle build
• Minecraft Forge mod loader
• SpongePowered Mixin framework
• Custom JSON parser/generator
• HTTP client (part of services layer)
• In‑game GUI using Minecraft rendering engine, OpenGL shaders
Essential Elements Checklist
• Minecraft → MixinLoader → Mod Core initialization
• Mod Core → EventManager → Modules/GUI
• Modules/GUI → Services (HTTP)
• Authentication → external OAuth endpoints