# ajcraig99/plant3d-live-preview architecture

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

- Interactive diagram: https://gitdiagram.com/ajcraig99/plant3d-live-preview
- Repository: https://github.com/ajcraig99/plant3d-live-preview

## Overview

Plant 3D Live Preview lets users select custom Python part scripts, render them through a Plant-compatible geometry shim, and inspect or adjust the resulting model in a browser. The main path is browser selection and parameter editing → server render request → script execution and mesh generation → model and metadata in the viewer. The CLI offers a separate one-off rendering path. The README documents additional viewer capabilities; source excerpts do not expose their individual implementation details, so they are represented within the viewer node.

Main entry points: [`render.py`](https://github.com/ajcraig99/plant3d-live-preview/blob/main/render.py) (Script renderer), [`viewer/index.html`](https://github.com/ajcraig99/plant3d-live-preview/blob/main/viewer/index.html) (Preview UI), [`server.py`](https://github.com/ajcraig99/plant3d-live-preview/blob/main/server.py) (HTTP server), [`shim/p3dkernel.py`](https://github.com/ajcraig99/plant3d-live-preview/blob/main/shim/p3dkernel.py) (Mesh geometry kernel)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interaction["User interaction"]
  node_viewer["Preview UI<br/>[index.html]"]
end

subgraph group_service["Preview service"]
  node_server["HTTP server<br/>[server.py]"]
  node_discovery["Script discovery<br/>[server.py]"]
  node_watcher["File watcher<br/>[server.py]"]
end

subgraph group_rendering["Rendering engine"]
  node_render["Script renderer<br/>[render.py]"]
  node_metadata["Render metadata<br/>[render.py]"]
  node_mesh["GLB mesh<br/>[render.py]"]
  node_cli["Render CLI<br/>[render.py]"]
end

subgraph group_compat["Plant compatibility"]
  node_kernel["Mesh geometry kernel<br/>[p3dkernel.py]"]
  node_primitives["Primitive shim<br/>[primitiv.py]"]
  node_decorators["Parameter decorators<br/>[custom.py]"]
  node_mathshim["Math shim<br/>[math.py]"]
end

node_user(("Part author"))
node_scripts["Part scripts"]
node_browser(("Browser"))

node_user -->|"edits"| node_scripts
node_user -->|"selects and adjusts"| node_viewer
node_browser -->|"opens"| node_viewer
node_viewer -->|"requests renders"| node_server
node_server -->|"lists scripts"| node_discovery
node_server -->|"invokes"| node_render
node_watcher -->|"notifies changes"| node_viewer
node_server -->|"starts"| node_watcher
node_scripts -->|"supplies source"| node_render
node_render -->|"executes via"| node_kernel
node_render -->|"collects"| node_metadata
node_render -->|"exports"| node_mesh
node_render -->|"loads scripts using"| node_primitives
node_render -->|"reads parameter metadata"| node_decorators
node_primitives -->|"constructs solids with"| node_kernel
node_kernel -->|"uses math helpers"| node_mathshim
node_server -->|"serves UI"| node_viewer
node_metadata -->|"drives controls and overlays"| node_viewer
node_mesh -->|"displays model"| node_viewer
node_user -->|"runs one-off render"| node_cli
node_cli -->|"calls"| node_render

click node_viewer "https://github.com/ajcraig99/plant3d-live-preview/blob/main/viewer/index.html"
click node_server "https://github.com/ajcraig99/plant3d-live-preview/blob/main/server.py"
click node_discovery "https://github.com/ajcraig99/plant3d-live-preview/blob/main/server.py"
click node_watcher "https://github.com/ajcraig99/plant3d-live-preview/blob/main/server.py"
click node_render "https://github.com/ajcraig99/plant3d-live-preview/blob/main/render.py"
click node_metadata "https://github.com/ajcraig99/plant3d-live-preview/blob/main/render.py"
click node_mesh "https://github.com/ajcraig99/plant3d-live-preview/blob/main/render.py"
click node_kernel "https://github.com/ajcraig99/plant3d-live-preview/blob/main/shim/p3dkernel.py"
click node_primitives "https://github.com/ajcraig99/plant3d-live-preview/blob/main/shim/varmain/primitiv.py"
click node_decorators "https://github.com/ajcraig99/plant3d-live-preview/blob/main/shim/varmain/custom.py"
click node_mathshim "https://github.com/ajcraig99/plant3d-live-preview/blob/main/shim/aqa/math.py"
click node_cli "https://github.com/ajcraig99/plant3d-live-preview/blob/main/render.py"

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_viewer,node_browser toneBlue
class node_server,node_discovery,node_watcher toneAmber
class node_render,node_metadata,node_mesh,node_cli toneMint
class node_kernel,node_primitives,node_decorators,node_mathshim toneRose
class node_user,node_scripts toneIndigo
```

## Components

### User interaction

- [Preview UI](https://github.com/ajcraig99/plant3d-live-preview/blob/main/viewer/index.html): `viewer/index.html`

### Preview service

- [HTTP server](https://github.com/ajcraig99/plant3d-live-preview/blob/main/server.py): `server.py`
- [Script discovery](https://github.com/ajcraig99/plant3d-live-preview/blob/main/server.py): `server.py`
- [File watcher](https://github.com/ajcraig99/plant3d-live-preview/blob/main/server.py): `server.py`

### Rendering engine

- [Script renderer](https://github.com/ajcraig99/plant3d-live-preview/blob/main/render.py): `render.py`
- [Render metadata](https://github.com/ajcraig99/plant3d-live-preview/blob/main/render.py): `render.py`
- [GLB mesh](https://github.com/ajcraig99/plant3d-live-preview/blob/main/render.py): `render.py`
- [Render CLI](https://github.com/ajcraig99/plant3d-live-preview/blob/main/render.py): `render.py`

### Plant compatibility

- [Mesh geometry kernel](https://github.com/ajcraig99/plant3d-live-preview/blob/main/shim/p3dkernel.py): `shim/p3dkernel.py`
- [Primitive shim](https://github.com/ajcraig99/plant3d-live-preview/blob/main/shim/varmain/primitiv.py): `shim/varmain/primitiv.py`
- [Parameter decorators](https://github.com/ajcraig99/plant3d-live-preview/blob/main/shim/varmain/custom.py): `shim/varmain/custom.py`
- [Math shim](https://github.com/ajcraig99/plant3d-live-preview/blob/main/shim/aqa/math.py): `shim/aqa/math.py`

### Other components

- **Part author**
- **Part scripts**
- **Browser**

## Connections

- Part author → Part scripts: edits (evidence: `README.md`)
- Part author → Preview UI: selects and adjusts (evidence: `README.md`)
- Browser → Preview UI: opens (evidence: `README.md`)
- Preview UI → HTTP server: requests renders (evidence: `README.md`)
- HTTP server → Script discovery: lists scripts (evidence: `server.py`)
- HTTP server → Script renderer: invokes (evidence: `server.py`)
- File watcher → Preview UI: notifies changes (evidence: `server.py`)
- HTTP server → File watcher: starts (evidence: `server.py`)
- Part scripts → Script renderer: supplies source (evidence: `README.md`)
- Script renderer → Mesh geometry kernel: executes via (evidence: `render.py`)
- Script renderer → Render metadata: collects (evidence: `render.py`)
- Script renderer → GLB mesh: exports (evidence: `render.py`)
- Script renderer → Primitive shim: loads scripts using (evidence: `render.py`)
- Script renderer → Parameter decorators: reads parameter metadata (evidence: `render.py`)
- Primitive shim → Mesh geometry kernel: constructs solids with (evidence: `shim/varmain/primitiv.py`)
- Mesh geometry kernel → Math shim: uses math helpers (evidence: `shim/p3dkernel.py`)
- HTTP server → Preview UI: serves UI (evidence: `server.py`)
- Render metadata → Preview UI: drives controls and overlays (evidence: `README.md`)
- GLB mesh → Preview UI: displays model (evidence: `README.md`)
- Part author → Render CLI: runs one-off render (evidence: `README.md`)
- Render CLI → Script renderer: calls (evidence: `render.py`)
