Wiki

Documentation for Needlework Studio - user guides, setup instructions, and deployment.

This wiki covers all features. Some features require the Full Version.

User Guide

First-time setup, interface overview, and a quick walkthrough of the core features.

Browse DMC and Anchor threads, track ownership and skein quantities, and search by number or name.

Create patterns from images or from scratch using drawing tools, stitch types, mirror modes, and more.

Turn any photo into a counted cross-stitch chart with adjustable grid size, color count, and pixel art mode.

View patterns in chart or thread mode with symbol overlays, zoom controls, and per-color progress tracking.

Import patterns from PDF, JSON, and OXS formats. Export to PDF with cover sheets, SVG, and more.

Organize your pattern library with search, sort, tags, batch actions, duplication, and materials calculation.

Estimate the floss, skeins, and fabric a project needs, with a per-color shopping list and matching fabric pieces.

Choose from preset themes, create custom color palettes, import/export themes, and switch between light and dark mode.

Set up bidirectional sync between the desktop app and your self-hosted server.

Open Needlework Studio on a phone or tablet over your Wi-Fi. Browse, edit, and save patterns for offline use.

Download the desktop app for macOS, Windows, or Linux. Or self-host with Docker or a manual Python setup.

Manage users, configure application settings, back up data, and monitor the server.

Production deployment with reverse proxies, HTTPS, environment variables, and scaling considerations.

Answers to common questions about installation, import issues, the editor, sync problems, and browser compatibility.