# cigaretteclient/cigarette architecture

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

- Interactive diagram: https://gitdiagram.com/cigaretteclient/cigarette
- Repository: https://github.com/cigaretteclient/cigarette

## Overview

##### Project type and purpose
- This is a Java-based Minecraft client “mod” (using Fabric), named Cigarette Client.
- Its purpose is to inject custom behaviors—game-play enhancements, HUD overlays, automated agents—into the vanilla Minecraft client at runtime.

##### File structure
- Top‐level build files (build.gradle, gradlew, settings.gradle) → Gradle build and release pipeline, GitHub Actions workflows.
- src/main/java/dev/cigarette: main code, organized into sub-packages:
- agent (auto-detectors for game modes)
- config (persistent settings, file system abstraction)
- events (central event bus)
- gui (widgets, HUD modules, screens, render utilities)
- lib (utility wrappers around Minecraft internals)
- mixin (Fabric Mixin definitions for injecting into Minecraft classes)
- module (hacks/plugins sorted by category: bedwars, combat, UI, etc.)
- precomputed (preprocessed data for fast lookup)
- src/main/resources:
- fabric.mod.json + cigarette.mixins.json → Fabric loader metadata
- assets/cigarette/lang/… → internationalization resources
- assets/cigarette/font → custom fonts

##### README for additional insights
- Minimal README—logo, title, tagline “Next-gen Hypixel Fuckery.”
- Confirms it’s a client mod for the Hypixel server, no further architecture details.

a. Main components
1. Fabric Loader & Mixin Engine
2. Minecraft Client (vanilla game code)
3. Cigarette Mod Core
- Injector Layer (mixins)
- Event Bus (Event dispatcher, listener registration)
- Config Manager (Config, FileSystem)
- Module Registry (BaseModule, ModuleList)
- Agents (GameDetector → selects bedwars/murder/zombies agents)
- GUI / HUD System (CigaretteScreen, HUD modules, widgets)
- Utility Library (ChatLogger, Renderer, Raycast, etc.)
- Precomputed Data (BlockIn, PyramidQuadrant)
4. External Services (Hypixel server via Minecraft’s networking)
5. Build & Release Pipeline (Gradle, GitHub Actions)

b. Relationships and interactions
- Fabric Loader loads Minecraft Client + Cigarette mod jars.
- Mixin Engine applies mixins to Minecraft classes at startup (e.g., EntityMixin, Renderer, Input Mixin).
- Mixin-injected hooks fire custom events into the Cigarette Event Bus.
- Event Bus broadcasts events (render tick, client tick, network packet received) to registered modules and agents.
- Modules subscribe to events, use Utility Library + precomputed data to implement features.
- GUI system hooks into Render events, draws HUD overlays and screens using Renderer and custom fonts.
- Config Manager reads/writes JSON or similar to persist user settings.
- Agents detect game mode from the world state and register mode-specific modules/providers.
- Communication with the Hypixel server happens through unmodified Minecraft networking stack.

c. Architectural patterns and principles
- Modular plugin architecture: each feature is a Module implementing BaseModule.
- Event-driven design: core loop generates events, modules react.
- Dependency Injection via mixins: decouples mod code from Minecraft internals.
- Registry pattern: modules, bar widget providers, keybinds registered centrally.
- Separation of concerns: agents (mode detection) vs. modules (feature implementations) vs. GUI vs. config.

