CrochetPARADE Remesher

Author: Svetlin Tassev

CrochetPARADE Remesher takes a 3D model (STL) and generates crochet instructions in the CrochetPARADE language that reproduce the model. The input is assumed to be a closed (watertight) surface, and the stitch plan is round-based only (no turning chains): the run starts from a seed (either a magic ring or a starting chain) and grows a stitched patch over the surface. For complicated shapes it may use multiple yarns and/or emit sewing edges where independently grown regions meet.

You can access CrochetPARADE Remesher through the CrochetPARADE website, or directly at: https://crochetparade.org/remesher/

What This Repo Contains

• Rust backend CLI (src/): core remeshing algorithm + CrochetPARADE pattern output.
• Desktop UI (ui/): Tauri app (includes CrochetPARADE validation in desktop mode).
• Website + WASM build (static bundle): browser UI with a WebAssembly backend.
• Documentation (backend_ui_platform_manual.md, config_groups_manual.md, architecture/*.dot): used to generate the in-app/web manual.

Quick Start

The detailed build matrix (Linux/macOS/Windows packaging, website bundle, etc.) lives in BUILD_AND_RUN.md.

Build everything (backend CLI, website bundle, desktop packages) in one command:

./scripts/build_all.sh

Desktop App (Tauri)

cargo build --release
cd ui
npm ci
npm run tauri dev

Website Bundle (Upload A Single Folder)

./scripts/build_web_bundle.sh

Upload website_bundle/ to any static web server (nginx/Apache/Caddy). Your server does not need Node.js.

If you ran ./scripts/build_all.sh instead, the same upload-ready web bundle is placed in dist/web/ (and website_bundle/ is removed to avoid duplication).

Backend CLI

cargo build --release
./target/release/crochet_remesh --help

License

GPL-3.0-or-later. See LICENCE.

Notes

• The web build omits CrochetPARADE validation (the validator depends on node/parse59.js).
• The in-app/web Help page is generated from repository docs and DOT diagrams and may contain mistakes; treat it as a guide, not a spec.