# skrepy0/overlayer architecture

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

- Interactive diagram: https://gitdiagram.com/skrepy0/overlayer
- Repository: https://github.com/skrepy0/overlayer

## Overview

Overlayer is a client-side Minecraft mod for adding and arranging image overlays. Users open its settings screen, add image files, edit display properties with a live preview, and save entries; Minecraft rendering then displays eligible overlays in game or on the main menu. The map reflects the sampled runtime code and README capabilities; unsampled mixins and screens are included only where the SOURCE INDEX identifies their references, so some event wiring is not shown.

Main entry points: [`src/main/java/com/skrepy/overlayer/manager/OverlayerManager.java`](https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/manager/OverlayerManager.java) (Overlay manager), [`src/main/java/com/skrepy/overlayer/client/gui/OverlayerSettingsScreen.java`](https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/client/gui/OverlayerSettingsScreen.java) (Settings screen), [`src/main/java/com/skrepy/overlayer/mixin`](https://github.com/skrepy0/overlayer/tree/neo-1.21.1/src/main/java/com/skrepy/overlayer/mixin) (Screen hooks), [`src/main/java/com/skrepy/overlayer/render/OverlayRenderer.java`](https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/render/OverlayRenderer.java) (Overlay renderer)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Mod setup"]
  node_overlayer["Mod initialization<br/>[Overlayer.java]"]
  node_config["Display config<br/>[Config.java]"]
end

subgraph group_ui["Image editing UI"]
  node_settings["Settings screen"]
  node_edit["Image editor"]
  node_list["Image list<br/>[ImageList.java]"]
  node_scroll["Scrollable panel"]
  node_toast["User feedback"]
end

subgraph group_state["Overlay state"]
  node_manager["Overlay manager"]
  node_entrydata["Image entry<br/>[ImageEntry.java]"]
  node_model["Saved overlay data<br/>[OverlayerData.java]"]
  node_persistence[("JSON persistence")]
end

subgraph group_media["Image loading"]
  node_staticloader["Static image loader"]
  node_gifloader["GIF loader<br/>[GifLoader.java]"]
  node_helper["Texture conversion<br/>[LoaderHelper.java]"]
end

subgraph group_display["Game display"]
  node_renderer["Overlay renderer"]
  node_mixins["Screen hooks"]
  node_accessor["Screen accessor"]
end

node_player(("Minecraft player"))
node_minecraft["Minecraft client"]

node_player -.->|"opens settings"| node_settings
node_settings -->|"edits entries"| node_manager
node_settings -->|"updates list"| node_list
node_settings -->|"opens editor"| node_edit
node_settings -->|"shows feedback"| node_toast
node_edit -->|"adds controls"| node_scroll
node_edit -->|"validates files"| node_manager
node_edit -->|"shows feedback"| node_toast
node_list -->|"displays entries"| node_entrydata
node_overlayer -->|"registers config"| node_config
node_overlayer -->|"loads overlays"| node_manager
node_manager -->|"loads and saves"| node_persistence
node_persistence -->|"reads and writes"| node_model
node_manager -->|"builds saved data"| node_model
node_manager -->|"invalidates sort cache"| node_renderer
node_entrydata -->|"loads still images"| node_staticloader
node_entrydata -->|"loads animations"| node_gifloader
node_staticloader -->|"converts pixels"| node_helper
node_gifloader -->|"converts frames"| node_helper
node_renderer -->|"reads entries"| node_manager
node_renderer -->|"gets textures"| node_entrydata
node_mixins -->|"invokes rendering"| node_renderer
node_mixins -->|"checks display mode"| node_config
node_mixins -->|"opens settings"| node_settings
node_mixins -->|"uses widget access"| node_accessor
node_minecraft -.->|"dispatches screen hooks"| node_mixins
node_minecraft -.->|"provides render context"| node_renderer

click node_overlayer "https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/Overlayer.java"
click node_config "https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/Config.java"
click node_settings "https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/client/gui/OverlayerSettingsScreen.java"
click node_edit "https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/client/gui/ImageEditScreen.java"
click node_list "https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/client/gui/components/ImageList.java"
click node_scroll "https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/client/gui/components/ScrollablePanel.java"
click node_toast "https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/client/gui/OverlayerToast.java"
click node_manager "https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/manager/OverlayerManager.java"
click node_entrydata "https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/data/ImageEntry.java"
click node_model "https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/data/OverlayerData.java"
click node_persistence "https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/data/OverlayerDataManager.java"
click node_staticloader "https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/data/loader/StaticImageLoader.java"
click node_gifloader "https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/data/loader/GifLoader.java"
click node_helper "https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/data/loader/LoaderHelper.java"
click node_renderer "https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/render/OverlayRenderer.java"
click node_mixins "https://github.com/skrepy0/overlayer/tree/neo-1.21.1/src/main/java/com/skrepy/overlayer/mixin"
click node_accessor "https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/mixin/accessor/ScreenAccessor.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_overlayer,node_config,node_minecraft toneBlue
class node_settings,node_edit,node_list,node_scroll,node_toast toneAmber
class node_manager,node_entrydata,node_model,node_persistence toneMint
class node_staticloader,node_gifloader,node_helper toneRose
class node_renderer,node_mixins,node_accessor,node_player toneIndigo
```

## Components

### Mod setup

- [Mod initialization](https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/Overlayer.java): `src/main/java/com/skrepy/overlayer/Overlayer.java`
- [Display config](https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/Config.java): `src/main/java/com/skrepy/overlayer/Config.java`

### Image editing UI

- [Settings screen](https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/client/gui/OverlayerSettingsScreen.java): `src/main/java/com/skrepy/overlayer/client/gui/OverlayerSettingsScreen.java`
- [Image editor](https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/client/gui/ImageEditScreen.java): `src/main/java/com/skrepy/overlayer/client/gui/ImageEditScreen.java`
- [Image list](https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/client/gui/components/ImageList.java): `src/main/java/com/skrepy/overlayer/client/gui/components/ImageList.java`
- [Scrollable panel](https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/client/gui/components/ScrollablePanel.java): `src/main/java/com/skrepy/overlayer/client/gui/components/ScrollablePanel.java`
- [User feedback](https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/client/gui/OverlayerToast.java): `src/main/java/com/skrepy/overlayer/client/gui/OverlayerToast.java`

### Overlay state

- [Overlay manager](https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/manager/OverlayerManager.java): `src/main/java/com/skrepy/overlayer/manager/OverlayerManager.java`
- [Image entry](https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/data/ImageEntry.java): `src/main/java/com/skrepy/overlayer/data/ImageEntry.java`
- [Saved overlay data](https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/data/OverlayerData.java): `src/main/java/com/skrepy/overlayer/data/OverlayerData.java`
- [JSON persistence](https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/data/OverlayerDataManager.java): `src/main/java/com/skrepy/overlayer/data/OverlayerDataManager.java`

### Image loading

- [Static image loader](https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/data/loader/StaticImageLoader.java): `src/main/java/com/skrepy/overlayer/data/loader/StaticImageLoader.java`
- [GIF loader](https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/data/loader/GifLoader.java): `src/main/java/com/skrepy/overlayer/data/loader/GifLoader.java`
- [Texture conversion](https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/data/loader/LoaderHelper.java): `src/main/java/com/skrepy/overlayer/data/loader/LoaderHelper.java`

### Game display

- [Overlay renderer](https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/render/OverlayRenderer.java): `src/main/java/com/skrepy/overlayer/render/OverlayRenderer.java`
- [Screen hooks](https://github.com/skrepy0/overlayer/tree/neo-1.21.1/src/main/java/com/skrepy/overlayer/mixin): `src/main/java/com/skrepy/overlayer/mixin`
- [Screen accessor](https://github.com/skrepy0/overlayer/blob/neo-1.21.1/src/main/java/com/skrepy/overlayer/mixin/accessor/ScreenAccessor.java): `src/main/java/com/skrepy/overlayer/mixin/accessor/ScreenAccessor.java`

### Other components

- **Minecraft player**
- **Minecraft client**

## Connections

- Minecraft player → Settings screen: opens settings (evidence: `README.md`)
- Settings screen → Overlay manager: edits entries (evidence: `src/main/java/com/skrepy/overlayer/client/gui/OverlayerSettingsScreen.java`)
- Settings screen → Image list: updates list (evidence: `src/main/java/com/skrepy/overlayer/client/gui/OverlayerSettingsScreen.java`)
- Settings screen → Image editor: opens editor (evidence: `src/main/java/com/skrepy/overlayer/client/gui/OverlayerSettingsScreen.java`)
- Settings screen → User feedback: shows feedback (evidence: `src/main/java/com/skrepy/overlayer/client/gui/OverlayerSettingsScreen.java`)
- Image editor → Scrollable panel: adds controls (evidence: `src/main/java/com/skrepy/overlayer/client/gui/ImageEditScreen.java`)
- Image editor → Overlay manager: validates files (evidence: `src/main/java/com/skrepy/overlayer/client/gui/ImageEditScreen.java`)
- Image editor → User feedback: shows feedback (evidence: `src/main/java/com/skrepy/overlayer/client/gui/ImageEditScreen.java`)
- Image list → Image entry: displays entries (evidence: `src/main/java/com/skrepy/overlayer/client/gui/components/ImageList.java`)
- Mod initialization → Display config: registers config (evidence: `src/main/java/com/skrepy/overlayer/Overlayer.java`)
- Mod initialization → Overlay manager: loads overlays (evidence: `src/main/java/com/skrepy/overlayer/Overlayer.java`)
- Overlay manager → JSON persistence: loads and saves (evidence: `src/main/java/com/skrepy/overlayer/manager/OverlayerManager.java`)
- JSON persistence → Saved overlay data: reads and writes (evidence: `src/main/java/com/skrepy/overlayer/data/OverlayerDataManager.java`)
- Overlay manager → Saved overlay data: builds saved data (evidence: `src/main/java/com/skrepy/overlayer/manager/OverlayerManager.java`)
- Overlay manager → Overlay renderer: invalidates sort cache (evidence: `src/main/java/com/skrepy/overlayer/manager/OverlayerManager.java`)
- Image entry → Static image loader: loads still images (evidence: `src/main/java/com/skrepy/overlayer/data/ImageEntry.java`)
- Image entry → GIF loader: loads animations (evidence: `src/main/java/com/skrepy/overlayer/data/ImageEntry.java`)
- Static image loader → Texture conversion: converts pixels (evidence: `src/main/java/com/skrepy/overlayer/data/loader/StaticImageLoader.java`)
- GIF loader → Texture conversion: converts frames (evidence: `src/main/java/com/skrepy/overlayer/data/loader/GifLoader.java`)
- Overlay renderer → Overlay manager: reads entries (evidence: `src/main/java/com/skrepy/overlayer/render/OverlayRenderer.java`)
- Overlay renderer → Image entry: gets textures (evidence: `src/main/java/com/skrepy/overlayer/render/OverlayRenderer.java`)
- Screen hooks → Overlay renderer: invokes rendering (evidence: `src/main/java/com/skrepy/overlayer/mixin/GuiMixin.java`)
- Screen hooks → Display config: checks display mode (evidence: `src/main/java/com/skrepy/overlayer/mixin/ScreenMixin.java`)
- Screen hooks → Settings screen: opens settings (evidence: `src/main/java/com/skrepy/overlayer/mixin/OptionsScreenMixin.java`)
- Screen hooks → Screen accessor: uses widget access (evidence: `src/main/java/com/skrepy/overlayer/mixin/OptionsScreenMixin.java`)
- Minecraft client → Screen hooks: dispatches screen hooks
- Minecraft client → Overlay renderer: provides render context
