Merge pull request DFHack#5562 from ab9rf/tailor-dye

add dye automation to `tailor`

Author: ab9rf

docs/plugins/tailor.rst

@@ -28,6 +28,7 @@ Usage
     tailor now
     tailor materials <material> [<material> ...]
     tailor confiscate [true|false]
+    tailor dye [true|false]
 
 By default, ``tailor`` will prefer using materials in this order::
 
@@ -48,6 +49,11 @@ too precious to routinely make into cloth. ``tailor`` does not support modded
 "cloth" types which utilize custom reactions for making clothing out of those
 cloth types.
 
+If dye management is enabled, ``tailor`` will also issue orders to dye cloth
+as needed to fulfill fortress clothing requirements, and will issue orders to
+manufacture dyes required to fulfill the dye cloth orders. Dye management is
+disabled by default.
+
 Examples
 --------
 
@@ -69,3 +75,11 @@ Caveats
 Modded cloth-like materials are not supported because custom reactions do not
 support being sized for non-dwarf races. The game only supports sizing the
 built-in default make-clothing or make-armor reactions.
+
+Dye automation will not not issue orders to mill dyes that are made at a
+millstone or quern because Dwarf Fortress does not currently support
+"mill plant" orders for a specified material.
+
+At present, dye automation uses any available dye and cloth will be dyed
+with whatever color dye can be found or made. The ability to specify color
+preferences may be added in the future.

plugins/lua/tailor.lua

@@ -17,6 +17,7 @@ end
 function status()
     dfhack.print(('tailor is %s'):format(isEnabled() and "enabled" or "disabled"))
     print((' %s confiscating tattered clothing'):format(tailor_getConfiscate() and "and" or "but not"))
+    print(('tailor %s automating dye'):format(tailor_getAutomateDye() and "is" or "is not"))
     print('materials preference order:')
     for _,name in ipairs(tailor_getMaterialPreferences()) do
         print(('  %s'):format(name))
@@ -38,6 +39,11 @@ function setConfiscate(opt)
     tailor_setConfiscate(fl)
 end
 
+function setAutomateDye(opt)
+    local fl = argparse.boolean(opt[1], "set dye")
+    tailor_setAutomateDye(fl)
+end
+
 function parse_commandline(...)
     local args, opts = {...}, {}
     local positionals = process_args(opts, args)
@@ -55,6 +61,8 @@ function parse_commandline(...)
         setMaterials(positionals)
     elseif command == 'confiscate' then
         setConfiscate(positionals)
+    elseif command == 'dye' then
+        setAutomateDye(positionals)
     else
         return false
     end