InkStitch: Difference between revisions

The educational technology and digital learning wiki
Jump to navigation Jump to search
 
(226 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{stub}}
{{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'''.
* You can stitch areas, columns and lines
* All can be parametrized, including some underlay.
 
== Installation ==
 
This software was tested with Ubuntu 16x and Windows 10 on May 3 2018. We managed to get an embroidery file for both Linux and Windows.
 
* Download the [https://github.com/lexelby/inkstitch/releases/latest latest release]
* Gunzip in the personal extension folder of Inkscape.
 
'''Under Ubuntu'''
* Unzip to <code> ~/.config/inkscape/extensions</code>
cd ~/.config/inkscape/extensions
tar zxf ~/Downloads/inkstitch-v1.0.0-Linux-x86_64.tar.gz
 
'''Under Win 10'''
* Unhide the AppData directory (go to c:\users\__your_home__\, e.g. c:\users\janet
* 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
 
Once you installed the extension, restart Inkscape.
 
== Basic use of InkStitch ==
 
=== A first test ===
 
You can try to following steps in order to test the extension and to learn about basic functionality.
 
'''Step 1 - draw an object'''
 
Create an object, e.g. a circle. You can use both fill and stroke. Below is an example and its SVG code.
[[file:SVG-yellow-circle-stroke-fill.png|none|thumb|300px|A circle with a yellow fill and a blue stroke (border)]]
 
The SVG code defining the object looks like this, i.e. the circle is defined with the SVG circle tag.
<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)
[[file:Inkscape-092-XML-editor.png|800px|none|thunb|XML editor view of the circle]]
 
'''Step 2 - convert to path'''
 
* 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">
    <path
      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"
      id="path4147" />
</source>
 
Objects that are not of "Path" type, are ignored.
 
'''Step 3 - Parametrize''' (optional now)
 
* 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.
 
'''Step 4 - Create the Embroidery file'''
* 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.
 
'''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 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|thunb|XML editor view of the circle]]
 
=== Embroidery objects ===
 
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 (zizag)
 
== 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====
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.}}


This is not strictly needed, but you should take the reflex of creating layers into which you put different types of drawing objects.
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.}}


* Create a new layer and call it Areas
'''List of tutorials'''
* Select all colored areas and move into a new layer
* Rename the layer with the black "lines" in "Lines"


====Parametrize====
You also can use the navigation menu to the right


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.
* [[InkStitch - installation]]
* [[InkStitch - basic use‎‎]]
* [[InkStitch - satin columns‎]]
* [[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]]


* Hide the Layer called ''Lines''
'''Print version'''
* Open Extensions->Embroidery->Params. This will now allow to parametrize the Stitch Areas
* [[EduTech Wiki:Books/InkStitch]] (either as free PDF or as PediaPress book)
* 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====
'''Warnings''' and disclaimers:


* Show all layers you plan to embroider, e.g. here we got "Lines" and "Areas"
* '''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.
* Menu extensions -> embroidery -> embroider
* 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...
** 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] ]]
== Features ==


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.


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)
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.


[[file:inkstitch-imported-birds-4.jpg|800px|thumb|none|Simulation of embroidery]]
See also:
* [[Computerized embroidery]]
* [[Embroidery glossary]] and [[Concepts of computerized embroidery]]
* [[Computerized embroidery in education]]


=== Create borders with satin stitches ===
== Support groups ==


In order to get satin stitches we need to have strokes.
* 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
* [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 ?)


* Go back to an early version of the SVG file (after breaking apart)
== Events ==
* 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 ....


{|class="wikitable"
!Place/Date!!Status!!Event
|-
|Amsterdam, Monday, July 24, 2019|| [[image:080.svg]]||[[Machine_embroidery_in_education_workshop_(EdMedia2019)]] Short URL: https://edutechwiki.unige.ch/en/meew
|-
|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]
|-
|New York October 9. 2020 (demo)|| [[image:080.svg]]||
[[Computerized embroidery for identity building (fablearn2020)]] (http://edutechwiki.unige.ch/en/fablearn2020)
|}


== Links ==
== Copyright modification ==


* [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).

Latest revision as of 12:25, 8 October 2023

Machine embroidery
Module: InkStitch
▬▶
⚐ to improve ☸ beginner
⚒ 2023/10/08 ⚒⚒ 2018/06/05
Objectives
  • Understand the purpose of InkStitch
  • Install InkStitch
  • Run a InkStitch annotated SVG file
See also

Objectives

  • Understand the purpose of InkStitch
  • Install InkStitch
  • Run a InkStitch annotated SVG file

See also

  • Quality: to improve
  • Difficulty: beginner

[As of summer 2022, this documentation is outdated and requires some updating. Principles remain the same]

Introduction

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. - Daniel K. Schneider 20 July 2018

According to the extension page, “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.”

According to the project page, “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.”

List of tutorials

You also can use the navigation menu to the right

Print version

Warnings and disclaimers:

  • This documentation is not associated with the InkStitch project. Please also read the official documentation (including tutorials) 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...

Features

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.

As of December 16, 2018 the latest release was 1.21.0. We strongly encourage using the latest version and checking regularly for updates.

See also:

Support groups

  • Report technical problems as issues to the developers at Github. Do check first if there is already an open issue with the same problem
  • inkscape - inkstitch. Friendly and dynamic french group.
  • 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 ?)

Events

Place/Date Status Event
Amsterdam, Monday, July 24, 2019 080.svg Machine_embroidery_in_education_workshop_(EdMedia2019) Short URL: https://edutechwiki.unige.ch/en/meew
Dagstuhl October 29, 2018 Done Data visualization with machine embroidery (75 min workshop at the Dagstuhl Seminar 18441 on DataPhysicalization
New York October 9. 2020 (demo) 080.svg

Computerized embroidery for identity building (fablearn2020) (http://edutechwiki.unige.ch/en/fablearn2020)

Copyright modification

Contents of this page including pictures and SVG files are also available under the GNU Free Documentation License and the Attribution 4.0 International (CC BY 4.0) license.

The Inkstitch project can use any element (text fragments, SVG files, pictures) for the project's official docs without giving attribution (just copy and paste).

Retrieved from "https://edutechwiki.unige.ch/mediawiki/index.php?title=InkStitch&oldid=78224"