# winterhavenmc/messagebuilderlib architecture

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

- Interactive diagram: https://gitdiagram.com/winterhavenmc/messagebuilderlib
- Repository: https://github.com/winterhavenmc/messagebuilderlib

## Overview

##### Main Components

a) Core Components:
- MessageBuilder (Central Component)
- LanguageHandler System
- Macro Processing System
- YAML Configuration System

b) Data Components:
- Message Records
- Item Records
- Language Files

**┌─ Client Layer ─────────────────────┐**
- Plugin Implementation              │
- (MessageId & Macro Enums)          │
- ┬───────────────────┘
- ↓
**┌─ API Layer ──────────────────────┐**
- MessageBuilder<T,E>              │
- ┬──────────────────┘
- ↓
**┌─ Core Processing Layer ──────────────────────────────┐**
- ┌─────────────┐ ┌──────────────┐ ┌────────────────┐ │
- LanguageHandler│ │MacroProcessor│ │YamlFileHandler │ │
- ┘ └──────────────┘ └────────────────┘ │
- ┬──────────────────────────────┘
- ↓
**┌─ Processing Components Layer ────────────────────────┐**
- ┌─────────────────────────┐ ┌───────────────────┐   │
- Processor Registry       │ │MacroObjectMap     │   │
- ┘ └───────────────────┘   │
- ┌─────────────────────────────────────────────────┐ │
- Individual Processors (Command, Entity, etc.)     │ │
- ┘ │
- ┬──────────────────────────────┘
- ↓
**┌─ Storage Layer ────────────────────────────────────┐**
- ┌─────────────┐ ┌──────────────┐ ┌──────────────┐ │
- Language Files│ │Message Cache │ │Config Files  │ │
- ┘ └──────────────┘ └──────────────┘ │
- ┘

##### Important Relationships

a) Data Flow:
- Plugin → MessageBuilder → MacroProcessor → Final Output
- Language Files → LanguageHandler → MessageBuilder
- Configuration → YamlFileHandler → System Components

b) Dependencies:
- How Processors register with ProcessorRegistry
- How MacroObjectMap interfaces with Processors
- Language file loading flow

##### Implementation Details to Highlight

- Processor hierarchy with AbstractProcessor
- YAML file structure for messages and items
- Cooldown mechanism
- How macro processing interfaces with different object types

##### Notes

