# hmderdoc/jockoshop architecture

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

- Interactive diagram: https://gitdiagram.com/hmderdoc/jockoshop
- Repository: https://github.com/hmderdoc/jockoshop

## Overview

jockoshop is a layered ANSI-art editor: users open or create a project, edit layers and selections on a canvas, and save the editable project or export ANSI art. Editing includes live TheDraw text, prose, image conversion, palette remapping, and depth previews. The graph also preserves documented collaboration and desktop capabilities. Several subsystems are represented by their exact source paths but were not sampled; their internal connections are omitted where evidence was unavailable.

Main entry points: [`packages/app/src/editor.ts`](https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/editor.ts) (Editor state), [`packages/app/src/main.ts`](https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/main.ts) (Application startup), [`packages/core/src/document.ts`](https://github.com/hmderdoc/jockoshop/blob/main/packages/core/src/document.ts) (Layered document), [`packages/app/src/tools.ts`](https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/tools.ts) (Canvas and tools)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["Editor application"]
  node_startup["Application startup<br/>[main.ts]"]
  node_editor["Editor state<br/>[editor.ts]"]
  node_canvas["Canvas and tools<br/>[tools.ts]"]
  node_selection["Selection operations<br/>[selectionops.ts]"]
  node_panels["Layer and text panels<br/>[sections.ts]"]
  node_view["Canvas rendering<br/>[view.ts]"]
end

subgraph group_model["Document and editing"]
  node_document["Layered document<br/>[document.ts]"]
  node_grid["Cell grid<br/>[grid.ts]"]
  node_composite["Layer compositing<br/>[composite.ts]"]
  node_history["Undo history<br/>[history.ts]"]
  node_prose["Prose text flow<br/>[prose.ts]"]
  node_shapes["Shape layers<br/>[shapes.ts]"]
end

subgraph group_media["Fonts and conversion"]
  node_fontlibrary["Font library<br/>[fonts.ts]"]
  node_imageconvert["Image conversion<br/>[shadeans.ts]"]
  node_fontmatch["Bitmap font matching<br/>[fontmatch.ts]"]
  node_contour["Contour ASCII<br/>[contour.ts]"]
end

subgraph group_files["Import and export"]
  node_io["Project file I/O<br/>[io.ts]"]
  node_ansi["ANSI format<br/>[ansi.ts]"]
  node_formats["Other art formats"]
end

subgraph group_collab["Collaboration and desktop"]
  node_cloud["Cloud projects<br/>[cloud.ts]"]
  node_joint["Joint editing<br/>[joint.ts]"]
  node_jointserver["Joint server<br/>[server.js]"]
  node_desktop["Desktop shell<br/>[lib.rs]"]
end

node_user(("Artist"))

node_user -->|"opens editor"| node_startup
node_startup -->|"creates"| node_editor
node_startup -->|"loads and saves"| node_io
node_startup -->|"loads fonts"| node_fontlibrary
node_startup -->|"initializes transport"| node_joint
node_user -->|"draws and edits"| node_canvas
node_canvas -->|"edits document"| node_editor
node_canvas -->|"invokes selection tools"| node_selection
node_editor -->|"holds and updates"| node_document
node_document -->|"stores cell content"| node_grid
node_editor -->|"recomposites layers"| node_composite
node_editor -->|"tracks undo"| node_history
node_view -->|"renders state"| node_editor
node_panels -->|"changes layer properties"| node_editor
node_panels -->|"picks text fonts"| node_fontlibrary
node_document -->|"supports prose layers"| node_prose
node_document -->|"supports shape layers"| node_shapes
node_editor -->|"converts live images"| node_imageconvert
node_imageconvert -->|"uses font bitmap matching"| node_fontmatch
node_imageconvert -->|"supports contour mode"| node_contour
node_io -->|"exports ANSI"| node_ansi
node_io -->|"imports and exports formats"| node_formats
node_startup -->|"offers cloud projects"| node_cloud
node_joint -.->|"connects for shared editing"| node_jointserver
node_startup -.->|"runs in desktop shell"| node_desktop

click node_startup "https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/main.ts"
click node_editor "https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/editor.ts"
click node_canvas "https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/tools.ts"
click node_selection "https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/selectionops.ts"
click node_panels "https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/sections.ts"
click node_view "https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/view.ts"
click node_document "https://github.com/hmderdoc/jockoshop/blob/main/packages/core/src/document.ts"
click node_grid "https://github.com/hmderdoc/jockoshop/blob/main/packages/core/src/grid.ts"
click node_composite "https://github.com/hmderdoc/jockoshop/blob/main/packages/core/src/composite.ts"
click node_history "https://github.com/hmderdoc/jockoshop/blob/main/packages/core/src/history.ts"
click node_prose "https://github.com/hmderdoc/jockoshop/blob/main/packages/core/src/prose.ts"
click node_shapes "https://github.com/hmderdoc/jockoshop/blob/main/packages/core/src/shapes.ts"
click node_fontlibrary "https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/fonts.ts"
click node_imageconvert "https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/shadeans.ts"
click node_fontmatch "https://github.com/hmderdoc/jockoshop/blob/main/packages/core/src/fontmatch.ts"
click node_contour "https://github.com/hmderdoc/jockoshop/blob/main/packages/core/src/contour.ts"
click node_io "https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/io.ts"
click node_ansi "https://github.com/hmderdoc/jockoshop/blob/main/packages/core/src/formats/ansi.ts"
click node_formats "https://github.com/hmderdoc/jockoshop/tree/main/packages/core/src/formats"
click node_cloud "https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/cloud.ts"
click node_joint "https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/joint.ts"
click node_jointserver "https://github.com/hmderdoc/jockoshop/blob/main/scripts/joint-server/app/server.js"
click node_desktop "https://github.com/hmderdoc/jockoshop/blob/main/packages/desktop/src-tauri/src/lib.rs"

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_startup,node_editor,node_canvas,node_selection,node_panels,node_view toneBlue
class node_document,node_grid,node_composite,node_history,node_prose,node_shapes toneAmber
class node_fontlibrary,node_imageconvert,node_fontmatch,node_contour toneMint
class node_io,node_ansi,node_formats toneRose
class node_cloud,node_joint,node_jointserver,node_desktop,node_user toneIndigo
```

## Components

### Editor application

- [Application startup](https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/main.ts): `packages/app/src/main.ts`
- [Editor state](https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/editor.ts): `packages/app/src/editor.ts`
- [Canvas and tools](https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/tools.ts): `packages/app/src/tools.ts`
- [Selection operations](https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/selectionops.ts): `packages/app/src/selectionops.ts`
- [Layer and text panels](https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/sections.ts): `packages/app/src/sections.ts`
- [Canvas rendering](https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/view.ts): `packages/app/src/view.ts`

### Document and editing

- [Layered document](https://github.com/hmderdoc/jockoshop/blob/main/packages/core/src/document.ts): `packages/core/src/document.ts`
- [Cell grid](https://github.com/hmderdoc/jockoshop/blob/main/packages/core/src/grid.ts): `packages/core/src/grid.ts`
- [Layer compositing](https://github.com/hmderdoc/jockoshop/blob/main/packages/core/src/composite.ts): `packages/core/src/composite.ts`
- [Undo history](https://github.com/hmderdoc/jockoshop/blob/main/packages/core/src/history.ts): `packages/core/src/history.ts`
- [Prose text flow](https://github.com/hmderdoc/jockoshop/blob/main/packages/core/src/prose.ts): `packages/core/src/prose.ts`
- [Shape layers](https://github.com/hmderdoc/jockoshop/blob/main/packages/core/src/shapes.ts): `packages/core/src/shapes.ts`

### Fonts and conversion

- [Font library](https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/fonts.ts): `packages/app/src/fonts.ts`
- [Image conversion](https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/shadeans.ts): `packages/app/src/shadeans.ts`
- [Bitmap font matching](https://github.com/hmderdoc/jockoshop/blob/main/packages/core/src/fontmatch.ts): `packages/core/src/fontmatch.ts`
- [Contour ASCII](https://github.com/hmderdoc/jockoshop/blob/main/packages/core/src/contour.ts): `packages/core/src/contour.ts`

### Import and export

- [Project file I/O](https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/io.ts): `packages/app/src/io.ts`
- [ANSI format](https://github.com/hmderdoc/jockoshop/blob/main/packages/core/src/formats/ansi.ts): `packages/core/src/formats/ansi.ts`
- [Other art formats](https://github.com/hmderdoc/jockoshop/tree/main/packages/core/src/formats): `packages/core/src/formats`

### Collaboration and desktop

- [Cloud projects](https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/cloud.ts): `packages/app/src/cloud.ts`
- [Joint editing](https://github.com/hmderdoc/jockoshop/blob/main/packages/app/src/joint.ts): `packages/app/src/joint.ts`
- [Joint server](https://github.com/hmderdoc/jockoshop/blob/main/scripts/joint-server/app/server.js): `scripts/joint-server/app/server.js`
- [Desktop shell](https://github.com/hmderdoc/jockoshop/blob/main/packages/desktop/src-tauri/src/lib.rs): `packages/desktop/src-tauri/src/lib.rs`

### Other components

- **Artist**

## Connections

- Artist → Application startup: opens editor (evidence: `README.md`)
- Application startup → Editor state: creates (evidence: `packages/app/src/main.ts`)
- Application startup → Project file I/O: loads and saves (evidence: `packages/app/src/main.ts`)
- Application startup → Font library: loads fonts (evidence: `packages/app/src/main.ts`)
- Application startup → Joint editing: initializes transport (evidence: `packages/app/src/main.ts`)
- Artist → Canvas and tools: draws and edits (evidence: `README.md`)
- Canvas and tools → Editor state: edits document (evidence: `packages/app/src/tools.ts`)
- Canvas and tools → Selection operations: invokes selection tools (evidence: `packages/app/src/tools.ts`)
- Editor state → Layered document: holds and updates (evidence: `packages/app/src/editor.ts`)
- Layered document → Cell grid: stores cell content (evidence: `packages/core/src/document.ts`)
- Editor state → Layer compositing: recomposites layers (evidence: `packages/app/src/editor.ts`)
- Editor state → Undo history: tracks undo (evidence: `packages/app/src/editor.ts`)
- Canvas rendering → Editor state: renders state (evidence: `packages/app/src/view.ts`)
- Layer and text panels → Editor state: changes layer properties (evidence: `packages/app/src/sections.ts`)
- Layer and text panels → Font library: picks text fonts (evidence: `packages/app/src/sections.ts`)
- Layered document → Prose text flow: supports prose layers (evidence: `README.md`)
- Layered document → Shape layers: supports shape layers (evidence: `README.md`)
- Editor state → Image conversion: converts live images (evidence: `README.md`)
- Image conversion → Bitmap font matching: uses font bitmap matching (evidence: `README.md`)
- Image conversion → Contour ASCII: supports contour mode (evidence: `README.md`)
- Project file I/O → ANSI format: exports ANSI (evidence: `README.md`)
- Project file I/O → Other art formats: imports and exports formats (evidence: `packages/core/src/formats/xbin.ts`)
- Application startup → Cloud projects: offers cloud projects (evidence: `packages/app/src/main.ts`)
- Joint editing → Joint server: connects for shared editing
- Application startup → Desktop shell: runs in desktop shell
