# jobinjia/shuimo-core architecture

> Architecture diagram of the GitHub repository jobinjia/shuimo-core, 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/jobinjia/shuimo-core
- Repository: https://github.com/jobinjia/shuimo-core

## Overview

shuimo-core is a deterministic procedural Chinese-ink illustration library that produces SVG strings or Canvas output. Its main workflow takes seeded painting options, plans a landscape composition, generates visual elements and paper texture, and returns artwork; separate APIs generate flowers and seal stamps. The graph also captures the documented stamp-v2 font-worker option and xuan-paper worker. Relationships involving unsampled composition and illustration modules are limited to explicit README or SOURCE INDEX evidence.

Main entry points: [`packages/core/src/elements/natural/Mount.ts`](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/elements/natural/Mount.ts) (Landscape elements), [`packages/core/src/composition/SceneManager.ts`](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/composition/SceneManager.ts) (Scene manager), [`packages/core/src/drawing/stampV2/seal.ts`](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/stampV2/seal.ts) (Stamp v2 engine), [`packages/core/src/drawing/Stroke.ts`](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/Stroke.ts) (Ink strokes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_composition["Painting composition"]
  node_painting["Painting API"]
  node_scene["Scene manager<br/>[SceneManager.ts]"]
  node_planner["Mount planner<br/>[MountPlanner.ts]"]
end

subgraph group_artwork["Artwork generation"]
  node_mountains["Landscape elements<br/>[Mount.ts]"]
  node_water_arch["Water and boats<br/>[Water.ts]"]
  node_natural["Natural elements"]
  node_flowers["Flower generators<br/>[FlowerCanvas.ts]"]
  node_inkmount["Ink mountains<br/>[InkMount.ts]"]
  node_stroke["Ink strokes<br/>[Stroke.ts]"]
  node_texture["Brush texture<br/>[Texture.ts]"]
end

subgraph group_stamps["Seal stamps"]
  node_stampv2["Stamp v2 engine<br/>[seal.ts]"]
  node_glyphs["Glyph layout<br/>[glyphs.ts]"]
  node_svgstamp["Stamp SVG renderer<br/>[svg.ts]"]
  node_glyphpath["Font path utilities<br/>[glyphPath.ts]"]
  node_fontclient["Font worker client<br/>[glyphFontClient.ts]"]
  node_fontworker["Font worker<br/>[glyphFontWorker.ts]"]
end

subgraph group_paper["Xuan paper"]
  node_paper["Paper rendering"]
  node_paperworker["Paper worker<br/>[worker.ts]"]
  node_paperwasm["Paper tone WASM<br/>[paper-tone-wasm.ts]"]
end

subgraph group_foundation["Shared primitives"]
  node_geometry["Geometry<br/>[Vector2.ts]"]
  node_noise["Noise functions"]
  node_random["Seeded random<br/>[prng.ts]"]
  node_svg["SVG utilities<br/>[svg.ts]"]
end

node_caller(("Library user"))

node_caller -->|"configures"| node_painting
node_painting -.->|"generates"| node_scene
node_scene -->|"plans"| node_planner
node_scene -->|"renders"| node_mountains
node_scene -->|"renders"| node_water_arch
node_scene -->|"samples"| node_random
node_caller -->|"requests seal"| node_stampv2
node_stampv2 -->|"lays out"| node_glyphs
node_stampv2 -->|"renders"| node_svgstamp
node_stampv2 -->|"uses geometry"| node_geometry
node_stampv2 -->|"seeds"| node_random
node_glyphs -->|"uses paths"| node_glyphpath
node_glyphs -->|"requests fonts"| node_fontclient
node_glyphs -->|"lays out"| node_geometry
node_fontclient -->|"posts requests"| node_fontworker
node_fontworker -->|"normalizes paths"| node_glyphpath
node_caller -->|"requests paper"| node_paper
node_paperworker -->|"computes tone"| node_paperwasm
node_caller -->|"generates flowers"| node_flowers
node_caller -->|"generates mountains"| node_inkmount
node_mountains -->|"draws strokes"| node_stroke
node_mountains -->|"adds texture"| node_texture
node_mountains -->|"samples noise"| node_noise
node_mountains -->|"uses randomness"| node_random
node_water_arch -->|"draws strokes"| node_stroke
node_water_arch -->|"adds texture"| node_texture
node_inkmount -->|"uses vectors"| node_geometry
node_inkmount -->|"samples noise"| node_noise
node_stroke -->|"uses geometry"| node_geometry
node_stroke -->|"uses noise"| node_noise
node_texture -->|"uses strokes"| node_stroke
node_texture -->|"uses noise"| node_noise
node_mountains -->|"emits SVG"| node_svg
node_water_arch -->|"emits SVG"| node_svg

click node_painting "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/composition/PaintingGenerator.ts"
click node_scene "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/composition/SceneManager.ts"
click node_planner "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/composition/MountPlanner.ts"
click node_mountains "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/elements/natural/Mount.ts"
click node_water_arch "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/elements/natural/Water.ts"
click node_natural "https://github.com/jobinjia/shuimo-core/tree/main/packages/core/src/elements/natural"
click node_flowers "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/FlowerCanvas.ts"
click node_inkmount "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/ink-mount/InkMount.ts"
click node_stroke "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/Stroke.ts"
click node_texture "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/Texture.ts"
click node_stampv2 "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/stampV2/seal.ts"
click node_glyphs "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/stampV2/text/glyphs.ts"
click node_svgstamp "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/stampV2/render/svg.ts"
click node_glyphpath "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/internal/glyphPath.ts"
click node_fontclient "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/internal/glyphFontClient.ts"
click node_fontworker "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/internal/glyphFontWorker.ts"
click node_paper "https://github.com/jobinjia/shuimo-core/tree/main/packages/core/src/elements/natural/xuan-paper"
click node_paperworker "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/elements/natural/xuan-paper/worker.ts"
click node_paperwasm "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/elements/natural/xuan-paper/paper-tone-wasm.ts"
click node_geometry "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/foundation/geometry/Vector2.ts"
click node_noise "https://github.com/jobinjia/shuimo-core/tree/main/packages/core/src/foundation/noise"
click node_random "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/foundation/random/prng.ts"
click node_svg "https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/utils/svg.ts"

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_painting,node_scene,node_planner,node_caller toneBlue
class node_mountains,node_water_arch,node_natural,node_flowers,node_inkmount,node_stroke,node_texture toneAmber
class node_stampv2,node_glyphs,node_svgstamp,node_glyphpath,node_fontclient,node_fontworker toneMint
class node_paper,node_paperworker,node_paperwasm toneRose
class node_geometry,node_noise,node_random,node_svg toneIndigo
```

## Components

### Painting composition

- [Painting API](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/composition/PaintingGenerator.ts): `packages/core/src/composition/PaintingGenerator.ts`
- [Scene manager](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/composition/SceneManager.ts): `packages/core/src/composition/SceneManager.ts`
- [Mount planner](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/composition/MountPlanner.ts): `packages/core/src/composition/MountPlanner.ts`

### Artwork generation

- [Landscape elements](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/elements/natural/Mount.ts): `packages/core/src/elements/natural/Mount.ts`
- [Water and boats](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/elements/natural/Water.ts): `packages/core/src/elements/natural/Water.ts`
- [Natural elements](https://github.com/jobinjia/shuimo-core/tree/main/packages/core/src/elements/natural): `packages/core/src/elements/natural`
- [Flower generators](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/FlowerCanvas.ts): `packages/core/src/drawing/FlowerCanvas.ts`
- [Ink mountains](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/ink-mount/InkMount.ts): `packages/core/src/drawing/ink-mount/InkMount.ts`
- [Ink strokes](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/Stroke.ts): `packages/core/src/drawing/Stroke.ts`
- [Brush texture](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/Texture.ts): `packages/core/src/drawing/Texture.ts`

### Seal stamps

- [Stamp v2 engine](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/stampV2/seal.ts): `packages/core/src/drawing/stampV2/seal.ts`
- [Glyph layout](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/stampV2/text/glyphs.ts): `packages/core/src/drawing/stampV2/text/glyphs.ts`
- [Stamp SVG renderer](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/stampV2/render/svg.ts): `packages/core/src/drawing/stampV2/render/svg.ts`
- [Font path utilities](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/internal/glyphPath.ts): `packages/core/src/drawing/internal/glyphPath.ts`
- [Font worker client](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/internal/glyphFontClient.ts): `packages/core/src/drawing/internal/glyphFontClient.ts`
- [Font worker](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/drawing/internal/glyphFontWorker.ts): `packages/core/src/drawing/internal/glyphFontWorker.ts`

### Xuan paper

- [Paper rendering](https://github.com/jobinjia/shuimo-core/tree/main/packages/core/src/elements/natural/xuan-paper): `packages/core/src/elements/natural/xuan-paper`
- [Paper worker](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/elements/natural/xuan-paper/worker.ts): `packages/core/src/elements/natural/xuan-paper/worker.ts`
- [Paper tone WASM](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/elements/natural/xuan-paper/paper-tone-wasm.ts): `packages/core/src/elements/natural/xuan-paper/paper-tone-wasm.ts`

### Shared primitives

- [Geometry](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/foundation/geometry/Vector2.ts): `packages/core/src/foundation/geometry/Vector2.ts`
- [Noise functions](https://github.com/jobinjia/shuimo-core/tree/main/packages/core/src/foundation/noise): `packages/core/src/foundation/noise`
- [Seeded random](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/foundation/random/prng.ts): `packages/core/src/foundation/random/prng.ts`
- [SVG utilities](https://github.com/jobinjia/shuimo-core/blob/main/packages/core/src/utils/svg.ts): `packages/core/src/utils/svg.ts`

### Other components

- **Library user**

## Connections

- Library user → Painting API: configures (evidence: `README.md`)
- Painting API → Scene manager: generates (evidence: `packages/core/src/composition/SceneManager.ts`)
- Scene manager → Mount planner: plans (evidence: `packages/core/src/composition/SceneManager.ts`)
- Scene manager → Landscape elements: renders (evidence: `packages/core/src/composition/SceneManager.ts`)
- Scene manager → Water and boats: renders (evidence: `packages/core/src/composition/SceneManager.ts`)
- Scene manager → Seeded random: samples (evidence: `packages/core/src/composition/SceneManager.ts`)
- Library user → Stamp v2 engine: requests seal (evidence: `README.md`)
- Stamp v2 engine → Glyph layout: lays out (evidence: `packages/core/src/drawing/stampV2/seal.ts`)
- Stamp v2 engine → Stamp SVG renderer: renders (evidence: `packages/core/src/drawing/stampV2/seal.ts`)
- Stamp v2 engine → Geometry: uses geometry (evidence: `packages/core/src/drawing/stampV2/seal.ts`)
- Stamp v2 engine → Seeded random: seeds (evidence: `packages/core/src/drawing/stampV2/seal.ts`)
- Glyph layout → Font path utilities: uses paths (evidence: `packages/core/src/drawing/stampV2/text/glyphs.ts`)
- Glyph layout → Font worker client: requests fonts (evidence: `packages/core/src/drawing/stampV2/text/glyphs.ts`)
- Glyph layout → Geometry: lays out (evidence: `packages/core/src/drawing/stampV2/text/glyphs.ts`)
- Font worker client → Font worker: posts requests (evidence: `packages/core/src/drawing/internal/glyphFontClient.ts`)
- Font worker → Font path utilities: normalizes paths (evidence: `packages/core/src/drawing/internal/glyphFontWorker.ts`)
- Library user → Paper rendering: requests paper (evidence: `README.md`)
- Paper worker → Paper tone WASM: computes tone (evidence: `packages/core/src/elements/natural/xuan-paper/worker.ts`)
- Library user → Flower generators: generates flowers (evidence: `README.md`)
- Library user → Ink mountains: generates mountains (evidence: `README.md`)
- Landscape elements → Ink strokes: draws strokes (evidence: `packages/core/src/elements/natural/Mount.ts`)
- Landscape elements → Brush texture: adds texture (evidence: `packages/core/src/elements/natural/Mount.ts`)
- Landscape elements → Noise functions: samples noise (evidence: `packages/core/src/elements/natural/Mount.ts`)
- Landscape elements → Seeded random: uses randomness (evidence: `packages/core/src/elements/natural/Mount.ts`)
- Water and boats → Ink strokes: draws strokes
- Water and boats → Brush texture: adds texture
- Ink mountains → Geometry: uses vectors
- Ink mountains → Noise functions: samples noise
- Ink strokes → Geometry: uses geometry (evidence: `packages/core/src/drawing/Stroke.ts`)
- Ink strokes → Noise functions: uses noise (evidence: `packages/core/src/drawing/Stroke.ts`)
- Brush texture → Ink strokes: uses strokes (evidence: `packages/core/src/drawing/Texture.ts`)
- Brush texture → Noise functions: uses noise (evidence: `packages/core/src/drawing/Texture.ts`)
- Landscape elements → SVG utilities: emits SVG (evidence: `packages/core/src/elements/natural/Mount.ts`)
- Water and boats → SVG utilities: emits SVG
