InkStitch - installation: Difference between revisions

The educational technology and digital learning wiki
Jump to navigation Jump to search
mNo edit summary
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{stub}}
{{syllabus
{{syllabus
|is_part_of_syllabus=Machine embroidery
|is_part_of_syllabus=Machine embroidery
Line 14: Line 15:
|prequisite=InkScape
|prequisite=InkScape
}}
}}
[[fr:InkStitch - installation]]
== Installation ==
== Installation ==


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 Inkscape. See the next item.
This extension software was first tested with Ubuntu 16x and Windows 10 on May 3 2018. We managed to produce embroidery files for both Linux and Windows. As of 2022 Ink/Stitch has come a long way and can be used for a large variety of high-quality embroidery projects. Because Ink/Stitch is an extension of the [[Inkscape]] drawing program, you will have to install a recent version of Inkscape. See the next item.


=== Inkscape installation ===
=== Inkscape installation ===


Install [[Inkscape]] if it is not already installed on your computer. This software runs on Windows (all versions), MacOS, and Linux. We also recommend using the latest stable InkScape version, e.g. in May 2018 it was 0.92.3. So, before installing Ink/Stitch, '''upgrade''' your Inkscape first.
Install [[Inkscape]] if it is not already installed on your computer. This software runs on Windows (all versions), MacOS, and Linux. We also recommend using the latest stable InkScape version, e.g. in October 2020 it was 1.0.1. So, before installing Ink/Stitch, '''de-install''' your old Inkscape, then '''reinstall''' Inkscape first.  
 
'''Download link (Windows, Mac, some Linux)'''
'''Download link (Windows, Mac, some Linux)'''


* https://inkscape.org/en/ (home page of Inkscape, follow the download links)
* https://inkscape.org/en/ (home page of Inkscape, follow the download links)


==== Windows ====
Use the installer. For Windows 10/11, we recommend the 64bit exe version.
 
Take the desktop version, not the app store version, i.e. 64-bit-architecture
 
If you got a high resolution screen, then use the two following strategies:
* Within Inkscape, use <code>Edit->Preferences->Interface</code> to set icon sizes. I use "large"
* Also, in the same settings, adjust the zoom correction factor to make the display wysiwyg. I use 147. If you look at a drawing with 1:1 zoom, the dimensions in mm should be correct if you measure it with a ruler.
 
In '''addition''', for smaller screens (13 to 77'' as opposed to 32''), you may have to fix InkScape Properties through Windows
* Right-click on the InkScape shortcut on your desktop, and select <code>Properties</code>
* Select Compatibility TAB and click on <code>Change high DPI settings</code>. Then, play with the settings. I use the following ones for my little DELL XPS 15 that has a 4K screen.
 
[[file:Inkscape-high-DPI-setting.png|thumb|600px|none|Fixing DPI resolution of the GUI on Windows 4K laptops]]
 
This can help with other programs too.
 
==== 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
 
==== Mac ====
 
Installation on a Mac is more difficult since it requires installation of the Unix/Linux graphics layer X that Mac no longer supports by default.....
 
