InkStitch: Difference between revisions

The educational technology and digital learning wiki
Jump to navigation Jump to search
mNo edit summary
 
(41 intermediate revisions by 3 users not shown)
Line 3: Line 3:
|is_part_of_module=InkStitch
|is_part_of_module=InkStitch
|do_not_show_sub_page=No
|do_not_show_sub_page=No
|page_next=InkStitch - basic use
|page_next=InkStitch - installation
|status=to improve
|status=to improve
|last_modification=2018/06/05
|last_modification=2018/06/05
Line 9: Line 9:
Run a InkStitch annotated SVG file
Run a InkStitch annotated SVG file
|difficulty=beginner
|difficulty=beginner
|see_also=Computerized embroidery,
InkStitch - basic use
|cat_syllabus=InkStitch
|prequisite=InkScape
|prequisite=InkScape
|see_also=Computerized embroidery
|cat_syllabus=InkStitch
}}
}}
[[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 and machine embroidery files. <nowiki>Ink/Stitch is in our opinion the best open source and free embroidery digitizing software - ~~~~</nowiki>
'''[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


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


According to the [https://inkstitch.org/ project page], {{quoatation|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.}}
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.}}


'''List of tutorials'''
'''List of tutorials'''
Line 25: Line 28:
You also can use the navigation menu to the right
You also can use the navigation menu to the right


* [[InkStitch - installation]]
* [[InkStitch - basic use‎‎]]
* [[InkStitch - basic use‎‎]]
* [[InkStitch - satin columns‎]]
* [[InkStitch - satin columns‎]]
* [[InkStitch - manual stitches]]
* [[InkStitch - tips and trouble shooting‎‎]]
* [[InkStitch - tips and trouble shooting‎‎]]
* [[InkStitch - from satin columns to fills with satin borders]]
* [[InkStitch - from satin columns to fills with satin borders]]
* [[InkStitch - stitch files from Noun Project icons‎‎]]
* [[InkStitch - stitch files from Noun Project icons‎‎]]
* [[InkStitch - emoji embroidery]]
* [[InkStitch - embroidery logos]]
* [[InkStitch - embroidery logos]]
* [[InkStitch - create stitch files from hand drawings‎‎ ]]
* [[InkStitch - create stitch files from hand drawings‎‎ ]]
Line 35: Line 41:
* [[InkStitch - QR code embroidery]]
* [[InkStitch - QR code embroidery]]
* [[InkStitch - lettering]]
* [[InkStitch - lettering]]
* [[InkStitch - design letters]]
* [[InkStitch - Geneva-simple typefaces]]
* [[InkStitch - fills with programmable stitches]]
* [[InkStitch - data visualization]]
* [[InkStitch - hotfix]]


'''Print version'''
'''Print version'''
* [[EduTech Wiki:Books/InkStitch]] (either as free PDF or as PediaPress book)
* [[EduTech Wiki:Books/InkStitch]] (either as free PDF or as PediaPress book)


'''Warnings''' and disclaimer:  
'''Warnings''' and disclaimers:  


This page is not associated with the InkStitch project. Please also read the documentation (including tutorials) [https://inkstitch.org/ in the official site]. We just made a little tutorial while we were learning and testing this extension.
* '''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...


== Features ==
== Features ==
Line 49: Line 61:
* 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 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).
* 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.
* InkStitch also supports thread color and project management.


As of June 8, 2018 the [https://github.com/lexelby/inkstitch/releases/latest latest release] was 1.8.2. We strongly encourage using the latest version and checking regularly for updates.  
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.  


See also:
See also:
Line 58: Line 71:
* [[Computerized embroidery in education]]
* [[Computerized embroidery in education]]


== Installation ==
== Support groups ==
 
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. Since Ink/Stitch is an extension of the Inkscape drawing program, you will have to install a recent version of this firs. See the next item.
 
=== Inkscape installation ===
 
Install [[Inkscape]] if needed. This software runs on Windows (all version), MacOS, and Linux. It also is recommended to use the latest stable InkScape version, e.g. in May 2018 it was 0.92.3. So, before installing Ink/Stitch, '''upgrade''' your Inkscape first,
 
'''Download link (Windows, Mac, some Linux)'''
 
* https://inkscape.org/en/ (home page of Inkscape, follow the download links)
 
'''Windows'''
 
Take the desktop version, not the app store version, i.e. 64-bit-architecture
 
'''Ubuntu'''
 
Ubuntu users may have to use Inkscape's official Personal Package Archive (PPA). E.g., by default, Ubuntu 16.04LTS distributes an old 0.91 version that lacks the object browser. So, open a terminal and add the repository, then upgrade
sudo add-apt-repository ppa:inkscape.dev/stable
sudo apt-get update
sudo apt upgrade
 
=== First time Ink/Stitch installation ===
 
'''Download the Ink/Stitch extension files'''
 
* Download the [https://github.com/lexelby/inkstitch/releases/latest latest release]
* De-archive in the personal extension folder of Inkscape. Make sure that the files extract into the extensions folder, e.g. you should see some *.inx files, inkstitch.py, plus an inkstitch directory.
 
'''Installation under Ubuntu'''
 
* Extract files to <code> ~/.config/inkscape/extensions</code>
cd ~/.config/inkscape/extensions
tar zxf ~/Downloads/inkstitch-v1.0.0-Linux-x86_64.tar.gz
 
'''Installation 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 <code>Inkscape: Edit->Preferences->System</code>. You also can change the directory, e.g. if you have trouble making the AppData directory visible or if Windows Defender makes your life difficult.
 
Once you installed the extension, restart Inkscape.
 
If you use a very high level of Windows Defender protection, you may run into trouble and you may have to white list the extension directory.
* Go to Start  > Settings  > Updates & Security  > Windows Security > Virus & threat protection > Virus & threat protection settings > Add or remove exclusions.
 
Alternatively, lower the protection threshold (and then avoid downloading random bullshit). In the windows Defender Security Center:
* Set App&Browser control -> Check apps and files to "Warn"
* Set Virus&threat protection -> Virus & threat protection settings -> Controlled Folder access to "Off"
 
==== Installing add-ons (do not forget!) ====
There are some add-ons, e.g. installing trim/stop commands, color palettes and visualization of embroidery commands that require copying files. Read more in the [https://inkstitch.org/docs/addons/ official manual].
* Go to <code>Extensions > Embroidery > Install add-ons for Inkscape</code>
* Click <code>Install</code>
* Restart Inkscape
 
=== Upgrades ===
 
You may have to delete the old extension files first. The download page will tell you so if needed. Go to the extension directory and kill each embroidery* and inkstitch* file. Then, proceed as above. But normally, we repeat, you will not have to do that. Just unzip the archive to extension folder again.
 
=== Mediawiki compatibility ===
 
For now, some InkStitch files (e.g. the ones that include previewing information) cannot be imported into a Mediawiki because Mediawikis only allow whitelisted namespace. I filed a [https://phabricator.wikimedia.org/T197595 request] at the wikimedia phabricator but don't know if it may interest a developer.
 
There are two workarounds:


'''(1) Fix the SVG file'''
* 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
* Remove the namespace elements with a text editor from the SVG, i.e. the declaration in the beginning and the section at the end of the metadata
* [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 ?)


'''(2) Modify the mediawiki code'''
== Events ==
* In file <code>./includes/upload/UploadBase.php</code> around line 1360, add the namespace, eg.
'http://creativecommons.org/ns#',
'http://inkstitch.org/namespace',
'http://inkscape.sourceforge.net/dtd/sodipodi-0.dtd',


I will try to have this included in future mediawiki versions - [[User:Daniel K. Schneider|Daniel K. Schneider]] ([[User talk:Daniel K. Schneider|talk]]) 11:22, 14 June 2018 (CEST)
{|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)
|}


== Copyright modification ==
== Copyright modification ==

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"