From ab8c87928b39e7874c09a75b2f9badd3a46719b2 Mon Sep 17 00:00:00 2001
From: Kaalleen <36401965+kaalleen@users.noreply.github.com>
Date: Fri, 24 Jun 2022 17:11:52 +0200
Subject: Update pyembroidery (#1683)

Embroidery formats (read)
.hus: Husqvarna Embroidery Format
.zhs: Zeng Hsing Embroidery Format

Color formats (read & write)
.col : Color format.
.edr : Color format.
.inf : Color format.

Stitch formats (read & write)
.pmv : Brother Stitch Format.

Image (write)
.png : Portable Network Graphic (line art)

G-Code
The export file format is not .txt anymore but .gcode

Bug fixes
---
 templates/apply_threadlist.xml    | 36 +++++++++++++++++++++++++++---------
 templates/output_params_gcode.xml | 39 +++++++++++++++++++++++++++++++++++++++
 templates/output_params_txt.xml   | 39 ---------------------------------------
 templates/zip.xml                 |  4 ++--
 4 files changed, 68 insertions(+), 50 deletions(-)
 create mode 100644 templates/output_params_gcode.xml
 delete mode 100644 templates/output_params_txt.xml

(limited to 'templates')

diff --git a/templates/apply_threadlist.xml b/templates/apply_threadlist.xml
index 58776cb5..303cb793 100644
--- a/templates/apply_threadlist.xml
+++ b/templates/apply_threadlist.xml
@@ -3,15 +3,33 @@
     <name>Apply Threadlist</name>
     <id>org.inkstitch.apply_threadlist</id>
     <param name="extension" type="string" gui-hidden="true">apply_threadlist</param>
-    <param name="filepath" type="path" gui-text="Choose file" mode="file" filetypes="txt"/>
-    <param name="method" type="optiongroup" gui-text="Choose method">
-       <option value="1">Apply Ink/Stitch threadlist</option>
-       <option value="2">Apply other threadlist*</option>
-    </param>
-    <param name="palette" type="enum" gui-text="*Choose color palette">
-    {%- for item in threadcatalog %}
-       <item value="{{ item }}">{{ item }}</item>
-    {%- endfor %}
+    <param name="options" type="notebook">
+      <page name="options" gui-text="Options">
+        <param name="filepath" type="path" gui-text="Choose file" mode="file" filetypes="txt,edr,col,inf"/>
+        <param name="method" type="optiongroup" gui-text="Choose method">
+           <option value="1">Apply Ink/Stitch threadlist</option>
+           <option value="2">Apply other threadlist*</option>
+        </param>
+        <param name="palette" type="enum" gui-text="*Choose color palette">
+        {%- for item in threadcatalog %}
+           <item value="{{ item }}">{{ item }}</item>
+        {%- endfor %}
+        </param>
+      </page>
+      <page name="info" gui-text="Help">
+        <label appearance="header">This extension applies colors from a color file to the objects in this document.</label>
+        <label>COL, INF, EDR</label>
+        <label indent="2">Select the file and apply. The chosen method is not important for these file types.</label>
+        <spacer />
+        <label>TXT</label>
+        <label indent="2">Import an Ink/Stitch threadlist file (created through the zip export option).</label>
+        <spacer />
+        <label indent="2">Import any other Threadlist file in txt format. Ink/Stitch will try to match the colors to the selected thread palette.
+                          The objects in this document will be colored accordingly if color matching has been successful.</label>
+        <spacer />
+        <label>Get more information on our website</label>
+        <label appearance="url">https://inkstitch.org/docs/thread-color/#apply-threadlist</label>
+      </page>
     </param>
     <effect>
         <object-type>all</object-type>
diff --git a/templates/output_params_gcode.xml b/templates/output_params_gcode.xml
new file mode 100644
index 00000000..97e6cacf
--- /dev/null
+++ b/templates/output_params_gcode.xml
@@ -0,0 +1,39 @@
+    {# these parameters are for g-code files (*.txt) #}
+<param type="notebook" name="gcode-settings">
+    <page name="embroidery" gui-text="Coordinate Settings">
+        <param name="flip_x" type="boolean" gui-text="negate X coordinate values" gui-description="Negate x coordinates">false</param>
+        <param name="flip_y" type="boolean" gui-text="negate Y coordinate values" gui-description="Negate y coordinates">false</param>
+        <param type="optiongroup" name="alternate_z" gui-text="Z coordinate value" gui-description="Either alternate Z value between 0 and 1 or travel custom value.">
+           <option value="true">alternate Z value</option>
+           <option value="false">Z travel per stitch</option>
+        </param>
+        <param name="stitch_z_travel" type="float" gui-text="Z travel per stitch"
+            gui-description='increment z coordinate by this amount per stitch if "Z travel per stitch" is enabled' min="0" max="999">5.0</param>
+    </page>
+    <page name="custom-commands" gui-text="Custom Commands">
+        <param name="custom_stitch" type="string" appearance="multiline" gui-text="STITCH"
+            gui-description="Use '%X' for x-coordinate. Use '%Y' for y-coordinate and '%Z' for z-coordinate."></param>
+        <param name="custom_color_change" type="string" appearance="multiline" gui-text="COLOR CHANGE"
+            gui-description="Leave empty to use default value. Use 'none' to remove."></param>
+        <param name="custom_stop" type="string" appearance="multiline" gui-text="STOP"
+            gui-description="Leave empty to use default value. Use 'none' to remove."></param>
+        <param name="custom_start" type="string" appearance="multiline" gui-text="START"></param>
+        <param name="custom_end" type="string" appearance="multiline" gui-text="END"></param>
+    </page>
+    <page name="laser" gui-text="Laser Settings">
+        <param name="laser_mode" type="boolean" gui-text="laser mode"
+            gui-description="Laser mode (generate g-code for grbl laser mode)">false</param>
+        <param name="dynamic_laser_power" type="boolean" gui-text="dynamic laser power"
+            gui-description="Use Grbl's M4 dynamic laser power mode.  Ensures consistent laser cutting power regardless of motor speed.  Only for PWM-capable lasers."
+            min="0.0" max="5.0">true</param>
+        <param name="laser_warm_up_time" type="float" gui-text="laser warm-up time"
+            gui-description="When turning on the laser, wait this many seconds for laser to warm up (G4 command)">0.0</param>
+        <param name="spindle_speed" type="int" gui-text="spindle speed"
+            gui-description="spindle speed (laser power for laser mode, set to -1 to omit)" min="-1" max="1000000000">-1</param>
+        <param name="min_spindle_speed" type="int" gui-text="min spindle speed"
+            gui-description="minimum spindle speed value (grbl $31 setting)" min="-1" max="1000000000">-1</param>
+        <param name="max_spindle_speed" type="int" gui-text="max spindle speed"
+            gui-description="minimum spindle speed value (grbl $30 setting)" min="-1" max="1000000000">-1</param>
+        <param name="feed_rate" type="int" gui-text="feed rate (in mm/min, set to -1 to omit)" min="-1" max="1000000000">-1</param>
+    </page>
+</param>
diff --git a/templates/output_params_txt.xml b/templates/output_params_txt.xml
deleted file mode 100644
index 97e6cacf..00000000
--- a/templates/output_params_txt.xml
+++ /dev/null
@@ -1,39 +0,0 @@
-    {# these parameters are for g-code files (*.txt) #}
-<param type="notebook" name="gcode-settings">
-    <page name="embroidery" gui-text="Coordinate Settings">
-        <param name="flip_x" type="boolean" gui-text="negate X coordinate values" gui-description="Negate x coordinates">false</param>
-        <param name="flip_y" type="boolean" gui-text="negate Y coordinate values" gui-description="Negate y coordinates">false</param>
-        <param type="optiongroup" name="alternate_z" gui-text="Z coordinate value" gui-description="Either alternate Z value between 0 and 1 or travel custom value.">
-           <option value="true">alternate Z value</option>
-           <option value="false">Z travel per stitch</option>
-        </param>
-        <param name="stitch_z_travel" type="float" gui-text="Z travel per stitch"
-            gui-description='increment z coordinate by this amount per stitch if "Z travel per stitch" is enabled' min="0" max="999">5.0</param>
-    </page>
-    <page name="custom-commands" gui-text="Custom Commands">
-        <param name="custom_stitch" type="string" appearance="multiline" gui-text="STITCH"
-            gui-description="Use '%X' for x-coordinate. Use '%Y' for y-coordinate and '%Z' for z-coordinate."></param>
-        <param name="custom_color_change" type="string" appearance="multiline" gui-text="COLOR CHANGE"
-            gui-description="Leave empty to use default value. Use 'none' to remove."></param>
-        <param name="custom_stop" type="string" appearance="multiline" gui-text="STOP"
-            gui-description="Leave empty to use default value. Use 'none' to remove."></param>
-        <param name="custom_start" type="string" appearance="multiline" gui-text="START"></param>
-        <param name="custom_end" type="string" appearance="multiline" gui-text="END"></param>
-    </page>
-    <page name="laser" gui-text="Laser Settings">
-        <param name="laser_mode" type="boolean" gui-text="laser mode"
-            gui-description="Laser mode (generate g-code for grbl laser mode)">false</param>
-        <param name="dynamic_laser_power" type="boolean" gui-text="dynamic laser power"
-            gui-description="Use Grbl's M4 dynamic laser power mode.  Ensures consistent laser cutting power regardless of motor speed.  Only for PWM-capable lasers."
-            min="0.0" max="5.0">true</param>
-        <param name="laser_warm_up_time" type="float" gui-text="laser warm-up time"
-            gui-description="When turning on the laser, wait this many seconds for laser to warm up (G4 command)">0.0</param>
-        <param name="spindle_speed" type="int" gui-text="spindle speed"
-            gui-description="spindle speed (laser power for laser mode, set to -1 to omit)" min="-1" max="1000000000">-1</param>
-        <param name="min_spindle_speed" type="int" gui-text="min spindle speed"
-            gui-description="minimum spindle speed value (grbl $31 setting)" min="-1" max="1000000000">-1</param>
-        <param name="max_spindle_speed" type="int" gui-text="max spindle speed"
-            gui-description="minimum spindle speed value (grbl $30 setting)" min="-1" max="1000000000">-1</param>
-        <param name="feed_rate" type="int" gui-text="feed rate (in mm/min, set to -1 to omit)" min="-1" max="1000000000">-1</param>
-    </page>
-</param>
diff --git a/templates/zip.xml b/templates/zip.xml
index 55366afd..0018cb19 100644
--- a/templates/zip.xml
+++ b/templates/zip.xml
@@ -10,12 +10,12 @@
         <dataloss>true</dataloss>
     </output>
     {%- for format, description, mimetype, category in formats %}
-    {%- if category == "embroidery" %}
+    {%- if category != "vector" and category != "debug" %}
     <param name="format-{{ format }}" type="boolean" _gui-text=".{{ format | upper }}: {{ description }}">false</param>
     {%- endif %}
     {%- endfor %}
+    <param name="format-threadlist" type="boolean" gui-text=".TXT: Threadlist [COLOR]">false</param>
     <param name="format-svg" type="boolean" gui-text=".SVG: Scalable Vector Graphic">false</param>
-    <param name="format-threadlist" type="boolean" gui-text=".TXT: Threadlist">false</param>
     <param name="extension" type="string" gui-hidden="true">zip</param>
     <script>
         {{ command_tag | safe }}
-- 
cgit v1.2.3