Download
Specification (PDF)
Section titled “Specification (PDF)”hoop-format-v1.pdf — 13 pages, A4.
The same material as these pages in one file: container, manifest.json,
plan.json, document.json, reader requirements, versioning, and the sample
files with their terms of use.
The PDF is generated from this site, not maintained beside it, so the two cannot drift apart through neglect. If they ever disagree anyway, the site is the current version.
Sample files
Section titled “Sample files”Two real projects to test an implementation against. Read the terms of use before downloading — the format is free to implement, the designs in these files are not free to redistribute.
- Cherry.hoop — 72 KB, exported, includes
plan.json - Japan.hoop — 43 KB, library save, no
plan.json
Checksums and a description of what each file exercises are on the sample files page.
Reference implementation
Section titled “Reference implementation”The reader and writer that produce these files are part of the StitchPencil
source: ZipArchive.swift and HoopFile.swift under
Packages/Core/Sources/DocumentKit/. They show one conforming approach,
including every limit in Reader requirements and the tests
that hold them in place.
Packages
Section titled “Packages”Swift and C# packages are planned, so that implementers do not have to write a reader before they can look at a file.
They do not exist yet, and this page will list them when they do. Until then the specification is complete enough to implement from: the container is ZIP, the payload is JSON, and nothing in either requires a particular language or a library from us.
Questions
Section titled “Questions”hello@stitchpencil.app — for the format, the samples, or a discrepancy between a real file and anything written here.