|
|
(211 intermediate revisions by 3 users not shown) |
Line 1: |
Line 1: |
| {{incomplete}} | | {{syllabus |
| | | |is_part_of_syllabus=Machine embroidery |
| | |is_part_of_module=InkStitch |
| | |do_not_show_sub_page=No |
| | |page_next=InkStitch - installation |
| | |status=to improve |
| | |last_modification=2018/06/05 |
| | |objective=Understand the purpose of InkStitch, Install InkStitch, |
| | Run a InkStitch annotated SVG file |
| | |difficulty=beginner |
| | |see_also=Computerized embroidery, |
| | InkStitch - basic use |
| | |cat_syllabus=InkStitch |
| | |prequisite=InkScape |
| | }} |
| | [[fr:inkStitch]] |
| | [As of summer 2022, this documentation is outdated and requires some updating. Principles remain the same] |
| == Introduction == | | == Introduction == |
|
| |
|
| '''[https://inkstitch.org Ink/Stitch]''' is an [[Inkscape]] extension for designing machine embroidery patterns. According to the [https://inkscape.org/en/~wwderw/%E2%98%85inkstitch-embroidery-extension extension page], {{quotation|Select objects that you want to apply embroidery properties and using the extension, set the parameters for the desired object(s). Once all desired objects have embroidery properties, use the extension to generate the necessary stitch file.}} | | '''[https://inkstitch.org Ink/Stitch]''' is an [[Inkscape]] extension for designing machine embroidery patterns and machine embroidery files. Ink/Stitch is in our opinion the best open source and free embroidery digitizing software. It offers good basic functionality and can be used in schools to teach both vector graphics and design. - [[User:Daniel K. Schneider|Daniel K. Schneider]] 20 July 2018 |
|
| |
|
| As far as we can tell without much testing (May 3 2018) this extension seems to be the '''first usable open source program that allows creating embroidery files within an open source drawing tool'''.
| | According to the [https://inkscape.org/en/~wwderw/%E2%98%85inkstitch-embroidery-extension extension page], {{quotation|Select objects that you want to apply embroidery properties and using the extension, set the parameters for the desired object(s). Once all desired objects have embroidery properties, use the extension to generate the necessary stitch file.}} |
| * You can stitch areas, columns and lines
| |
| * All can be parametrized, including some underlay.
| |
|
| |
|
| == Installation ==
| | According to the [https://inkstitch.org/ project page], {{quotation|Ink/Stitch aims to be a full-fledged embroidery digitizing platform based entirely on free, open source software. Our goal is to be approachable for hobbyists while also providing the power needed by professional digitizers.}} |
|
| |
|
| This extension software was tested with Ubuntu 16x and Windows 10 on May 3 2018. We managed to produce embroidery files for both Linux and Windows.
| | '''List of tutorials''' |
|
| |
|
| * Download the [https://github.com/lexelby/inkstitch/releases/latest latest release]
| | You also can use the navigation menu to the right |
| * De-archive in the personal extension folder of Inkscape.
| |
|
| |
|
| '''Under Ubuntu'''
| | * [[InkStitch - installation]] |
| * Extract files to <code> ~/.config/inkscape/extensions</code> | | * [[InkStitch - basic use]] |
| cd ~/.config/inkscape/extensions
| | * [[InkStitch - satin columns]] |
| tar zxf ~/Downloads/inkstitch-v1.0.0-Linux-x86_64.tar.gz
| | * [[InkStitch - manual stitches]] |
| | * [[InkStitch - tips and trouble shooting]] |
| | * [[InkStitch - from satin columns to fills with satin borders]] |
| | * [[InkStitch - stitch files from Noun Project icons]] |
| | * [[InkStitch - emoji embroidery]] |
| | * [[InkStitch - embroidery logos]] |
| | * [[InkStitch - create stitch files from hand drawings ]] |
| | * [[InkStitch - embroidery patch]] |
| | * [[InkStitch - QR code embroidery]] |
| | * [[InkStitch - lettering]] |
| | * [[InkStitch - design letters]] |
| | * [[InkStitch - Geneva-simple typefaces]] |
| | * [[InkStitch - fills with programmable stitches]] |
| | * [[InkStitch - data visualization]] |
| | * [[InkStitch - hotfix]] |
|
| |
|
| '''Under Win 10''' | | '''Print version''' |
| * Unhide the AppData directory (go to c:\users\__your_home__\, e.g. c:\users\janet | | * [[EduTech Wiki:Books/InkStitch]] (either as free PDF or as PediaPress book) |
| * Unzip in c:\users\__you__\AppData\Roaming\inkscape\extensions
| |
|
| |
|
| If this does not work, check where the extension folder is in Inkscape: Edit->Preferences->System
| | '''Warnings''' and disclaimers: |
|
| |
|
| Once you installed the extension, restart Inkscape.
| | * '''This documentation is not associated with the InkStitch project'''. Please '''also read the official documentation''' (including tutorials) [https://inkstitch.org/ in the official site]. We just made a little tutorial while we were learning and testing this extension. |
| | * Some screenshots were made from early versions. Since the project took off during late sprint/summer 2018, changes were made to the interface and others may follow. Please take this into account. Over time, we will adapt most of the documentation... |
|
| |
|
| == Basic use of InkStitch == | | == Features == |
|
| |
|
| You can try to following steps in order to test the extension and to learn about basic functionality.
| | As far as we can tell, the Ink/Stitch extension is the '''first usable open source program that allows creating embroidery files within an open source drawing tool'''. Summarizing: |
| | * Ink/Stitch allows creating stitch files from particular SVG drawings, i.e. so-called path. Any SVG object can be translated into a path object. |
| | * SVG fills can translate to filled stitch areas (i.e. tatami stitches), SVG strokes can translate to zigzag (simple satin) and lines. Finally, there is a mechanism to create satin columns from paths that include two sub-path lines. |
| | * SVG path objects can be parametrized for all of these four stitch types (filled areas, simple zigzags, complex satin zigzags, or lines). Various underlays can be configured, e.g. satin stitches can have three sorts (a center line, border lines or a zigzag). |
| | * Most embroidery formats can be imported, reused and adapted using Inkscape's path tool (F2). |
| | * InkStitch also supports thread color and project management. |
|
| |
|
| ===Step 1 - draw an object===
| | As of December 16, 2018 the [https://github.com/lexelby/inkstitch/releases/latest latest release] was 1.21.0. We strongly encourage using the latest version and checking regularly for updates. |
|
| |
|
| Create an object, e.g. a circle. You can use both fill and stroke. Below is an example and its SVG code.
| | See also: |
| [[file:SVG-yellow-circle-stroke-fill.png|none|thumb|300px|A circle with a yellow fill and a blue stroke (border)]] | | * [[Computerized embroidery]] |
| | * [[Embroidery glossary]] and [[Concepts of computerized embroidery]] |
| | * [[Computerized embroidery in education]] |
|
| |
|
| The SVG code defining the object uses the SVG <code>circle</code> tag.
| | == Support groups == |
| <source lang="XML">
| |
| <circle
| |
| style="opacity:1;fill:#ffff00;fill-opacity:1;stroke:#0000ff;stroke-width:5.92615652;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
| |
| id="path4147"
| |
| cx="123.99713"
| |
| cy="650.45123"
| |
| r="106.87944" />
| |
| </source>
| |
|
| |
|
| You can open the builtin XML tree editor if you want to check the code (CTRL-SHIFT-X)
| | * Report technical problems [https://github.com/inkstitch/inkstitch/issues as issues] to the developers at Github. Do check first if there is already an open issue with the same problem |
| [[file:Inkscape-092-XML-editor.png|800px|none|thunb|XML editor view of the circle]] | | * [https://www.facebook.com/groups/inkstitchfrance inkscape - inkstitch]. Friendly and dynamic french group. |
| | * [https://www.facebook.com/groups/945979722406352/ InkScape to Ink/Stitch Enthusiast Group] Unfriendly American group (e.g. links to tutorials outside facebook are not allowed, who wants to create content on facebook ?) |
|
| |
|
| ===Step 2 - convert to path=== | | == Events == |
| Transform '''all objects''' you want to stitch to '''paths:'''
| |
| * Select all object(s), e.g. hit CTRL+A
| |
| * Menu Path->Object to Path
| |
| An [https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths SVG Path] includes both numbers representing positions and letters representing drawing and moving operations, including Bezier curves and Arcs. You do not need to understand how this works. Only make sure that all objects you plan to stitch are represented by a <code>path</code>. To check this, open the XML editor, then click on the object in the workspace. The XML code will be highlighted.
| |
|
| |
|
| <source lang="XML">
| | {|class="wikitable" |
| <path
| | !Place/Date!!Status!!Event |
| style="opacity:1;fill:#ffff00;fill-opacity:1;stroke:#0000ff;stroke-width:5.92615652;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
| | |- |
| d="M 230.87657,650.45123 A 106.87944,106.87944 0 0 1 123.99713,757.33067 106.87944,106.87944 0 0 1 17.117691,650.45123 106.87944,106.87944 0 0 1 123.99713,543.57179 106.87944,106.87944 0 0 1 230.87657,650.45123 Z"
| | |Amsterdam, Monday, July 24, 2019|| [[image:080.svg]]||[[Machine_embroidery_in_education_workshop_(EdMedia2019)]] Short URL: https://edutechwiki.unige.ch/en/meew |
| id="path4147" />
| |
| </source>
| |
| | |
| Objects that are not of "Path" type, are ignored.
| |
| | |
| === Step 3 - Parametrize ===
| |
| | |
| In menu Extensions -> Embroider -> Select Params and play with them. There are actually quite a lot compared to other SVG to embroidery translators.
| |
| | |
| For now, we just suggest accepting the defaults. We shall explain parametrization in the next section.
| |
| | |
| === Step 4 - Create the Embroidery file===
| |
| | |
| You can either create a stitch file for a selection of objects or for all path objects. To create an embroidery file for the whole design:
| |
| * Click into some empty space (to deselect)
| |
| * Menu Extensions -> Embroider -> Embroidery
| |
| * Select the format of your machine. In case you are unhappy with the result, select a widely used format such as Tajima (DST) and then use a free translator to convert to your proprietary format.
| |
| * Type a directory name where you can find your files, e.g. c:\users\__you__\Desktop on windows or /home/schneide/schneide/embroidery/inkstitch under Linux. The file will remember this information.
| |
| | |
| You can skip the next step providing some technical details about how embroidery objects are represented in Inkscape.
| |
| | |
| ===Step 4 - Inspect in Inkscape===
| |
| | |
| You now also will have a new layer that includes the Stitch Plan, i.e. the objects that have been exported as Stitch objects. You can check this to visualize the points that will be stitched. Alternatively you could use an [[Computerized_embroidery#Free_converter_tools_and_other_utilities|embroidery viewer]]
| |
| | |
| In order to examine the Stitch points
| |
| * select the Stitch Plan layer and hide the others (this should be done automatically after using the ''Embroidery'' operation).
| |
| * Select the ''Edit Path tool'' in Inkscape
| |
| * Zoom in
| |
| | |
| [[file:Inkstitch-stitch-plan.png|800px|none|InkStitch, Stitch Plan. This information will be used to create the embroidery files ]] | |
| | |
| If you look at the SVG code, you can see that it is now annotated with stitching information. The new layer contains two huge path objects - one for the border and one for the fill - that define all the points to be stitched, plus the stroke color for both. Since the circle was split into two objects with strokes, there is of course no more fill.
| |
| | |
| [[file:Inkstitch-stitch-plan2.png|800px|none|thunb|InkStitch, SVG code for the Stitch Plan]]
| |
| | |
| == Parametrizing Objects for embroidery ==
| |
| | |
| InkStitch can produces three kinds of stitch packs:
| |
| * Areas
| |
| * Satin colums
| |
| * Lines
| |
| | |
| If we understood right:
| |
| * Fills can only translate to Areas
| |
| * Strokes translate to lines or satin columns (zigzag)
| |
| | |
| | |
| === Embroidery Areas ===
| |
| | |
| SVG fills are translated to areas filled with a simple linear pattern that can have an underlay.
| |
| | |
| In order to parametrize a fill:
| |
| * Select an object that has a fill
| |
| * Menu Extensions -> Embroidery -> Params
| |
| | |
| You will see a little popup that say "Params working, please wait". Just move it out of the way and ignore it. Now look at the <code>Embroidery Params</code> popup window. It will have three tabs:
| |
| * Auto-Fill: Try to change the fill angle. You can also can add STOP and Trim code if they are supported by the stitch file.
| |
| * AutoFill Underlay: Add an underlay, i.e. stitches that will be stitched underneath the pattern. This will add some stability and also a little 3D effect. Do not make it too dense.
| |
| | |
| [[file: Inkstitch-stitch-params-1.png|thumb|none|800px|Parametrizing SVG fill objects]] | |
| | |
| | |
| === Strokes and satin paths ===
| |
| | |
| SVG fills are translated to areas filled with a simple linear pattern that can have an underlay. If you open again the Param popup (Menu Extensions -> Embroidery -> Params), you will see different tabs:
| |
| * Stroke
| |
| * Sating Column
| |
| * Center-Walk Underlay
| |
| * Contour Underlay
| |
| * Zig-Zag Underlay
| |
| | |
| By default, there will be a Satin stitch for a fat stroke, as shown in the following screenshot.
| |
| * Small zigzags are difficult to stitch since they pull and distrort the tissue a lot. If you can, go for lines between 2 and 3 mm. Otherwise, use less density.
| |
| | |
| [[file: Inkstitch-stitch-params-2.png|thumb|none|800px|Parametrizing SVG stroke objects]]
| |
| | |
| === Fills and strokes ===
| |
| | |
| Objects that have both fill and stroke will allow parametrization of both, i.e. the param popup will present the combined tabs from the area and stroke parameters.
| |
| | |
| [[file: Inkstitch-stitch-params-3.png|thumb|none|800px|Parametrizing SVG objects with stroke and fill]]
| |
| | |
| === Summary ===
| |
| | |
| InkStitch provides good basic functionality for creating Stitch files with Inkscape.
| |
| | |
| The stitch file in Tajima DST format was accepted by our multi-needle machine, but I did not stitch the design since it is not really interesting.
| |
| {|
| |
| |- | | |- |
| |[[file: Inkstitch-stitch-params-result.jpg|thumb|none|400px|Simulation of the Embroidery]] | | |Dagstuhl October 29, 2018||Done||[[Data visualization with machine embroidery]] (75 min workshop at the [https://www.dagstuhl.de/18441 Dagstuhl Seminar 18441 on DataPhysicalization] |
| |[[file: Inkstitch-stitch-params-result-brother.jpg|thumb|none|400px|Stitch file accepted by our [[Brother PR1050X]]]]
| | |- |
| | |New York October 9. 2020 (demo)|| [[image:080.svg]]|| |
| | [[Computerized embroidery for identity building (fablearn2020)]] (http://edutechwiki.unige.ch/en/fablearn2020) |
| |} | | |} |
|
| |
|
| Note: Colors are wrong since the thread palette used in the viewer of Stitch Era and the embroidery machine are different from the default. Thread palettes are difficult to understand...
| | == Copyright modification == |
| | |
| == Trouble == | |
| | |
| === Satin stitch param combination makes the script crash ===
| |
| | |
| As of May 2018 (InkStitch version 1.7.1 / Inkscape v. 0.91) some combinations of parameters can lead to a crash of the script, i.e. the embroidery will not be generated. You will have to remove the InkStitch specific properties from the SVG code to fix that. This can be done for example by saving the file as simple SVG. It is better to test the embroidery for each parameter change and save the file under a different version number if things go well. This way you only have to undo the last changes or copy/paste the older object that was still working.
| |
| | |
| Exemple error trace:
| |
| <source>
| |
| Traceback (most recent call last):
| |
| File "embroider.py", line 108, in <module>
| |
| File "inkscape-0.92.2/share/extensions/inkex.py", line 283, in affect
| |
| errormsg(_("No matching node for expression: %s") % path)
| |
| File "embroider.py", line 97, in effect
| |
|
| |
| File "inkstitch/extensions.py", line 195, in elements_to_patches
| |
| File "inkstitch/elements/element.py", line 244, in embroider
| |
| File "inkstitch/elements/satin_column.py", line 401, in to_patches
| |
| File "inkstitch/elements/satin_column.py", line 370, in do_satin
| |
| File "inkstitch/elements/satin_column.py", line 254, in walk_paths
| |
| File "site-packages/backports/functools_lru_cache.py", line 113, in wrapper
| |
| File "inkstitch/elements/satin_column.py", line 101, in flattened_beziers
| |
| File "inkstitch/elements/satin_column.py", line 128, in flatten_beziers_with_rungs
| |
| File "site-packages/shapely/ops.py", line 464, in split
| |
| ValueError: Splitting a LineString with a GeometryCollection is not supported
| |
| [9557] Failed to execute script embroider
| |
| </source>
| |
| | |
| === Cannot generate simple lines ===
| |
| | |
| Maybe I missed something here ....
| |
| | |
| == Birds example ==
| |
| | |
| Let's create an embroidery from complex SVG paths.
| |
| | |
| Below are notes taken while I learn. I am aware that these are not good enough for beginners - [[User:Daniel K. Schneider|Daniel K. Schneider]] ([[User talk:Daniel K. Schneider|talk]]) 16:23, 4 May 2018 (CEST)
| |
| | |
| '''Get some artwork'''
| |
| | |
| * Get four birds from the noun project (become a member if you want to download and reuse objects without having to use them under their free CC license. I got 4 birds from the [https://thenounproject.com/liv_iko/collection/birds/?i=898697 Bird] collection by Liv Iko
| |
| * Pick the ones you like.
| |
| * Download as SVG !!
| |
| * If you are a non-member, remove the text with the CC license, i.e. edit each file in Inkscape, but make sure to cite the author properly if you publish your embroidery.
| |
| | |
| If you are unable to get this done, you can start from our own example, but do not publish it on any website without giving credit to Liv Iko.
| |
| | |
| === Embroidery with area patters ===
| |
| | |
| After downloading some icons from the nouproject:
| |
| * File -> Import; Select the four SVG files
| |
| | |
| After arranging the four drawings, you could see something like this:
| |
| [[file:inkstitch-birds-0.svg|800px|thumb|none|SVG file with four imported icons from Liv Iko's [https://thenounproject.com/liv_iko/collection/birds/?i=898697 Bird] collection. Click twice to get the SVG source]]
| |
| * If you do not download from the Noun Project, you can our example above. Make sure to click twice in order to get the SVG file until you see just the drawing, then "save the page as". Also, do not forget to credit the original author.
| |
| * Save the file, e.g. call it birds0.svg
| |
| | |
| ====Arrange position and size====
| |
| * Arrange the designs, e.g., on a bottom line and also adjust the size so that the embroidery will fit into you hoop.
| |
| * Each of the birds is now a single SVG path. These are not yet suitable for a nice colorful embroidery. We will have to break them apart
| |
| [[file:inkstitch-imported-birds-1.png|800px|thumb|none|Each bird is a a single path]]
| |
| * Save the file, e.g. call it birds1.svg
| |
| * Again, you could directly take the [https://edutechwiki.unige.ch/mediawiki/images/8/8a/Inkstitch-birds-0.svg SVG file] directly from this wiki.
| |
| | |
| ====Break path apart====
| |
| * Select all
| |
| * Menu: Path -> Break Apart
| |
| | |
| You now should see four piles of black objects.
| |
| [[file:inkstitch-birds-2.svg|800px|thumb|none|SVG file with four imported icons from Liv Iko's [https://thenounproject.com/liv_iko/collection/birds/?i=898697 Bird] collection]]
| |
| | |
| Again, you could download the [https://edutechwiki.unige.ch/mediawiki/images/5/5c/Inkstitch-birds-2.svg SVG source]
| |
| | |
| ====Colorize====
| |
| | |
| The result are layered "path" objects composed of fills that you now should color a bit. For each object, including the large black backgrounds:
| |
| * Add a fill color
| |
| * Remove the stroke color
| |
| * The easiest way of doing this is to open the "Fill and Strokes" panel, then the XML Editor (Shift+Control+X)
| |
| * click on each path object of the XML editor and then define a fill color and remove the stroke color if there is one.
| |
| [[file:inkstitch-imported-birds-2.png|800px|thumb|none|Color each object. You can use a thread palette for that]]
| |
| | |
| ====Simplify====
| |
| | |
| Currently we have up to three layers, which is too much for stitching.
| |
| * We now use the difference operator to subtract an element from the element underneath.
| |
| * Copy a smaller area that sits on top of a larger area and move it outside the graphic
| |
| * Shift-select the larger (black) area and shift-select the area that sits on top
| |
| * Menu: Path->Difference or hit CTRL+-
| |
| * Now you should see a hole in the bigger black area. Move the the save smaller area in place. Increase its size a bit so that it overlaps.
| |
| [[file:inkstitch-imported-birds-3.png|800px|thumb|none|Color each object. You the difference operator to subtract a smaller area from an underlying area]]
| |
| | |
| You also may want to cleanup a bit. In Inkscape, click on File->Clean up document
| |
| | |
| ====Create two layers====
| |
| | |
| This is not strictly needed, but you should take the reflex of creating layers into which you put different types of drawing objects.
| |
| | |
| * Create a new layer and call it Areas
| |
| * Select all colored areas and move into a new layer
| |
| * Rename the layer with the black "lines" in "Lines"
| |
| | |
| ====Parametrize====
| |
| | |
| In your SVG drawings you only got so-called fills. The plugin will translate these into areas filled with linear motif. You can change the angle and the Stitch length for now.
| |
| | |
| * Hide the Layer called ''Lines''
| |
| * Open Extensions->Embroidery->Params. This will now allow to parametrize the Stitch Areas
| |
| * Add STOP and TRIM if you got a multi-needle machine
| |
| * Change default values or just Apply and Quit (we did not change anything else here)
| |
| * Do the same for the Lines layer, show it and hide the Area layer
| |
| | |
| ====Create the embroidery====
| |
| | |
| * Show all layers you plan to embroider, e.g. here we got "Lines" and "Areas"
| |
| * Menu extensions -> embroidery -> embroider
| |
| ** Select the machine format. As of May 2018, the PES file is incorrect, use DST format which Brother also can stitch.
| |
| | |
| [[file:Inkstitch-birds-4.svg|800px|none|thumb| SVG birds file with two layers, [https://edutechwiki.unige.ch/mediawiki/images/8/84/Inkstitch-birds-4.svg downloadable] ]]
| |
| | |
| | |
| The simulated result now looks like this (DST gets the colors wrong, but that's not a real issue since most people do not have a sixteen needle machine with the good threads already installed)
| |
| | |
| [[file:inkstitch-imported-birds-4.jpg|800px|thumb|none|Simulation of embroidery]]
| |
| | |
| === Create borders with satin stitches ===
| |
| | |
| In order to get satin stitches we need to have strokes.
| |
| | |
| * Go back to an early version of the SVG file (after breaking apart)
| |
| * Select the object for which you need satin borders
| |
| * Create an inset: Menu Path -> Inset (this will shave of space from the border)
| |
| * Add a stroke
| |
| * Remove the fill
| |
| * Copy the object (strokes) to the other drawing ....
| |
| | |
| | |
| == Links ==
| |
|
| |
|
| * [https://inkstitch.org Ink/Stitch] (home page)
| | Contents of this page including pictures and SVG files are also available under the [http://en.wikipedia.org/wiki/Wikipedia:Text_of_the_GNU_Free_Documentation_License GNU Free Documentation License] and the [https://creativecommons.org/licenses/by/4.0/ Attribution 4.0 International (CC BY 4.0)] license. |
| * [https://github.com/lexelby/inkstitch Ink/Stitch] Githup directory
| |
| * [https://www.youtube.com/watch?v=FsbD8mnSAO4 Inkstitch Intro Video] (Youtube)
| |
|
| |
|
| [[category: computerized embroidery]] | | The [https://github.com/lexelby/inkstitch/i Inkstitch project] can use any element (text fragments, SVG files, pictures) for the project's official docs without giving attribution (just copy and paste). |