Skip to content

Documentation

WARNING: These are very incomplete and cover hundreds of pages so it will take some time to complete them. We hope to lift this warning by 2026.

These are living documents: if there's an error first check that it is present in the current live versions (the web links below) before reporting an error. Note that every manual has a shortcode EMRM, LEAPI etc.

When reporting issues, please quote the date of the copy you have like this "EMRM (26 May 2025)". They are housed in the repositories for each of the projects they refer to and are under the GNU Free Documentation License, the only gotcha is that the command line interface embroider is part of the libembroidery repository and doesn't have it's own.

Embroidermodder

Version: 2.0.0-alpha

License: Zlib

Embroidermodder Reference Manaul (EMRM)

Embroidermodder API Manual (EMAPI)

libembroidery

Version: 1.0.0-alpha

License: Zlib

For users of the libembroidery library, please use the developer manual.

Libembroidery API Manual (LEAPI)

embroider

Statuses are shared with libembroidery above.

Man page:

EmbroideryMobile

Version: 1.0.0-alpha

License: MIT

EmbroideryMobile Reference Manual (MOBRM)

EmbroideryMobile API Manual (MOBAPI)