# bfur64/tetrue-terminal architecture

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

- Interactive diagram: https://gitdiagram.com/bfur64/tetrue-terminal
- Repository: https://github.com/bfur64/tetrue-terminal

## Overview

Tetrue Terminal is a Java fullscreen-terminal framework. An application obtains a runtime through Terminal.builder(), uses its Terminal API to buffer styled drawing commands and read keys, then flushes commands through frame construction to a selected backend. The library also provides JLine, Lanterna, and mock implementations. The graph preserves the documented features, but some implementation details—especially mock wiring and command execution—are represented only where the README or source index supports them.

Main entry points: [`terminal-core/src/main/java/io/github/bfur64/terminal/Terminal.java`](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/Terminal.java) (Terminal API), [`terminal-core/src/main/java/io/github/bfur64/terminal/implementations/jline/JLineRuntime.java`](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/jline/JLineRuntime.java) (JLine Runtime), [`terminal-core/src/main/java/io/github/bfur64/terminal/implementations/lanterna/LanternaRuntime.java`](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/lanterna/LanternaRuntime.java) (Lanterna Runtime), [`terminal-core/src/main/java/io/github/bfur64/terminal/interfaces/InputSource.java`](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/interfaces/InputSource.java) (Input Contract)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Application API"]
  node_terminal["Terminal API<br/>[Terminal.java]"]
  node_runtime_contract["Runtime Contract"]
  node_environment["Environment Info"]
end

subgraph group_render["Rendering and Styling"]
  node_command_buffer["Drawing Commands"]
  node_frame_builder["Frame Builder<br/>[FrameBuilder.java]"]
  node_frame["Frame Buffer<br/>[Frame.java]"]
  node_symbol["Styled Symbols<br/>[Symbol.java]"]
  node_style["Colors and Styles"]
  node_renderer_contract["Renderer Contract"]
end

subgraph group_input["Keyboard Input"]
  node_input_contract["Input Contract<br/>[InputSource.java]"]
  node_key_stroke["Key Stroke<br/>[KeyStroke.java]"]
  node_key_type["Key Types<br/>[KeyType.java]"]
end

subgraph group_backends["Terminal Backends"]
  node_jline_runtime["JLine Runtime<br/>[JLineRuntime.java]"]
  node_jline_backend["JLine Renderer<br/>[JLineBackend.java]"]
  node_jline_input["JLine Input"]
  node_lanterna_runtime["Lanterna Runtime"]
  node_lanterna_backend["Lanterna Renderer"]
  node_lanterna_input["Lanterna Input"]
  node_mock_runtime["Mock Runtime<br/>[MockRuntime.java]"]
  node_mock_backend["Mock Renderer<br/>[MockBackend.java]"]
  node_mock_input["Mock Input"]
end

node_application(("Application"))

node_application -->|"uses API"| node_terminal
node_terminal -->|"buffers commands"| node_command_buffer
node_terminal -->|"flushes commands"| node_frame_builder
node_frame_builder -->|"updates buffer"| node_frame
node_frame_builder -->|"creates symbols"| node_symbol
node_frame_builder -->|"draws frame"| node_renderer_contract
node_terminal -->|"reads keys"| node_input_contract
node_input_contract -->|"returns keys"| node_key_stroke
node_key_stroke -->|"uses type"| node_key_type
node_terminal -->|"queries size"| node_environment
node_terminal -->|"applies styles"| node_style
node_terminal -->|"selects runtime"| node_jline_runtime
node_terminal -->|"selects runtime"| node_lanterna_runtime
node_terminal -->|"selects runtime"| node_mock_runtime
node_jline_runtime -->|"implements"| node_runtime_contract
node_jline_runtime -->|"provides dimensions"| node_environment
node_jline_runtime -->|"creates API"| node_terminal
node_jline_runtime -->|"configures renderer"| node_jline_backend
node_jline_runtime -->|"configures input"| node_jline_input
node_jline_backend -->|"implements"| node_renderer_contract
node_jline_input -.->|"implements"| node_input_contract
node_lanterna_runtime -.->|"implements"| node_runtime_contract
node_lanterna_runtime -.->|"creates API"| node_terminal
node_lanterna_runtime -.->|"configures renderer"| node_lanterna_backend
node_lanterna_runtime -.->|"configures input"| node_lanterna_input
node_lanterna_backend -->|"implements"| node_renderer_contract
node_lanterna_input -.->|"implements"| node_input_contract
node_mock_runtime -.->|"implements"| node_runtime_contract
node_mock_runtime -.->|"configures renderer"| node_mock_backend
node_mock_runtime -.->|"configures input"| node_mock_input
node_mock_backend -.->|"implements"| node_renderer_contract
node_mock_input -.->|"implements"| node_input_contract

