Sample files

Two real files written by StitchPencil, for implementers to test readers against. They are not synthetic fixtures: both are actual projects, with the irregularities that come with that.

The files

File	Size	Contents	Stitches	Colours
Cherry.hoop	72 KB	`manifest.json`, `document.json`, `plan.json`, `preview.png`	2 214	4
Japan.hoop	43 KB	`manifest.json`, `document.json`, `preview.png`	5 628	1

SHA-256 of the files as served:

b936db0c879257f62447323c2e4ce2d6baf553cbd69ba457d89da38eddce6f0f  Cherry.hoop
95605b720ef730344771bd6e55bd0c2e1f12328b20973ffa38786dd98c93b8b3  Japan.hoop

What each one exercises

Cherry.hoop is an exported file and carries plan.json. Start here if you are writing an exporter. It contains fill and satin objects, blend groups, multiple thread colours from a real catalogue (Madeira Polyneon), colour-change and trim commands, and all three stitch functions including travel. Its plan is also the file the numbers on the plan.json page come from — in particular the 2 223 array entries against 2 214 counted stitches.

Japan.hoop has no plan.json, because it is a library save rather than an export. That is not a defect in the sample; it is the case the specification requires you to handle, and a reader that assumes the entry is present will fail on it. Use it to test that path. It also carries a sashiko-patterned fill and a lettering group, so its document.json exercises parameter sub-objects a reader must skip over gracefully.

Between them they cover a file with a plan and a file without, one colour and several, and every geometry case except points.

Terms of use

The format is open: implement readers and writers freely, no permission needed, nothing to sign.

The designs in these two files are not. They are provided solely so that developers can test an implementation, and they remain the property of their author.

You may:

download them and open them in your own software,
use them while developing, testing and debugging a .hoop implementation,
include them in an automated test suite that stays inside your organisation.

You may not:

redistribute them, publish them, or bundle them with software, a library, a repository or a dataset,
sell them or include them in anything sold,
stitch them out for sale, or sell items made from them,
use them in marketing, on a product page, or as sample content in a shipped application,
create and distribute derivative designs based on them.

If you need a design you can ship, digitise your own — the format is open precisely so you can.

For anything not covered here, ask before assuming: hello@stitchpencil.app.