Metadata-Version: 2.3
Name: inksim
Version: 0.3.2
Summary: Interactive embroidery simulator
Author: InkSim contributors
License: GNU GENERAL PUBLIC LICENSE
         Version 3, 29 June 2007
         
         Copyright (c) 2026 InkSim contributors
         
         InkSim is free software: you can redistribute it and/or modify it under the
         terms of the GNU General Public License as published by the Free Software
         Foundation, either version 3 of the License, or (at your option) any later
         version.
         
         InkSim is distributed in the hope that it will be useful, but WITHOUT ANY
         WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
         A PARTICULAR PURPOSE. See the GNU General Public License for more details.
         
         The full text of the GNU General Public License is available at
         <https://www.gnu.org/licenses/>.
         
         SPDX-License-Identifier: GPL-3.0-or-later
Requires-Dist: numba
Requires-Dist: numpy
Requires-Dist: pystitch
Requires-Dist: pyside6-essentials
Requires-Dist: pyopengl
Requires-Dist: tomli-w
Requires-Dist: filelock
Requires-Python: >=3.12
Project-URL: Homepage, https://github.com/oorteo/inksim
Project-URL: Repository, https://github.com/oorteo/inksim.git
Project-URL: Issues, https://github.com/oorteo/inksim/issues
Description-Content-Type: text/markdown

# InkSim

InkSim is a standalone interactive embroidery simulator and preview renderer.
It opens embroidery files, displays their stitch sequence, and lets the user
inspect or replay the design before production.

The viewer now includes an **OpenGL textured renderer** that draws stitches as
realistic ribbon quads with normal-mapped thread and Blinn-Phong lighting. Press
`Z` in the viewer to toggle between the CPU and GPU renderers. The GPU renderer
requires **OpenGL 3.3**; older systems and virtual machines fall back to the
CPU raster renderer automatically.

<p align="center">
  <img src="https://raw.githubusercontent.com/oorteo/inksim/main/docs/assets/images/InkSim_colorful_small.png" alt="InkSim preview" width="350">
</p>

InkSim is experimental software provided for development and testing.

## Installation

Install the published PyPI package with `uv`:

```bash
uv tool install inksim
```

Then run it directly from your shell:

```bash
inksim design.pes
```

Use `inksim-gui design.pes` to launch without a console window. The command
names behave consistently on Windows, macOS, and Linux.

See [installation and running](https://github.com/oorteo/inksim/blob/main/docs/installation.md) for `pip`/virtual-environment
installation and developer setup.

## Quick start

```bash
inksim
inksim design.pes
inksim design.pes --play
```

## Documentation

- [Installation and running](https://github.com/oorteo/inksim/blob/main/docs/installation.md)
- [User guide](https://github.com/oorteo/inksim/blob/main/docs/user-guide.md)
- [Application interconnect](https://github.com/oorteo/inksim/blob/main/docs/interconnect.md)
- [Contributing](https://github.com/oorteo/inksim/blob/main/CONTRIBUTING.md)

## Background

The idea behind this tool dates back to 2013 with an experimental C++/Qt project
called Orca, which originally explored graph algorithms for Inkscape on Linux
before turning into a digitizer and stitch viewer. Here is an old recording of
that early prototype in action:

[Orca viewer demo](https://www.youtube.com/watch?v=VKle5ApsMnA)

**InkSim** is a fresh, standalone rewrite of that viewer concept -- built from
scratch using Python, PySide6, and Numba. The main goal is to provide a fast,
lightweight way to preview embroidery files without heavy overhead.

It was built to fill a small workflow gap, and it's shared with the hope that
others in the Inkscape and Ink/Stitch community might find it helpful as well.

Special thanks to the Ink/Stitch team and community for keeping open-source
embroidery alive and inspiring.

## License

InkSim is released under the [GNU General Public License v3 or later](https://github.com/oorteo/inksim/blob/main/LICENSE).