click node_terminal "https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/Terminal.java"
click node_runtime_contract "https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/interfaces/TerminalRuntime.java"
click node_environment "https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/interfaces/TerminalEnvironment.java"
click node_command_buffer "https://github.com/bfur64/tetrue-terminal/tree/main/terminal-core/src/main/java/io/github/bfur64/terminal/commands"
click node_frame_builder "https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/render/FrameBuilder.java"
click node_frame "https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/render/Frame.java"
click node_symbol "https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/render/Symbol.java"
click node_style "https://github.com/bfur64/tetrue-terminal/tree/main/terminal-core/src/main/java/io/github/bfur64/terminal/output"
click node_renderer_contract "https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/interfaces/RendererBackend.java"
click node_input_contract "https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/interfaces/InputSource.java"
click node_key_stroke "https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/input/KeyStroke.java"
click node_key_type "https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/input/KeyType.java"
click node_jline_runtime "https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/jline/JLineRuntime.java"
click node_jline_backend "https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/jline/JLineBackend.java"
click node_jline_input "https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/jline/JLineInputSource.java"
click node_lanterna_runtime "https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/lanterna/LanternaRuntime.java"
click node_lanterna_backend "https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/lanterna/LanternaBackend.java"
click node_lanterna_input "https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/lanterna/LanternaInputSource.java"
click node_mock_runtime "https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/mock/MockRuntime.java"
click node_mock_backend "https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/mock/MockBackend.java"
click node_mock_input "https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/mock/MockInputSource.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_terminal,node_runtime_contract,node_environment toneBlue
class node_command_buffer,node_frame_builder,node_frame,node_symbol,node_style,node_renderer_contract toneAmber
class node_input_contract,node_key_stroke,node_key_type toneMint
class node_jline_runtime,node_jline_backend,node_jline_input,node_lanterna_runtime,node_lanterna_backend,node_lanterna_input,node_mock_runtime,node_mock_backend,node_mock_input toneRose
class node_application toneIndigo
```

## Components

### Application API

- [Terminal API](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/Terminal.java): `terminal-core/src/main/java/io/github/bfur64/terminal/Terminal.java`
- [Runtime Contract](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/interfaces/TerminalRuntime.java): `terminal-core/src/main/java/io/github/bfur64/terminal/interfaces/TerminalRuntime.java`
- [Environment Info](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/interfaces/TerminalEnvironment.java): `terminal-core/src/main/java/io/github/bfur64/terminal/interfaces/TerminalEnvironment.java`

### Rendering and Styling

- [Drawing Commands](https://github.com/bfur64/tetrue-terminal/tree/main/terminal-core/src/main/java/io/github/bfur64/terminal/commands): `terminal-core/src/main/java/io/github/bfur64/terminal/commands`
- [Frame Builder](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/render/FrameBuilder.java): `terminal-core/src/main/java/io/github/bfur64/terminal/render/FrameBuilder.java`
- [Frame Buffer](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/render/Frame.java): `terminal-core/src/main/java/io/github/bfur64/terminal/render/Frame.java`
- [Styled Symbols](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/render/Symbol.java): `terminal-core/src/main/java/io/github/bfur64/terminal/render/Symbol.java`
- [Colors and Styles](https://github.com/bfur64/tetrue-terminal/tree/main/terminal-core/src/main/java/io/github/bfur64/terminal/output): `terminal-core/src/main/java/io/github/bfur64/terminal/output`
- [Renderer Contract](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/interfaces/RendererBackend.java): `terminal-core/src/main/java/io/github/bfur64/terminal/interfaces/RendererBackend.java`

### Keyboard Input

- [Input Contract](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/interfaces/InputSource.java): `terminal-core/src/main/java/io/github/bfur64/terminal/interfaces/InputSource.java`
- [Key Stroke](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/input/KeyStroke.java): `terminal-core/src/main/java/io/github/bfur64/terminal/input/KeyStroke.java`
- [Key Types](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/input/KeyType.java): `terminal-core/src/main/java/io/github/bfur64/terminal/input/KeyType.java`

### Terminal Backends

- [JLine Runtime](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/jline/JLineRuntime.java): `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/jline/JLineRuntime.java`
- [JLine Renderer](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/jline/JLineBackend.java): `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/jline/JLineBackend.java`
- [JLine Input](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/jline/JLineInputSource.java): `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/jline/JLineInputSource.java`
- [Lanterna Runtime](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/lanterna/LanternaRuntime.java): `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/lanterna/LanternaRuntime.java`
- [Lanterna Renderer](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/lanterna/LanternaBackend.java): `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/lanterna/LanternaBackend.java`
- [Lanterna Input](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/lanterna/LanternaInputSource.java): `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/lanterna/LanternaInputSource.java`
- [Mock Runtime](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/mock/MockRuntime.java): `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/mock/MockRuntime.java`
- [Mock Renderer](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/mock/MockBackend.java): `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/mock/MockBackend.java`
- [Mock Input](https://github.com/bfur64/tetrue-terminal/blob/main/terminal-core/src/main/java/io/github/bfur64/terminal/implementations/mock/MockInputSource.java): `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/mock/MockInputSource.java`

### Other components

- **Application**

## Connections

- Application → Terminal API: uses API (evidence: `README.md`)
- Terminal API → Drawing Commands: buffers commands (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/Terminal.java`)
- Terminal API → Frame Builder: flushes commands (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/Terminal.java`)
- Frame Builder → Frame Buffer: updates buffer (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/render/FrameBuilder.java`)
- Frame Builder → Styled Symbols: creates symbols (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/render/FrameBuilder.java`)
- Frame Builder → Renderer Contract: draws frame (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/render/FrameBuilder.java`)
- Terminal API → Input Contract: reads keys (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/Terminal.java`)
- Input Contract → Key Stroke: returns keys (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/interfaces/InputSource.java`)
- Key Stroke → Key Types: uses type (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/input/KeyStroke.java`)
- Terminal API → Environment Info: queries size (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/Terminal.java`)
- Terminal API → Colors and Styles: applies styles (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/Terminal.java`)
- Terminal API → JLine Runtime: selects runtime (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/Terminal.java`)
- Terminal API → Lanterna Runtime: selects runtime (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/Terminal.java`)
- Terminal API → Mock Runtime: selects runtime (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/Terminal.java`)
- JLine Runtime → Runtime Contract: implements (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/jline/JLineRuntime.java`)
- JLine Runtime → Environment Info: provides dimensions (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/jline/JLineRuntime.java`)
- JLine Runtime → Terminal API: creates API (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/jline/JLineRuntime.java`)
- JLine Runtime → JLine Renderer: configures renderer (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/jline/JLineRuntime.java`)
- JLine Runtime → JLine Input: configures input (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/jline/JLineRuntime.java`)
- JLine Renderer → Renderer Contract: implements (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/jline/JLineBackend.java`)
- JLine Input → Input Contract: implements (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/jline/JLineInputSource.java`)
- Lanterna Runtime → Runtime Contract: implements (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/lanterna/LanternaRuntime.java`)
- Lanterna Runtime → Terminal API: creates API (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/lanterna/LanternaRuntime.java`)
- Lanterna Runtime → Lanterna Renderer: configures renderer (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/lanterna/LanternaRuntime.java`)
- Lanterna Runtime → Lanterna Input: configures input (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/lanterna/LanternaRuntime.java`)
- Lanterna Renderer → Renderer Contract: implements (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/lanterna/LanternaBackend.java`)
- Lanterna Input → Input Contract: implements (evidence: `terminal-core/src/main/java/io/github/bfur64/terminal/implementations/lanterna/LanternaInputSource.java`)
- Mock Runtime → Runtime Contract: implements
- Mock Runtime → Mock Renderer: configures renderer
- Mock Runtime → Mock Input: configures input
- Mock Renderer → Renderer Contract: implements
- Mock Input → Input Contract: implements
