ColorYourModel Wiki

This is the documentation hub for ColorYourModel (CYM) — a desktop app that turns white-model STLs into region-based, multi-colour 3MFs for multi-material 3D printing. When any document disagrees with the code, the source code is the authority.

How the docs work: markdown sources live in bak/ — a mirror of the docs/ tree (this file is bak/README.md). The committed *.html pages in docs/ are generated from them and are the official, readable archive. To edit documentation: change the md under bak/, run npm run docs:build, commit both. CI fails if the HTML drifts out of sync.

flowchart LR
    MD["bak/ markdown sources<br/>(editable)"] -->|"npm run docs:build"| HTML["docs/ HTML archives<br/>(official pages)"]
    HTML --> UG["User Guide"]
    HTML --> AL["Algorithms"]
    HTML --> TE["Technical"]
    HTML --> DV["Developer"]
    HTML --> CA["Cases"]

I want to…

Demo videos

Hosted as release assets — they play in place and never bloat the git clone.

Segmentation & export — seed-based fuse segmentation, then per-region 3MF export:

Painting tools — brush / spray / fill on the segmented model (details: Painting Tools):

3MF showcase — the exported multi-color 3MF loaded in Snapmaker Orca, regions mapped to filament assignments:

Document map

Numbered series (working documents, 中文)

Note: 07/08/09/10 are historical research records. For current behaviour, read the code (src-tauri/src/segment/) and the wiki pages under algorithms/.