# tastytrash/spatial-gui architecture

> Architecture diagram of the GitHub repository tastytrash/spatial-gui, 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/tastytrash/spatial-gui
- Repository: https://github.com/tastytrash/spatial-gui

## Overview

Spatial GUI is a client-side Minecraft mod that turns supported inventory and container screens into configurable 3D planes. The main flow selects eligible screens, captures their contents to a texture, and renders that texture in first- or third-person; camera, mouse, and screen behavior are adapted around that display. Configuration and keybinds control the experience, with optional compatibility for Inventory Particles and documented EMI support. Connections are limited to SOURCE INDEX references, shown excerpts, and README statements; some rendering and integration internals are unsampled.

Main entry points: [`src/main/java/org/tastytrash/spatialGUI/render/SpatialGUIRenderer.java`](https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/render/SpatialGUIRenderer.java) (Spatial GUI orchestration), [`src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIClient.java`](https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIClient.java) (Client screen selection), [`src/main/java/org/tastytrash/spatialGUI/mixin/render`](https://github.com/tastytrash/spatial-gui/tree/main/src/main/java/org/tastytrash/spatialGUI/mixin/render) (Render and camera hooks), [`src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIConfig.java`](https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIConfig.java) (Configuration)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_setup["Mod setup"]
  node_bootstrap["Mod initialization<br/>[SpatialGUI.java]"]
  node_config["Configuration"]
  node_keybinds["Keybinds"]
  node_modmenu["Mod Menu config"]
end

subgraph group_screen["Screen handling"]
  node_client["Client screen selection"]
  node_clienthooks["Screen hooks"]
  node_compatemi["EMI screen compatibility"]
end

subgraph group_render["3D rendering"]
  node_renderer["Spatial GUI orchestration"]
  node_extractor["Screen capture"]
  node_target["Texture target"]
  node_inventory["3D screen rendering"]
  node_renderutil["Screen geometry utilities<br/>[RenderUtil.java]"]
  node_math["Math utilities<br/>[MathUtil.java]"]
end

subgraph group_interaction["View and input"]
  node_gamehooks["Render and camera hooks"]
  node_guihooks["GUI and mouse hooks"]
  node_particles["Inventory Particles compatibility"]
  node_camera["Camera collision and tuning<br/>[CameraUtil.java]"]
  node_mouseutil["Mouse position utilities"]
  node_animation["Screen animation<br/>[AnimationUtil.java]"]
end

node_player(("Player"))
node_game["Minecraft client"]

node_player -->|"opens screens"| node_game
node_game -.->|"provides screens"| node_client
node_bootstrap -->|"registers"| node_config
node_client -->|"registers"| node_keybinds
node_client -->|"creates"| node_renderer
node_client -->|"checks settings"| node_config
node_modmenu -->|"opens config"| node_config
node_renderer -->|"captures screens"| node_extractor
node_renderer -->|"manages target"| node_target
node_renderer -->|"renders screen"| node_inventory
node_inventory -->|"draws to"| node_target
node_inventory -->|"uses geometry"| node_renderutil
node_gamehooks -->|"invokes rendering"| node_renderer
node_gamehooks -->|"checks collisions"| node_camera
node_gamehooks -->|"uses animation"| node_animation
node_gamehooks -->|"uses math"| node_math
node_guihooks -->|"checks hooked screen"| node_renderer
node_guihooks -->|"maps mouse input"| node_mouseutil
node_guihooks -->|"updates cursor"| node_particles
node_clienthooks -->|"queries screen eligibility"| node_client
node_compatemi -->|"uses screen state"| node_client
node_compatemi -->|"uses mouse mapping"| node_mouseutil
node_renderer -->|"uses camera tuning"| node_camera
node_player -->|"views 3D screens"| node_renderer
node_config -.->|"configures modes"| node_renderer

click node_bootstrap "https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/SpatialGUI.java"
click node_config "https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIConfig.java"
click node_keybinds "https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIKeybinds.java"
click node_client "https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIClient.java"
click node_modmenu "https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIModMenu.java"
click node_renderer "https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/render/SpatialGUIRenderer.java"
click node_extractor "https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/render/ScreenExtractor.java"
click node_target "https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/render/TextureTargetManager.java"
click node_inventory "https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/render/InventoryRenderer.java"
click node_renderutil "https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/util/RenderUtil.java"
click node_gamehooks "https://github.com/tastytrash/spatial-gui/tree/main/src/main/java/org/tastytrash/spatialGUI/mixin/render"
click node_guihooks "https://github.com/tastytrash/spatial-gui/tree/main/src/main/java/org/tastytrash/spatialGUI/mixin/gui"
click node_clienthooks "https://github.com/tastytrash/spatial-gui/tree/main/src/main/java/org/tastytrash/spatialGUI/mixin/client"
click node_compatemi "https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/mixin/compat/EMIScreenManagerMixin.java"
click node_particles "https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/compat/InventoryParticlesCompat.java"
click node_camera "https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/util/CameraUtil.java"
click node_mouseutil "https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/util/MouseHandlerUtil.java"
click node_animation "https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/util/AnimationUtil.java"
click node_math "https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/util/MathUtil.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_bootstrap,node_config,node_keybinds,node_modmenu,node_game toneBlue
class node_client,node_clienthooks,node_compatemi toneAmber
class node_renderer,node_extractor,node_target,node_inventory,node_renderutil,node_math toneMint
class node_gamehooks,node_guihooks,node_particles,node_camera,node_mouseutil,node_animation toneRose
class node_player toneIndigo
```

## Components

### Mod setup

- [Mod initialization](https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/SpatialGUI.java): `src/main/java/org/tastytrash/spatialGUI/SpatialGUI.java`
- [Configuration](https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIConfig.java): `src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIConfig.java`
- [Keybinds](https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIKeybinds.java): `src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIKeybinds.java`
- [Mod Menu config](https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIModMenu.java): `src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIModMenu.java`

### Screen handling

- [Client screen selection](https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIClient.java): `src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIClient.java`
- [Screen hooks](https://github.com/tastytrash/spatial-gui/tree/main/src/main/java/org/tastytrash/spatialGUI/mixin/client): `src/main/java/org/tastytrash/spatialGUI/mixin/client`
- [EMI screen compatibility](https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/mixin/compat/EMIScreenManagerMixin.java): `src/main/java/org/tastytrash/spatialGUI/mixin/compat/EMIScreenManagerMixin.java`

### 3D rendering

- [Spatial GUI orchestration](https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/render/SpatialGUIRenderer.java): `src/main/java/org/tastytrash/spatialGUI/render/SpatialGUIRenderer.java`
- [Screen capture](https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/render/ScreenExtractor.java): `src/main/java/org/tastytrash/spatialGUI/render/ScreenExtractor.java`
- [Texture target](https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/render/TextureTargetManager.java): `src/main/java/org/tastytrash/spatialGUI/render/TextureTargetManager.java`
- [3D screen rendering](https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/render/InventoryRenderer.java): `src/main/java/org/tastytrash/spatialGUI/render/InventoryRenderer.java`
- [Screen geometry utilities](https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/util/RenderUtil.java): `src/main/java/org/tastytrash/spatialGUI/util/RenderUtil.java`
- [Math utilities](https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/util/MathUtil.java): `src/main/java/org/tastytrash/spatialGUI/util/MathUtil.java`

### View and input

- [Render and camera hooks](https://github.com/tastytrash/spatial-gui/tree/main/src/main/java/org/tastytrash/spatialGUI/mixin/render): `src/main/java/org/tastytrash/spatialGUI/mixin/render`
- [GUI and mouse hooks](https://github.com/tastytrash/spatial-gui/tree/main/src/main/java/org/tastytrash/spatialGUI/mixin/gui): `src/main/java/org/tastytrash/spatialGUI/mixin/gui`
- [Inventory Particles compatibility](https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/compat/InventoryParticlesCompat.java): `src/main/java/org/tastytrash/spatialGUI/compat/InventoryParticlesCompat.java`
- [Camera collision and tuning](https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/util/CameraUtil.java): `src/main/java/org/tastytrash/spatialGUI/util/CameraUtil.java`
- [Mouse position utilities](https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/util/MouseHandlerUtil.java): `src/main/java/org/tastytrash/spatialGUI/util/MouseHandlerUtil.java`
- [Screen animation](https://github.com/tastytrash/spatial-gui/blob/main/src/main/java/org/tastytrash/spatialGUI/util/AnimationUtil.java): `src/main/java/org/tastytrash/spatialGUI/util/AnimationUtil.java`

### Other components

- **Player**
- **Minecraft client**

## Connections

- Player → Minecraft client: opens screens (evidence: `README.md`)
- Minecraft client → Client screen selection: provides screens
- Mod initialization → Configuration: registers (evidence: `src/main/java/org/tastytrash/spatialGUI/SpatialGUI.java`)
- Client screen selection → Keybinds: registers (evidence: `src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIClient.java`)
- Client screen selection → Spatial GUI orchestration: creates (evidence: `src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIClient.java`)
- Client screen selection → Configuration: checks settings (evidence: `src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIClient.java`)
- Mod Menu config → Configuration: opens config (evidence: `src/main/java/org/tastytrash/spatialGUI/client/SpatialGUIModMenu.java`)
- Spatial GUI orchestration → Screen capture: captures screens (evidence: `src/main/java/org/tastytrash/spatialGUI/render/SpatialGUIRenderer.java`)
- Spatial GUI orchestration → Texture target: manages target (evidence: `src/main/java/org/tastytrash/spatialGUI/render/SpatialGUIRenderer.java`)
- Spatial GUI orchestration → 3D screen rendering: renders screen (evidence: `src/main/java/org/tastytrash/spatialGUI/render/SpatialGUIRenderer.java`)
- 3D screen rendering → Texture target: draws to (evidence: `src/main/java/org/tastytrash/spatialGUI/render/InventoryRenderer.java`)
- 3D screen rendering → Screen geometry utilities: uses geometry (evidence: `src/main/java/org/tastytrash/spatialGUI/render/InventoryRenderer.java`)
- Render and camera hooks → Spatial GUI orchestration: invokes rendering (evidence: `src/main/java/org/tastytrash/spatialGUI/mixin/render/GameRendererMixin.java`)
- Render and camera hooks → Camera collision and tuning: checks collisions (evidence: `src/main/java/org/tastytrash/spatialGUI/mixin/render/CameraMixin.java`)
- Render and camera hooks → Screen animation: uses animation (evidence: `src/main/java/org/tastytrash/spatialGUI/mixin/render/CameraMixin.java`)
- Render and camera hooks → Math utilities: uses math (evidence: `src/main/java/org/tastytrash/spatialGUI/mixin/render/CameraMixin.java`)
- GUI and mouse hooks → Spatial GUI orchestration: checks hooked screen (evidence: `src/main/java/org/tastytrash/spatialGUI/mixin/gui/MouseHandlerMixin.java`)
- GUI and mouse hooks → Mouse position utilities: maps mouse input (evidence: `src/main/java/org/tastytrash/spatialGUI/mixin/gui/MouseHandlerMixin.java`)
- GUI and mouse hooks → Inventory Particles compatibility: updates cursor (evidence: `src/main/java/org/tastytrash/spatialGUI/mixin/gui/MouseHandlerMixin.java`)
- Screen hooks → Client screen selection: queries screen eligibility (evidence: `src/main/java/org/tastytrash/spatialGUI/mixin/client/AbstractRecipeBookScreenMixin.java`)
- EMI screen compatibility → Client screen selection: uses screen state (evidence: `src/main/java/org/tastytrash/spatialGUI/mixin/compat/EMIScreenManagerMixin.java`)
- EMI screen compatibility → Mouse position utilities: uses mouse mapping (evidence: `src/main/java/org/tastytrash/spatialGUI/mixin/compat/EMIScreenManagerMixin.java`)
- Spatial GUI orchestration → Camera collision and tuning: uses camera tuning (evidence: `src/main/java/org/tastytrash/spatialGUI/render/SpatialGUIRenderer.java`)
- Player → Spatial GUI orchestration: views 3D screens (evidence: `README.md`)
- Configuration → Spatial GUI orchestration: configures modes (evidence: `README.md`)
