The Embroidermodder Reference Manual

Warning

This is very incomplete and cover hundreds of pages so it will take some time to complete. We hope to lift this warning by 2026.

The reference manual is a living document: if you need to refer to the document please use the current live version of the website or download the current printable version.

The documentation is based on all of the git repositories: when reporting issues in documention use the main repository (https://github.com/embroidermodder/embroidermodder). If there is reason to refer to manual specifically outside of the website repository use the abbreviation EMRM.

Contents:

• Introduction
  • Features
  • History
  • Credits for Embroidermodder 2, libembroidery and all other related code
  • The Embroidermodder Project and Team
• Changelog
  • From early alpha to beta
• CAD Commands
  • Overview
  • ADD-TO-SELECTION
  • ADD-TRIANGLE
  • ADD-VERTICAL-DIMENSION
  • ALERT
  • ALLOW-RUBBER
  • APPEND-HISTORY
  • CALCULATE-ANGLE
  • CALCULATE-DISTANCE
  • CHANGELOG
  • CLEAR-RUBBER
  • CLEAR-SELECTION
  • COPY
  • COPY-SELECTED
  • NEW
  • NIGHT
  • NUM-SELECTED
  • OPEN
  • PAN
  • PASTE
• print command
• print-area command
• zoom command
• layer-editor command
• make-layer-current command
• text-bold command
  • BREAK_AT_POINT
  • BREAK_2_POINTS
  • UNITS
  • DIVIDE
  • GRID
  • GRIPHOT
  • GRIPCOLOR
  • GRIPCOOL
  • GRIPSIZE
  • AREA
  • CHAMFER
  • PICK-ADD
  • FILLET
  • EXTEND
• perpendicular-distance command
• platform command
• preview-off command
• preview-on command
• QSNAP-X command
• QSNAP-Y command
• Tutorials
  • Modify Existing Designs
  • Create, Fit and Generate Designs
  • Scripting and Macros
• API
  • libembroidery
  • Geometry
  • Objects
• Development
  • Code Standards
  • Design
  • Ideas
  • Scripts
  • To Do
  • Command Prompt
  • Application
  • Data
  • Application
  • Application
  • Image Widget
  • Layer Manager
  • Main Window
  • MDI area
  • MDI Window
  • Saving
  • Preview Dialog
  • Property Editor
  • Script
  • Settings
  • Settings Dialog
  • Statusbar
  • Undo Commands
  • Undo Editor
  • View
• Geometry
  • Arcs
  • Base Object
  • Circle
  • Dimension Leader
  • Ellipse
  • Image
  • Line
  • Path
  • Point
  • Polygon
  • Polyline
  • Rectangle
  • Single-line Text
• Overview
• Introduction
  • Planning
  • Donations
• Introduction
  • Desktop
  • Dependencies and Build
  • Plans
  • Windows Specific Advice
  • Mobile
  • Documentation
  • Development
  • Current
  • Geometry
  • Kivy
  • Data/Code Seperation
  • The Settings Dictionary
  • Lisp Expression Support
  • SVG Icons
  • The Actions System
  • Accessibility
  • Sample Files
  • Design
  • Removed Elements
  • Qt and dependencies
  • Social Platform
  • Pandoc Documentation
  • OpenGL
  • Configuration Data Ideas
  • Distribution
  • Scripting Overhaul
  • Perennial Jobs
  • Developing for Android
  • Usage
  • To Flag
  • Circle Flag
  • Ellipse Flag
  • Line Flag
  • Polyline Flag
  • Polygon Flag
  • Satin Flag
  • Stitch Flag
  • Basic Test Suite
  • Full Test Suite
  • Ideas
  • Rendering system
  • Mobile Support: MobileViewer and iMobileViewer
  • Embroidermodder 2.0.0-alpha User Manual
  • Introduction
  • Basic Features
  • Advanced Features
  • Scripting Overhaul
  • Perennial Jobs
  • Developing for Android
  • Bibilography
  • Introduction
  • References
  • Planning
  • Format Support
  • Why this document
  • JSON data Ideas
  • Old action system notes
• Libembroidery v1.0-alpha
  • Demos
  • Build
  • Funding
  • Programming and Engineering
  • Writing
• Image Fitting
  • Contributing
  • Debug
  • Binary download
• The Embroidermodder Project and Team
• Changelog
• Online Viewer and Converter
• Credits
  • Contributors
  • Other Supported Thread Brands
  • Build and Install
• The Embroidermodder Project and Team
• Credits
• History
• Bibliography
• Index