- Keep the main flow clear and centered
- Related processors together
- Test coverage relationship
- Extension points for custom processors

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Client
        Plugin[Plugin Implementation]
        MessageId[Message ID Enum]:::enum
        MacroEnum[Macro Enum]:::enum
    end

    subgraph API
        MessageBuilder[MessageBuilder<T,E>]:::core
        Message[Message Class]:::core
    end

    subgraph Core
        LangHandler[LanguageHandler]:::core
        MacroHandler[MacroProcessorHandler]:::processor
        YamlHandler[YAML Configuration System]:::core
    end

    subgraph Processing
        ProcRegistry[Processor Registry]:::processor
        MacroMap[MacroObjectMap]:::processor
        
        subgraph Processors
            AbstractProc[Abstract Processor]:::processor
            CommandProc[Command Processor]:::processor
            EntityProc[Entity Processor]:::processor
            ItemProc[Item Processor]:::processor
            LocationProc[Location Processor]:::processor
            NumberProc[Number Processor]:::processor
            WorldProc[World Processor]:::processor
        end
    end

    subgraph Storage
        LangFiles[Language Files]:::storage
        MsgCache[Message Cache]:::storage
        ConfigFiles[Config Files]:::storage
    end

    %% Relationships
    Plugin --> MessageBuilder
    MessageId --> MessageBuilder
    MacroEnum --> MessageBuilder
    MessageBuilder --> Message
    MessageBuilder --> MacroHandler
    MessageBuilder --> LangHandler
    LangHandler --> YamlHandler
    MacroHandler --> ProcRegistry
    MacroHandler --> MacroMap
    ProcRegistry --> AbstractProc
    AbstractProc --> CommandProc & EntityProc & ItemProc & LocationProc & NumberProc & WorldProc
    YamlHandler --> LangFiles
    YamlHandler --> ConfigFiles
    MacroHandler --> MsgCache

    %% Click Events
    click MessageBuilder "https://github.com/winterhavenmc/MessageBuilderLib/blob/main/src/main/java/com/winterhavenmc/util/messagebuilder/MessageBuilder.java"
    click LangHandler "https://github.com/winterhavenmc/MessageBuilderLib/blob/main/src/main/java/com/winterhavenmc/util/messagebuilder/LanguageHandler.java"
    click YamlHandler "https://github.com/winterhavenmc/MessageBuilderLib/blob/main/src/main/java/com/winterhavenmc/util/messagebuilder/YamlFileLoader.java"
    click MacroHandler "https://github.com/winterhavenmc/MessageBuilderLib/blob/main/src/main/java/com/winterhavenmc/util/messagebuilder/macro/MacroProcessorHandler.java"
    click MacroMap "https://github.com/winterhavenmc/MessageBuilderLib/blob/main/src/main/java/com/winterhavenmc/util/messagebuilder/macro/MacroObjectMap.java"
    click ProcRegistry "https://github.com/winterhavenmc/MessageBuilderLib/blob/main/src/main/java/com/winterhavenmc/util/messagebuilder/macro/processor/ProcessorRegistry.java"
    click AbstractProc "https://github.com/winterhavenmc/MessageBuilderLib/blob/main/src/main/java/com/winterhavenmc/util/messagebuilder/macro/processor/AbstractProcessor.java"
    click CommandProc "https://github.com/winterhavenmc/MessageBuilderLib/blob/main/src/main/java/com/winterhavenmc/util/messagebuilder/macro/processor/CommandSenderProcessor.java"
    click EntityProc "https://github.com/winterhavenmc/MessageBuilderLib/blob/main/src/main/java/com/winterhavenmc/util/messagebuilder/macro/processor/EntityProcessor.java"
    click ItemProc "https://github.com/winterhavenmc/MessageBuilderLib/blob/main/src/main/java/com/winterhavenmc/util/messagebuilder/macro/processor/ItemStackProcessor.java"
    click LocationProc "https://github.com/winterhavenmc/MessageBuilderLib/blob/main/src/main/java/com/winterhavenmc/util/messagebuilder/macro/processor/LocationProcessor.java"
    click NumberProc "https://github.com/winterhavenmc/MessageBuilderLib/blob/main/src/main/java/com/winterhavenmc/util/messagebuilder/macro/processor/NumberProcessor.java"
    click WorldProc "https://github.com/winterhavenmc/MessageBuilderLib/blob/main/src/main/java/com/winterhavenmc/util/messagebuilder/macro/processor/WorldProcessor.java"
    click LangFiles "https://github.com/winterhavenmc/MessageBuilderLib/tree/main/src/test/resources/language/"
    click MsgCache "https://github.com/winterhavenmc/MessageBuilderLib/blob/main/src/main/java/com/winterhavenmc/util/messagebuilder/MessageCooldown.java"
    click ConfigFiles "https://github.com/winterhavenmc/MessageBuilderLib/blob/main/src/test/resources/config.yml"
    click Message "https://github.com/winterhavenmc/MessageBuilderLib/blob/main/src/main/java/com/winterhavenmc/util/messagebuilder/Message.java"
    click MessageId "https://github.com/winterhavenmc/MessageBuilderLib/blob/main/src/test/java/com/winterhavenmc/util/messagebuilder/messages/MessageId.java"
    click MacroEnum "https://github.com/winterhavenmc/MessageBuilderLib/blob/main/src/test/java/com/winterhavenmc/util/messagebuilder/messages/Macro.java"

    %% Styling
    classDef core fill:#a8d1f0,stroke:#333,stroke-width:2px
    classDef processor fill:#90EE90,stroke:#333,stroke-width:2px
    classDef storage fill:#FFE5B4,stroke:#333,stroke-width:2px
    classDef enum fill:#D8BFD8,stroke:#333,stroke-width:2px

    %% Legend
    subgraph Legend
        CoreComp[Core Component]:::core
        ProcComp[Processing Component]:::processor
        StorageComp[Storage Component]:::storage
        EnumComp[Enum Component]:::enum
    end
```