d. Key technologies and frameworks
- Java 17 (or 8, per Fabric version)
- Fabric Loader + Mixin framework
- Gradle build system
- GitHub Actions (build-and-release.yml, build-test.yml)
- JSON/YAML for config and resource definitions

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Build & CI Layer
    subgraph "Build & Release Pipeline"
        direction TB
        BuildGradle["build.gradle"]:::build
        SettingsGradle["settings.gradle"]:::build
        Workflow1[".github/workflows/build-and-release.yml"]:::build
        Workflow2[".github/workflows/build-test.yml"]:::build
    end

    %% Runtime Injection Layer
    subgraph "Loader & Injection" 
        direction TB
        Loader["Fabric Loader"]:::injection
        MixinEngine["Mixin Engine"]:::injection
    end

    %% Minecraft Core
    Minecraft["Minecraft Client (vanilla)"]:::external

    %% Mod Core
    subgraph "Cigarette Mod Core"
        direction TB
        Entry["Cigarette.java\n(Core Entry Point)"]:::core

        subgraph "Injector Layer (Mixins)"
            direction TB
            MixinsDir["Mixin Definitions"]:::injection
        end

        subgraph "Event System"
            direction TB
            EventClass["Event.java"]:::event
            EventsClass["Events.java"]:::event
        end

        subgraph "Config Manager"
            direction TB
            Config["Config.java"]:::config
            FileSystem["FileSystem.java"]:::config
        end

        subgraph "Module Registry"
            direction TB
            BaseModule["BaseModule.java"]:::module
            RenderModule["RenderModule.java"]:::module
            TickModule["TickModule.java"]:::module
        end

        subgraph "Agents (Game Mode Detection)"
            direction TB
            GameDetector["GameDetector.java"]:::agent
            BaseAgent["BaseAgent.java"]:::agent
            BedwarsAgent["BedwarsAgent.java"]:::agent
            MurderAgent["MurderMysteryAgent.java"]:::agent
            ZombiesAgent["ZombiesAgent.java"]:::agent
        end

        subgraph "GUI / HUD System"
            direction TB
            CigScreen["CigaretteScreen.java"]:::gui
            RenderUtil["RenderUtil.java"]:::gui
            HUDWidgetDir["hud widgets"]:::gui
            WidgetDir["gui widget"]:::gui
        end

        subgraph "Utility Library"
            direction TB
            ChatLogger["ChatLogger.java"]:::lib
            RendererLib["Renderer.java"]:::lib
            Raycast["Raycast.java"]:::lib
        end

        subgraph "Precomputed Data"
            direction TB
            BlockIn["BlockIn.java"]:::data
            PyramidQuad["PyramidQuadrant.java"]:::data
        end

        Resources["Resources\n(lang, fonts, json)"]:::resources
    end

    %% External Systems
    Hypixel["Hypixel Server"]:::external

    %% Connections
    BuildGradle -->|builds jars| Loader
    SettingsGradle --> Loader
    Workflow1 --> Loader
    Workflow2 --> Loader

    Loader -->|loads mod jars| Minecraft
    MixinEngine -->|inject mixins into| Minecraft
    Minecraft -->|mixin hooks| EventClass
    EventClass --> EventsClass
    EventsClass -->|dispatch events| BaseModule
    EventsClass -->|dispatch events| RenderModule
    EventsClass -->|dispatch events| TickModule
    EventsClass -->|dispatch events| CigScreen

    Entry --> MixinsDir
    MixinsDir --> EventClass

    Entry --> Config
    Config --> FileSystem

    Entry --> BaseModule
    BaseModule --> BaseAgent

    Entry --> GameDetector
    GameDetector --> BedwarsAgent
    GameDetector --> MurderAgent
    GameDetector --> ZombiesAgent

    Entry --> ChatLogger
    Entry --> RendererLib
    Entry --> Raycast

    CigScreen --> RenderUtil
    CigScreen --> HUDWidgetDir
    CigScreen --> WidgetDir
    RenderUtil --> Resources

    Entry --> BlockIn
    Entry --> PyramidQuad

    Minecraft -->|network packets| Hypixel
    Hypixel -->|packets| Minecraft

    %% Click Events
    click MixinsDir "https://github.com/cigaretteclient/cigarette/tree/main/src/main/java/dev/cigarette/mixin"
    click EventClass "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/events/Event.java"
    click EventsClass "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/events/Events.java"
    click Config "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/config/Config.java"
    click FileSystem "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/config/FileSystem.java"
    click BaseModule "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/module/BaseModule.java"
    click RenderModule "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/module/RenderModule.java"
    click TickModule "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/module/TickModule.java"
    click GameDetector "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/GameDetector.java"
    click BaseAgent "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/agent/BaseAgent.java"
    click BedwarsAgent "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/agent/BedwarsAgent.java"
    click MurderAgent "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/agent/MurderMysteryAgent.java"
    click ZombiesAgent "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/agent/ZombiesAgent.java"
    click CigScreen "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/gui/CigaretteScreen.java"
    click RenderUtil "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/gui/RenderUtil.java"
    click HUDWidgetDir "https://github.com/cigaretteclient/cigarette/tree/main/src/main/java/dev/cigarette/gui/hud"
    click WidgetDir "https://github.com/cigaretteclient/cigarette/tree/main/src/main/java/dev/cigarette/gui/widget"
    click ChatLogger "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/lib/ChatLogger.java"
    click RendererLib "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/lib/Renderer.java"
    click Raycast "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/lib/Raycast.java"
    click BlockIn "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/precomputed/BlockIn.java"
    click PyramidQuad "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/precomputed/PyramidQuadrant.java"
    click Entry "https://github.com/cigaretteclient/cigarette/blob/main/src/main/java/dev/cigarette/Cigarette.java"
    click Resources "https://github.com/cigaretteclient/cigarette/tree/main/src/main/resources"
    click BuildGradle "https://github.com/cigaretteclient/cigarette/blob/main/build.gradle"
    click SettingsGradle "https://github.com/cigaretteclient/cigarette/blob/main/settings.gradle"
    click Workflow1 "https://github.com/cigaretteclient/cigarette/blob/main/.github/workflows/build-and-release.yml"
    click Workflow2 "https://github.com/cigaretteclient/cigarette/blob/main/.github/workflows/build-test.yml"

    %% Styles
    classDef build fill:#dddddd,stroke:#888888
    classDef injection fill:#bbdefb,stroke:#1e88e5
    classDef core fill:#c5cae9,stroke:#3f51b5
    classDef event fill:#e1bee7,stroke:#8e24aa
    classDef config fill:#b2ebf2,stroke:#00796b
    classDef module fill:#c8e6c9,stroke:#388e3c
    classDef agent fill:#dcedc8,stroke:#689f38
    classDef gui fill:#ffe0b2,stroke:#ef6c00
    classDef lib fill:#fff9c4,stroke:#fbc02d
    classDef data fill:#f8bbd0,stroke:#d81b60
    classDef resources fill:#efebe9,stroke:#6d4c41
    classDef external fill:#e0e0e0,stroke:#424242,stroke-dasharray: 5 5
```