For example, read the [https://inkscape.org/release/inkscape-0.92.2/mac-os-x/107/dmg/dl/ instructions] for the 0.92 download. As of Jan 2019, version 0.93 is not yet supported.


=== First time Ink/Stitch base installation ===
=== First time Ink/Stitch base installation ===


Ink/Stitch is the embroidery platform that you must install as Inkscape extension.
Follow the instructions at http://inkstitch.org


'''Download the Ink/Stitch extension files'''
Once you installed the extension, restart Inkscape.
 
* 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>
Windows 10 trouble shooting
cd ~/.config/inkscape/extensions
tar zxf ~/Downloads/inkstitch-v1.0.0-Linux-x86_64.tar.gz


Development version may use *.zip format. so:
If you use a high level of Windows Defender protection, you may run into trouble and you may have to white list the extension directory.  
cd ~/.config/inkscape/extensions
unzip ~/distro.zip
 
'''Installation under Win 10'''
* Unhide the AppData directory (go to c:\users\__your_home__\, e.g. c:\users\janet
* Unzip in <code>c:\users\__you__\AppData\Roaming\inkscape\extensions</code>, e.g. <code>c:\users\janet\AppData\Roaming\inkscape\extensions</code>
 
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.
* Go to Start  > Settings  > Updates & Security  > Windows Security > Virus & threat protection > Virus & threat protection settings > Add or remove exclusions.


Line 90: Line 46:


=== Ink/Stitch add-ons installation (do not forget!) ===
=== Ink/Stitch add-ons installation (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 > Ink/Stitch > Install add-ons for Inkscape</code>
At some point you may want to install color palettes and extra lettering modules.
* Click <code>Install</code>
 
* Restart Inkscape
* Go to <code>Extensions > Ink/Stitch > </code>


=== Upgrades ===
=== 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.
In case you already have an old Ink/Stitch installation (prior to 2022), you will have to uninstall it manually, i.e. remove the files from the inkscape extension directory.


=== Language files ===
== Configuration ==


For people with system administration skills (only): Let us assume that you contribute to the translation effort at . You can test the translation file by replacing the "*.mo" file in your language directory.
=== Language ===


* Get a po file from a recent developer version, e.g. the [https://github.com/inkstitch/inkstitch/tree/master/translations master branch]
Language of downloaded Inkstitch files should match language of Inscape and language of OS.
* create a *.mo from a *.po file, under Linux do something like.
msgfmt -o inkstitch.mo messages_fr_FR.po
* Backup file inkscape/extensions/inkstitch/bin/locales/fr_FR directory/inkstitch.mo to inkstitch.mo.old
* Copy the file to the inkscape/extensions/inkstitch/bin/locales/fr_FR directory


== Configuration ==
Your can set the language in Inkscape: <code>Edit -> Preferences -> Interface </code>-


=== Show path outlines and directions ===
=== Show path outlines and directions ===
Line 115: Line 67:
In order to create satin columns it is crucial to be able to see the direction of path lines.
In order to create satin columns it is crucial to be able to see the direction of path lines.


To see directions, set <code>Show path direction direction on outline</code> in Edit -> Preferences -> Tools -> Node
To see directions, set <code>Show path direction on outline</code> in Edit -> Preferences -> Tools -> Node


=== Shortcuts ===
=== Shortcuts ===


The [https://inkstitch.org/tutorials/resources/beginner-video-tutorials/03-customize-transcript#shortcut-keys official InkStitch documentaiton] recommends defining shortcuts as follows:
The [https://inkstitch.org/tutorials/resources/beginner-video-tutorials/03-customize-transcript#shortcut-keys official InkStitch documentation] recommends defining shortcuts as follows:


Open Edit > Preferences. Then select Interface -> Keyboard Shortcuts
Open Edit > Preferences. Then select Interface -> Keyboard Shortcuts
Line 134: Line 86:
We suggest always working in mm (if you are familiar with metric units)
We suggest always working in mm (if you are familiar with metric units)


== Mediawiki compatibility of SVG files ==
== Advanced problems ==
 
=== Language files ===
 
For people with system administration skills (only): Let us assume that you contribute to the translation effort at . You can test the translation file by replacing the "*.mo" file in your language directory.
 
* Get a po file from a recent developer version, e.g. the [https://github.com/inkstitch/inkstitch/tree/master/translations master branch]
* create a *.mo from a *.po file, under Linux do something like.
msgfmt -o inkstitch.mo messages_fr_FR.po
* Backup file inkscape/extensions/inkstitch/bin/locales/fr_FR directory/inkstitch.mo to inkstitch.mo.old
* Copy the file to the inkscape/extensions/inkstitch/bin/locales/fr_FR directory
 
 
=== Mediawiki compatibility of SVG files ===


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.
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.
Line 144: Line 109:


'''(2) Modify the mediawiki code'''  
'''(2) Modify the mediawiki code'''  
* In file <code>./includes/upload/UploadBase.php</code> around line 1360, add the namespace, eg.
* In file <code>./includes/upload/UploadBase.php</code> around line 1620, add the namespace, eg.
  'http://creativecommons.org/ns#',
  'http://creativecommons.org/ns#',
  'http://inkstitch.org/namespace',
  'http://inkstitch.org/namespace',

Revision as of 12:24, 1 December 2022

Draft

Machine embroidery
Module: InkStitch
◀▬▬▶
to improve beginner
2022/12/01 ⚒⚒ 2018/06/05
Objectives
  • Understand the purpose of InkStitch
  • Install InkStitch
  • Run a InkStitch annotated SVG file
See also
Sub pages:

Objectives

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

See also

  • Quality: to improve
  • Difficulty: beginner

Installation

This extension software was first tested with Ubuntu 16x and Windows 10 on May 3 2018. We managed to produce embroidery files for both Linux and Windows. As of 2022 Ink/Stitch has come a long way and can be used for a large variety of high-quality embroidery projects. Because Ink/Stitch is an extension of the Inkscape drawing program, you will have to install a recent version of Inkscape. See the next item.

Inkscape installation

Install Inkscape if it is not already installed on your computer. This software runs on Windows (all versions), MacOS, and Linux. We also recommend using the latest stable InkScape version, e.g. in October 2020 it was 1.0.1. So, before installing Ink/Stitch, de-install your old Inkscape, then reinstall Inkscape first. Download link (Windows, Mac, some Linux)

Use the installer. For Windows 10/11, we recommend the 64bit exe version.

First time Ink/Stitch base installation

Follow the instructions at http://inkstitch.org

Once you installed the extension, restart Inkscape.

Windows 10 trouble shooting

If you use a 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"

Ink/Stitch add-ons installation (do not forget!)

At some point you may want to install color palettes and extra lettering modules.

  • Go to Extensions > Ink/Stitch >

Upgrades

In case you already have an old Ink/Stitch installation (prior to 2022), you will have to uninstall it manually, i.e. remove the files from the inkscape extension directory.

Configuration

Language

Language of downloaded Inkstitch files should match language of Inscape and language of OS.

Your can set the language in Inkscape: Edit -> Preferences -> Interface -

Show path outlines and directions

In order to create satin columns it is crucial to be able to see the direction of path lines.

To see directions, set Show path direction on outline in Edit -> Preferences -> Tools -> Node

Shortcuts

The official InkStitch documentation recommends defining shortcuts as follows:

Open Edit > Preferences. Then select Interface -> Keyboard Shortcuts

  1. Search for “params”. You will find it under Extensions. To its right, click into the field below the Shortcut column and enter Control + Shift + C.
  2. Search for “simulate” and enter Control + Shift + L
  3. Search “Reverse” (under Selection) and enter Control + R
  4. And finally Page down for “stack down” and Page up for “stack up”. The object at the bottom of the objects list (Object -> Objects) will stitch first.

The XML shortcuts sub page contains an extended list of shortcuts made by Laure Doisneau plus her explanations

Units and grids

We suggest always working in mm (if you are familiar with metric units)

Advanced problems

Language files

For people with system administration skills (only): Let us assume that you contribute to the translation effort at . You can test the translation file by replacing the "*.mo" file in your language directory.

  • Get a po file from a recent developer version, e.g. the master branch
  • create a *.mo from a *.po file, under Linux do something like.
msgfmt -o inkstitch.mo messages_fr_FR.po
  • Backup file inkscape/extensions/inkstitch/bin/locales/fr_FR directory/inkstitch.mo to inkstitch.mo.old
  • Copy the file to the inkscape/extensions/inkstitch/bin/locales/fr_FR directory


Mediawiki compatibility of SVG files

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 request at the wikimedia phabricator but don't know if it may interest a developer.

There are two workarounds:

(1) Fix the SVG file

  • 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

(2) Modify the mediawiki code

  • In file ./includes/upload/UploadBase.php around line 1620, 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 - Daniel K. Schneider (talk) 11:22, 14 June 2018 (CEST)