# furqit/holodisplays architecture

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

- Interactive diagram: https://gitdiagram.com/furqit/holodisplays
- Repository: https://github.com/furqit/holodisplays

## Overview

HoloDisplays is a Fabric Minecraft mod for virtual, packet-based holograms. Server startup loads configuration and registers commands and lifecycle hooks; commands and GUIs provide management paths, while the public API offers a developer path. Hologram and display definitions are configured or API-supplied, then viewer visibility decisions lead to display packets sent to players. The README also documents animations, formatting, and placeholder compatibility. Several command, GUI, animation, and API implementation details are unsampled, so their internal links are omitted where source evidence is unavailable.

Main entry points: [`src/main/kotlin/dev/furq/holodisplays/HoloDisplays.kt`](https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/HoloDisplays.kt) (Mod initializer), [`src/main/kotlin/dev/furq/holodisplays/handlers/ViewerHandler.kt`](https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/handlers/ViewerHandler.kt) (Viewer tracking), [`src/main/kotlin/dev/furq/holodisplays/handlers/PacketHandler.kt`](https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/handlers/PacketHandler.kt) (Packet rendering), [`src/main/kotlin/dev/furq/holodisplays/handlers/TickHandler.kt`](https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/handlers/TickHandler.kt) (Tick and animation)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Entry and management"]
  node_initializer["Mod initializer<br/>[HoloDisplays.kt]"]
  node_commands["Command system"]
  node_gui["Display manager GUI"]
end

subgraph group_definitions["Definitions and settings"]
  node_configmanager["Config manager<br/>[ConfigManager.kt]"]
  node_holo_config[("Hologram config<br/>[HologramConfig.kt]")]
  node_display_config[("Display config<br/>[DisplayConfig.kt]")]
  node_language[("Language config<br/>[Lang.kt]")]
  node_holo_data["Hologram definitions<br/>[HologramData.kt]"]
  node_display_data["Display definitions<br/>[DisplayData.kt]"]
  node_display_types["Display types"]
end

subgraph group_runtime["Visibility and packets"]
  node_holo_handler["Hologram handler<br/>[HologramHandler.kt]"]
  node_viewer["Viewer tracking<br/>[ViewerHandler.kt]"]
  node_conditions["Visibility conditions"]
  node_ticks["Tick and animation<br/>[TickHandler.kt]"]
  node_packets["Packet rendering<br/>[PacketHandler.kt]"]
end

subgraph group_developer["Developer API"]
  node_api["Public API"]
  node_api_impl["API implementation"]
  node_api_internal["API registry"]
end

node_server(("Minecraft server"))
node_admin(("Server administrator"))
node_player(("Online player"))
node_placeholder(("Placeholder API"))

node_server -->|"loads mod"| node_initializer
node_initializer -->|"initializes"| node_configmanager
node_initializer -->|"initializes"| node_holo_handler
node_initializer -->|"initializes"| node_ticks
node_initializer -->|"registers"| node_commands
node_initializer -->|"ticks"| node_ticks
node_initializer -->|"updates visibility"| node_viewer
node_admin -.->|"issues commands"| node_commands
node_admin -.->|"manages displays"| node_gui
node_configmanager -->|"initializes config"| node_holo_config
node_player -->|"visibility checked"| node_viewer
node_viewer -->|"loads hologram"| node_holo_config
node_viewer -->|"loads displays"| node_display_config
node_viewer -->|"evaluates"| node_conditions
node_viewer -->|"checks range"| node_holo_handler
node_viewer -->|"sends display packets"| node_packets
node_packets -->|"processes text with"| node_ticks
node_packets -->|"checks API display"| node_api_internal
node_packets -->|"builds metadata from"| node_display_types
node_player -.->|"supplies placeholders"| node_placeholder
node_api -.->|"implemented by"| node_api_impl
node_api_impl -.->|"registers API data"| node_api_internal

