# 🧢 StitchMath Core (`stitchmath-core`) [![Official Website](https://img.shields.io/badge/Official_Website-StitchMath.com-10b981?style=for-the-badge)](https://stitchmath.com) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge)](https://opensource.org/licenses/MIT) [![TypeScript Ready](https://img.shields.io/badge/TypeScript-Ready-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](src/index.d.ts) ### πŸ† Featured & Approved On [![Product Hunt](https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=1145651&theme=light&t=1778629436677)](https://www.producthunt.com/products/stitchmath?embed=true&utm_source=badge-featured&utm_medium=badge&utm_campaign=badge-stitchmath)    [![Approved on SaaSHub](https://cdn-b.saashub.com/img/badges/approved-color.png?v=1)](https://www.saashub.com/stitchmath?utm_source=badge&utm_campaign=badge&utm_content=stitchmath&badge_variant=color&badge_kind=approved) --- **StitchMath Core** is the open-source mathematical calculation engine and standardized dataset repository by **[StitchMath.com](https://stitchmath.com)**. Built for developers, designers, and craft bloggers, this library eliminates guesswork in knitting and crochet by providing robust algorithms for gauge sizing, even row decreases, yarn WPI classification, and international needle size conversions. > [!IMPORTANT] > **🌟 Need the Full Interactive Web Suite & AI Assistant?** > This repository contains our lightweight algorithmic SDK and public datasets. For the complete visual experienceβ€”including **20+ interactive calculators**, our custom **Sweater Pattern Generator**, and the **AI Pattern Assistant**β€”visit the official web application at **[https://stitchmath.com](https://stitchmath.com)**. --- ## πŸ†š Open-Source SDK vs. StitchMath.com Platform | Feature | `stitchmath-core` (This Repo) | [StitchMath.com Official Platform](https://stitchmath.com) | | :--- | :---: | :---: | | **Core Math Algorithms (JS/TS SDK)** | βœ… Yes (Raw Functions) | βœ… Yes (Visual & Interactive) | | **Standardized JSON Datasets** | βœ… Yes (Needles, Yarn WPI, Blankets) | βœ… Yes (Interactive Tables) | | **20+ Visual Web Calculators** | ❌ | βœ… Yes (Gauge, Socks, Sleeves, etc.) | | **AI Pattern Assistant** | ❌ | βœ… Yes (Instant AI Fitment Solving) | | **Custom Sweater Pattern Generator** | ❌ | βœ… Yes (Dynamic Garment Sizing) | | **Printable Guides & Swatch Tutorials**| ❌ | βœ… Yes (Comprehensive Reference Hub) | πŸ‘‰ **[Experience all interactive tools for free on StitchMath.com β†’](https://stitchmath.com/calculators/)** --- ## πŸ“¦ Features & Datasets - πŸ“ **Gauge Conversion Algorithm**: Adjust pattern stitch counts precisely based on actual swatch measurements. - βž• **Increase & Decrease Spacing**: Automatically calculate even stitch distribution and generate row work instructions (`k2tog`, `m1`). - βš–οΈ **Curated JSON Datasets**: Machine-readable, standardized JSON files for: - **Needle Sizes** (`data/needle-sizes.json`): Comprehensive US, UK/Canadian, and Metric (mm) conversions. - **Yarn Weights & WPI** (`data/yarn-weights.json`): Standard 0–6 classifications, Wraps Per Inch ranges, and UK/Aus Ply equivalents. - **Standard Dimensions** (`data/blanket-sizes.json`): Standard sizes for throws, baby blankets, scarves, and socks. - 🌐 **Unit Agnostic**: Seamless bidirectional conversion between US Imperial (`in`, `oz`, `yd`) and Metric (`cm`, `g`, `m`). - πŸ”· **Full TypeScript Support**: Bundled with comprehensive type declarations (`src/index.d.ts`). --- ## πŸ€– Model Context Protocol (MCP) Server StitchMath Core now includes a built-in MCP server, allowing AI assistants like Claude Desktop and Cursor to perform 100% accurate knitting math, gauge conversions, and sizing calculations directly within your chats. ### Available AI Tools The server exposes the following tools to LLMs: - `calculate_gauge`: Adjust stitch counts precisely based on actual swatch measurements. - `calculate_even_spacing`: Calculate evenly spaced increases or decreases across a row. - `convert_needle_size`: Convert between US, UK, and Metric needle sizes. - `convert_units`: Convert Imperial / Metric dimensions. - `get_blanket_cast_on`: Get recommended cast-on stitches for standard blanket sizes. ### Installing in Claude Desktop Add the following to your `claude_desktop_config.json`: ```json { "mcpServers": { "stitchmath": { "command": "npx", "args": ["-y", "stitchmath-core"] } } } ``` --- ## πŸš€ Quick Start (For Developers) ### Installation You can install `stitchmath-core` via npm or yarn into your Node.js, React, Vue, or React Native projects: ```bash npm install stitchmath-core ``` ### Usage Examples #### 1. Calculate Gauge Adjustment When a pattern calls for 20 stitches over 4 inches, but your actual swatch is 22 stitches over 4 inches: ```javascript const { calculateGauge } = require('stitchmath-core'); // How many stitches should you cast on for a 36-inch bust? const castOnStitches = calculateGauge(22, 4, 36); console.log(`Cast on ${castOnStitches} stitches`); // Output: Cast on 198 stitches ``` #### 2. Calculate Even Decreases Across a Row When shaping a sleeve or hat crown and you need to decrease 8 stitches evenly across 80 total stitches: ```javascript const { calculateEvenSpacing } = require('stitchmath-core'); const shaping = calculateEvenSpacing(80, 8, true); // true = decrease console.log(shaping.instructions); // Output: Work 9 sts, then [k2tog (or decrease), work 9 sts] across the row. ``` #### 3. Lookup Needle Sizes & Conversions ```javascript const { convertNeedleSize } = require('stitchmath-core'); const sizeInfo = convertNeedleSize('8', 'us'); console.log(sizeInfo); // Output: { mm: '5.0', us: '8', uk: '6' } ``` --- ## πŸ“Š Standardized JSON Datasets You can import our curated industry datasets directly without importing the calculation functions: ```javascript // Import needle chart dataset directly const needleChart = require('stitchmath-core/data/needle-sizes.json'); // Import yarn weight classifications and WPI standards const yarnChart = require('stitchmath-core/data/yarn-weights.json'); // Import standard blanket and scarf dimensions const blanketDimensions = require('stitchmath-core/data/blanket-sizes.json'); ``` --- ## 🌐 Embedding StitchMath on Your Blog or Website Are you a craft blogger, pattern designer, or knitting tutorial author? We encourage you to reference and embed **StitchMath** in your articles! To add a direct link or badge to the official calculation suite on your website, simply copy the following HTML snippet: ```html 🧢 Powered by StitchMath Calculators β†’ ``` By linking to **[StitchMath.com](https://stitchmath.com)**, you help your readers calculate exact gauge swatches and sizing without leaving their browser! --- ## 🀝 Contributing We welcome contributions from fellow developers, knitters, and crocheters! 1. Fork the repository. 2. Create your feature branch (`git checkout -b feature/amazing-calculation`). 3. Commit your changes (`git commit -m 'Add new sock heel shaping formula'`). 4. Push to the branch (`git push origin feature/amazing-calculation`). 5. Open a Pull Request. --- ## πŸ“„ License This repository is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for details. ---

Made with ❀️ by the craft tech team at StitchMath.com.
Making knitting and crochet math simple for crafters everywhere.