# swordfish90/cool-retro-term architecture

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

- Interactive diagram: https://gitdiagram.com/swordfish90/cool-retro-term
- Repository: https://github.com/swordfish90/cool-retro-term

## Overview

cool-retro-term is a Qt/QML terminal emulator for users who want a customizable CRT-style terminal. The documented entry point loads the QML interface; the README identifies qmltermwidget as its terminal-emulation backend and says settings are accessible from the context menu. The tree shows distinct terminal UI, settings, font-management, and visual-effects areas. Sampled C++ confirms application startup and font-model behavior, but most QML wiring was not sampled, so those internal relationships are omitted or marked unverified.

Main entry points: [`app/qml/SettingsWindow.qml`](https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/SettingsWindow.qml) (Settings UI), [`app/main.cpp`](https://github.com/swordfish90/cool-retro-term/blob/master/app/main.cpp) (Qt application), [`app/qml/TerminalWindow.qml`](https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/TerminalWindow.qml) (Terminal window), [`app/qml/TerminalContainer.qml`](https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/TerminalContainer.qml) (Terminal container)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_startup["Application startup"]
  node_app["Qt application<br/>[main.cpp]"]
  node_qmlroot["QML entry<br/>[main.qml]"]
end

subgraph group_terminal["Terminal experience"]
  node_terminalwindow["Terminal window<br/>[TerminalWindow.qml]"]
  node_tabs["Terminal tabs<br/>[TerminalTabs.qml]"]
  node_container["Terminal container"]
  node_backend["Terminal backend"]
  node_menus["Context menus"]
end

subgraph group_customization["Customization"]
  node_settings["Settings UI<br/>[SettingsWindow.qml]"]
  node_storage["Settings storage<br/>[Storage.qml]"]
  node_fileio["File access<br/>[fileio.cpp]"]
  node_fontmanager["Font manager<br/>[fontmanager.cpp]"]
  node_fontmodels["Font list models<br/>[fontlistmodel.cpp]"]
end

subgraph group_visuals["CRT visuals"]
  node_effectui["Effect controls"]
  node_terminalrender["Terminal rendering<br/>[ShaderTerminal.qml]"]
  node_frame["Terminal frame<br/>[TerminalFrame.qml]"]
  node_burnin["Burn-in effect<br/>[BurnInEffect.qml]"]
end

node_user(("Terminal user"))

node_user -->|"launches"| node_app
node_app -->|"loads"| node_qmlroot
node_user -->|"opens settings"| node_menus
node_menus -.->|"opens"| node_settings
node_qmlroot -.->|"creates windows"| node_terminalwindow
node_terminalwindow -.->|"hosts tabs"| node_tabs
node_tabs -.->|"displays terminals"| node_container
node_container -->|"embeds"| node_backend
node_settings -.->|"persists preferences"| node_storage
node_app -->|"exposes"| node_fileio
node_settings -.->|"configures fonts"| node_fontmanager
node_fontmanager -->|"updates models"| node_fontmodels
node_settings -.->|"configures effects"| node_effectui
node_container -.->|"renders terminal"| node_terminalrender
node_terminalwindow -.->|"frames display"| node_frame
node_terminalrender -.->|"applies effect"| node_burnin

click node_app "https://github.com/swordfish90/cool-retro-term/blob/master/app/main.cpp"
click node_qmlroot "https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/main.qml"
click node_terminalwindow "https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/TerminalWindow.qml"
click node_tabs "https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/TerminalTabs.qml"
click node_container "https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/TerminalContainer.qml"
click node_backend "https://github.com/swordfish90/cool-retro-term/tree/master/qmltermwidget"
click node_menus "https://github.com/swordfish90/cool-retro-term/tree/master/app/qml/menus"
click node_settings "https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/SettingsWindow.qml"
click node_storage "https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/Storage.qml"
click node_fileio "https://github.com/swordfish90/cool-retro-term/blob/master/app/fileio.cpp"
click node_fontmanager "https://github.com/swordfish90/cool-retro-term/blob/master/app/fontmanager.cpp"
click node_fontmodels "https://github.com/swordfish90/cool-retro-term/blob/master/app/fontlistmodel.cpp"
click node_effectui "https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/SettingsEffectsTab.qml"
click node_terminalrender "https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/ShaderTerminal.qml"
click node_frame "https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/TerminalFrame.qml"
click node_burnin "https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/BurnInEffect.qml"

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_app,node_qmlroot,node_user toneBlue
class node_terminalwindow,node_tabs,node_container,node_backend,node_menus toneAmber
class node_settings,node_storage,node_fileio,node_fontmanager,node_fontmodels toneMint
class node_effectui,node_terminalrender,node_frame,node_burnin toneRose
```

## Components

### Application startup

- [Qt application](https://github.com/swordfish90/cool-retro-term/blob/master/app/main.cpp): `app/main.cpp`
- [QML entry](https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/main.qml): `app/qml/main.qml`

### Terminal experience

- [Terminal window](https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/TerminalWindow.qml): `app/qml/TerminalWindow.qml`
- [Terminal tabs](https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/TerminalTabs.qml): `app/qml/TerminalTabs.qml`
- [Terminal container](https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/TerminalContainer.qml): `app/qml/TerminalContainer.qml`
- [Terminal backend](https://github.com/swordfish90/cool-retro-term/tree/master/qmltermwidget): `qmltermwidget`
- [Context menus](https://github.com/swordfish90/cool-retro-term/tree/master/app/qml/menus): `app/qml/menus`

### Customization

- [Settings UI](https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/SettingsWindow.qml): `app/qml/SettingsWindow.qml`
- [Settings storage](https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/Storage.qml): `app/qml/Storage.qml`
- [File access](https://github.com/swordfish90/cool-retro-term/blob/master/app/fileio.cpp): `app/fileio.cpp`
- [Font manager](https://github.com/swordfish90/cool-retro-term/blob/master/app/fontmanager.cpp): `app/fontmanager.cpp`
- [Font list models](https://github.com/swordfish90/cool-retro-term/blob/master/app/fontlistmodel.cpp): `app/fontlistmodel.cpp`

### CRT visuals

- [Effect controls](https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/SettingsEffectsTab.qml): `app/qml/SettingsEffectsTab.qml`
- [Terminal rendering](https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/ShaderTerminal.qml): `app/qml/ShaderTerminal.qml`
- [Terminal frame](https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/TerminalFrame.qml): `app/qml/TerminalFrame.qml`
- [Burn-in effect](https://github.com/swordfish90/cool-retro-term/blob/master/app/qml/BurnInEffect.qml): `app/qml/BurnInEffect.qml`

### Other components

- **Terminal user**

## Connections

- Terminal user → Qt application: launches (evidence: `README.md`)
- Qt application → QML entry: loads (evidence: `app/main.cpp`)
- Terminal user → Context menus: opens settings (evidence: `README.md`)
- Context menus → Settings UI: opens
- QML entry → Terminal window: creates windows
- Terminal window → Terminal tabs: hosts tabs
- Terminal tabs → Terminal container: displays terminals
- Terminal container → Terminal backend: embeds (evidence: `README.md`)
- Settings UI → Settings storage: persists preferences
- Qt application → File access: exposes (evidence: `app/main.cpp`)
- Settings UI → Font manager: configures fonts
- Font manager → Font list models: updates models (evidence: `app/fontmanager.cpp`)
- Settings UI → Effect controls: configures effects
- Terminal container → Terminal rendering: renders terminal
- Terminal window → Terminal frame: frames display
- Terminal rendering → Burn-in effect: applies effect
