InkStitch - installation

The educational technology and digital learning wiki
Jump to: navigation, search
Machine embroidery
Module: InkStitch
◀▬▬▶
to improve beginner
2020/10/08 ⚒⚒ 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

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

1.1 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. However, the latest 0.9 version also works fine, i.e. version 1.x of InkScape is not required as of fall 2020.

Download link (Windows, Mac, some Linux)

1.1.1 Windows

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 Edit->Preferences->Interface 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.

For older Inkscape versions and 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 Properties
  • Select Compatibility TAB and click on Change high DPI settings. Then, play with the settings. I use the following ones for my little DELL XPS 15 that has a 4K screen.
Fixing DPI resolution of the GUI on Windows 4K laptops

This can help with other programs too.

1.1.2 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

1.1.3 Mac

Installation on a Mac is more difficult .... (this section needs updating)

For example, read the instructions for the 0.92 download that works with older mac version. Installation requires prior installation of the Unix/Linux graphics layer X that Mac no longer supports by default.....

Catalina only works with Inkscape 1.0 (and the other way round) and Inkstitch 1.28 (may 2020) or better, but Apple added a feature that prohibits installation of software from people that do not pay developer fees. Workaround is to get the files via curl. That situation may change in the future (as of July 2020).

There are two basic steps

(1) Open a terminal. You can google for that, e.g. https://support.apple.com/guide/terminal/open-or-quit-terminal-apd5265185d-f365-44cb-8b09-71a064a42125/mac

(2) Read this https://inkstitch.org/docs/install/#macos

Copy line by line the commands in the black box of the above explanation (without the $, of just take the 3 lines from below) and hit the Enter button each time. Details:

Will put you into the extensions directory of inkscape:

cd ~/.config/inkscape/extensions

Will retrieve InkStitch so that Apple won't complain (note: this is for the current version and you may have to change the filename in the future):

curl -LJO https://github.com/inkstitch/inkstitch/releases/latest/download/inkstitch-refs-tags-v1.28.0-osx-en_US.zip

This will unzip the file (same procedure as in a normal install)

unzip inkstitch-refs-tags-v1.28.0-osx-en_US.zip

Else, ask anyone who knows how to talk to any computer via a terminal for help. The principle is same for Linux, windows, etc.

1.2 First time Ink/Stitch base installation

Ink/Stitch is the embroidery platform that you must install as Inkscape extension.

Download the Ink/Stitch extension files

  • Download the 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 ~/.config/inkscape/extensions
cd ~/.config/inkscape/extensions
tar zxf ~/Downloads/inkstitch-v1.0.0-Linux-x86_64.tar.gz

Development version may use *.zip format. so:

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 c:\users\__you__\AppData\Roaming\inkscape\extensions, e.g. c:\users\janet\AppData\Roaming\inkscape\extensions

If this does not work, check where the extension folder is in Inkscape: Edit->Preferences->System. 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"

1.3 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 official manual.

  • Go to Extensions > Ink/Stitch > Install add-ons for Inkscape
  • Click Install
  • Restart Inkscape

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

1.5 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

2 Configuration

2.1 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 -

2.2 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

2.3 Shortcuts

The official InkStitch documentaiton 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

2.4 Units and grids

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

3 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 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 - Daniel K. Schneider (talk) 11:22, 14 June 2018 (CEST)