click node_initializer "https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/HoloDisplays.kt"
click node_commands "https://github.com/furqit/holodisplays/tree/main/src/main/kotlin/dev/furq/holodisplays/commands"
click node_gui "https://github.com/furqit/holodisplays/tree/main/src/main/kotlin/dev/furq/holodisplays/gui"
click node_configmanager "https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/config/ConfigManager.kt"
click node_holo_config "https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/config/HologramConfig.kt"
click node_display_config "https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/config/DisplayConfig.kt"
click node_language "https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/config/Lang.kt"
click node_holo_data "https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/data/HologramData.kt"
click node_display_data "https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/data/DisplayData.kt"
click node_display_types "https://github.com/furqit/holodisplays/tree/main/src/main/kotlin/dev/furq/holodisplays/data/display"
click node_holo_handler "https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/handlers/HologramHandler.kt"
click node_viewer "https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/handlers/ViewerHandler.kt"
click node_conditions "https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/utils/ConditionEvaluator.kt"
click node_ticks "https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/handlers/TickHandler.kt"
click node_packets "https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/handlers/PacketHandler.kt"
click node_api "https://github.com/furqit/holodisplays/blob/main/src/main/java/dev/furq/holodisplays/api/HoloDisplaysAPI.java"
click node_api_impl "https://github.com/furqit/holodisplays/blob/main/src/main/java/dev/furq/holodisplays/api/HoloDisplaysAPIImpl.java"
click node_api_internal "https://github.com/furqit/holodisplays/blob/main/src/main/java/dev/furq/holodisplays/api/HoloDisplaysAPIInternal.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_initializer,node_commands,node_gui toneBlue
class node_configmanager,node_holo_config,node_display_config,node_language,node_holo_data,node_display_data,node_display_types toneAmber
class node_holo_handler,node_viewer,node_conditions,node_ticks,node_packets,node_server,node_admin,node_placeholder toneMint
class node_api,node_api_impl,node_api_internal toneRose
class node_player toneIndigo
```

## Components

### Entry and management

- [Mod initializer](https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/HoloDisplays.kt): `src/main/kotlin/dev/furq/holodisplays/HoloDisplays.kt`
- [Command system](https://github.com/furqit/holodisplays/tree/main/src/main/kotlin/dev/furq/holodisplays/commands): `src/main/kotlin/dev/furq/holodisplays/commands`
- [Display manager GUI](https://github.com/furqit/holodisplays/tree/main/src/main/kotlin/dev/furq/holodisplays/gui): `src/main/kotlin/dev/furq/holodisplays/gui`

### Definitions and settings

- [Config manager](https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/config/ConfigManager.kt): `src/main/kotlin/dev/furq/holodisplays/config/ConfigManager.kt`
- [Hologram config](https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/config/HologramConfig.kt): `src/main/kotlin/dev/furq/holodisplays/config/HologramConfig.kt`
- [Display config](https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/config/DisplayConfig.kt): `src/main/kotlin/dev/furq/holodisplays/config/DisplayConfig.kt`
- [Language config](https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/config/Lang.kt): `src/main/kotlin/dev/furq/holodisplays/config/Lang.kt`
- [Hologram definitions](https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/data/HologramData.kt): `src/main/kotlin/dev/furq/holodisplays/data/HologramData.kt`
- [Display definitions](https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/data/DisplayData.kt): `src/main/kotlin/dev/furq/holodisplays/data/DisplayData.kt`
- [Display types](https://github.com/furqit/holodisplays/tree/main/src/main/kotlin/dev/furq/holodisplays/data/display): `src/main/kotlin/dev/furq/holodisplays/data/display`

### Visibility and packets

- [Hologram handler](https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/handlers/HologramHandler.kt): `src/main/kotlin/dev/furq/holodisplays/handlers/HologramHandler.kt`
- [Viewer tracking](https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/handlers/ViewerHandler.kt): `src/main/kotlin/dev/furq/holodisplays/handlers/ViewerHandler.kt`
- [Visibility conditions](https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/utils/ConditionEvaluator.kt): `src/main/kotlin/dev/furq/holodisplays/utils/ConditionEvaluator.kt`
- [Tick and animation](https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/handlers/TickHandler.kt): `src/main/kotlin/dev/furq/holodisplays/handlers/TickHandler.kt`
- [Packet rendering](https://github.com/furqit/holodisplays/blob/main/src/main/kotlin/dev/furq/holodisplays/handlers/PacketHandler.kt): `src/main/kotlin/dev/furq/holodisplays/handlers/PacketHandler.kt`

### Developer API

- [Public API](https://github.com/furqit/holodisplays/blob/main/src/main/java/dev/furq/holodisplays/api/HoloDisplaysAPI.java): `src/main/java/dev/furq/holodisplays/api/HoloDisplaysAPI.java`
- [API implementation](https://github.com/furqit/holodisplays/blob/main/src/main/java/dev/furq/holodisplays/api/HoloDisplaysAPIImpl.java): `src/main/java/dev/furq/holodisplays/api/HoloDisplaysAPIImpl.java`
- [API registry](https://github.com/furqit/holodisplays/blob/main/src/main/java/dev/furq/holodisplays/api/HoloDisplaysAPIInternal.java): `src/main/java/dev/furq/holodisplays/api/HoloDisplaysAPIInternal.java`

### Other components

- **Minecraft server**
- **Server administrator**
- **Online player**
- **Placeholder API**

## Connections

- Minecraft server → Mod initializer: loads mod (evidence: `src/main/kotlin/dev/furq/holodisplays/HoloDisplays.kt`)
- Mod initializer → Config manager: initializes (evidence: `src/main/kotlin/dev/furq/holodisplays/HoloDisplays.kt`)
- Mod initializer → Hologram handler: initializes (evidence: `src/main/kotlin/dev/furq/holodisplays/HoloDisplays.kt`)
- Mod initializer → Tick and animation: initializes (evidence: `src/main/kotlin/dev/furq/holodisplays/HoloDisplays.kt`)
- Mod initializer → Command system: registers (evidence: `src/main/kotlin/dev/furq/holodisplays/HoloDisplays.kt`)
- Mod initializer → Tick and animation: ticks (evidence: `src/main/kotlin/dev/furq/holodisplays/HoloDisplays.kt`)
- Mod initializer → Viewer tracking: updates visibility (evidence: `src/main/kotlin/dev/furq/holodisplays/HoloDisplays.kt`)
- Server administrator → Command system: issues commands (evidence: `README.md`)
- Server administrator → Display manager GUI: manages displays (evidence: `README.md`)
- Config manager → Hologram config: initializes config (evidence: `src/main/kotlin/dev/furq/holodisplays/HoloDisplays.kt`)
- Online player → Viewer tracking: visibility checked
- Viewer tracking → Hologram config: loads hologram (evidence: `src/main/kotlin/dev/furq/holodisplays/handlers/ViewerHandler.kt`)
- Viewer tracking → Display config: loads displays (evidence: `src/main/kotlin/dev/furq/holodisplays/handlers/ViewerHandler.kt`)
- Viewer tracking → Visibility conditions: evaluates (evidence: `src/main/kotlin/dev/furq/holodisplays/handlers/ViewerHandler.kt`)
- Viewer tracking → Hologram handler: checks range (evidence: `src/main/kotlin/dev/furq/holodisplays/handlers/ViewerHandler.kt`)
- Viewer tracking → Packet rendering: sends display packets (evidence: `src/main/kotlin/dev/furq/holodisplays/handlers/ViewerHandler.kt`)
- Packet rendering → Tick and animation: processes text with (evidence: `src/main/kotlin/dev/furq/holodisplays/handlers/PacketHandler.kt`)
- Packet rendering → API registry: checks API display (evidence: `src/main/kotlin/dev/furq/holodisplays/handlers/PacketHandler.kt`)
- Packet rendering → Display types: builds metadata from (evidence: `src/main/kotlin/dev/furq/holodisplays/handlers/PacketHandler.kt`)
- Online player → Placeholder API: supplies placeholders (evidence: `README.md`)
- Public API → API implementation: implemented by (evidence: `src/main/java/dev/furq/holodisplays/api/HoloDisplaysAPI.java`)
- API implementation → API registry: registers API data (evidence: `src/main/java/dev/furq/holodisplays/api/HoloDisplaysAPIInternal.java`)
