new tool: autocheese

Author: chdoc

autocheese.lua

@@ -0,0 +1,155 @@
+--@module = true
+
+local ic = reqscript('idle-crafting')
+
+---make cheese using a specific barrel and workshop
+---@param barrel df.item
+---@param workshop df.building_workshopst
+---@return df.job
+function makeCheese(barrel, workshop)
+    ---@type df.job
+    local job = ic.make_job()
+    job.job_type = df.job_type.MakeCheese
+
+    local jitem = df.job_item:new()
+    jitem.quantity = 0
+    jitem.vector_id = df.job_item_vector_id.ANY_COOKABLE
+    jitem.flags1.unrotten = true
+    jitem.flags1.milk = true
+    job.job_items.elements:insert('#', jitem)
+
+    if not dfhack.job.attachJobItem(job, barrel, df.job_item_ref.T_role.Reagent, 0, -1) then
+        dfhack.error('could not attach item')
+    end
+
+    ic.assignToWorkshop(job, workshop)
+    return job
+end
+
+
+
+---unit is ready to take jobs
+---@param unit df.unit
+---@return boolean
+function unitIsAvailable(unit)
+    if unit.job.current_job then
+        return false
+    elseif #unit.individual_drills > 0 then
+        return false
+    elseif unit.flags1.caged or unit.flags1.chained then
+        return false
+    elseif unit.military.squad_id ~= -1 then
+        local squad = df.squad.find(unit.military.squad_id)
+        -- this lookup should never fail
+        ---@diagnostic disable-next-line: need-check-nil
+        return #squad.orders == 0 and squad.activity == -1
+    end
+    return true
+end
+
+---find unit with a particular labor enabled
+---@param unit_labor df.unit_labor
+---@param job_skill df.job_skill
+---@param workshop df.building
+---@return df.unit|nil
+---@return integer|nil
+ function findAvailableLaborer(unit_labor, job_skill, workshop)
+    local max_unit = nil
+    local max_skill = -1
+    for _, unit in ipairs(dfhack.units.getCitizens(true, false)) do
+        if
+            unit.status.labors[unit_labor] and
+            unitIsAvailable(unit) and
+            ic.canAccessWorkshop(unit, workshop)
+        then
+            local unit_skill = dfhack.units.getNominalSkill(unit, job_skill, true)
+            if unit_skill > max_skill then
+                max_unit = unit
+                max_skill = unit_skill
+            end
+        end
+    end
+    return max_unit, max_skill
+end
+
+local function findMilkBarrel(min_liquids)
+    for _, container in ipairs(df.global.world.items.other.FOOD_STORAGE) do
+        if
+            not (container.flags.in_job or container.flags.forbid) and
+            container.flags.container and #container.general_refs >= min_liquids
+        then
+            local content_reference = dfhack.items.getGeneralRef(container, df.general_ref_type.CONTAINS_ITEM)
+            local contained_item = df.item.find(content_reference and content_reference.item_id or -1)
+            if contained_item then
+                local mat_info = dfhack.matinfo.decode(contained_item)
+                if mat_info:matches { milk = true } then
+                    return container
+                end
+            end
+        end
+    end
+end
+
+function findWorkshop()
+    for _,workshop in ipairs(df.global.world.buildings.other.WORKSHOP_FARMER) do
+        if
+            not workshop.profile.blocked_labors[df.unit_labor.MAKE_CHEESE] and
+            #workshop.jobs == 0 and #workshop.profile.permitted_workers == 0
+        then
+            return workshop
+        end
+    end
+end
+
+if dfhack_flags.module then
+    return
+end
+
+-- actual script action
+
+local argparse = require('argparse')
+
+local min_number = 50
+
+local _ = argparse.processArgsGetopt({...},
+{
+    { 'm', 'min-milk', hasArg = true,
+    handler = function(min)
+        min_number = argparse.nonnegativeInt(min, 'min-milk')
+    end }
+})
+
+
+local reagent = findMilkBarrel(min_number)
+
+if not reagent then
+    -- print('autocheese: no sufficiently full barrel found')
+    return
+end
+
+local workshop = findWorkshop()
+
+if not workshop then
+    print('autocheese: no workshop available')
+    return
+end
+
+local worker, skill = findAvailableLaborer(df.unit_labor.MAKE_CHEESE, df.job_skill.CHEESEMAKING, workshop)
+if not worker then
+    print('autocheese: no cheesemaker available')
+    return
+end
+local job = makeCheese(reagent, workshop)
+
+print(('autocheese: dispatching cheesemaking job for %s (%d milk) to %s'):format(
+    dfhack.items.getDescription(reagent, 0),
+    #reagent.general_refs,
+    dfhack.df2console(dfhack.units.getReadableName(worker))
+))
+
+
+-- assign a worker and send it to fetch the barrel
+dfhack.job.addWorker(job, worker)
+dfhack.units.setPathGoal(worker, reagent.pos, df.unit_path_goal.GrabJobResources)
+job.items[0].flags.is_fetching = true
+job.flags.fetching = true

changelog.txt

@@ -29,6 +29,7 @@ Template for new versions:
 ## New Tools
 - `fix/stuck-squad`: allow squads and messengers returning from missions to rescue squads that have gotten stuck on the world map
 - `gui/rename`: (reinstated) give new in-game language-based names to anything that can be named (e.g. units, governments, fortresses, or the world)
+- `autocheese`: automatically make cheese using barrels that have accumulated sufficient milk
 
 ## New Features
 - `gui/settings-manager`: new overlay on the Labor -> Standing Orders tab for configuring the number of barrels to reserve for job use (so you can brew alcohol and not have all your barrels claimed by stockpiles for container storage)

docs/autocheese.rst

@@ -0,0 +1,38 @@
+autocheese
+==========
+
+.. dfhack-tool::
+    :summary: Automatically make cheese using barrels that have accumulated sufficient milk.
+    :tags: fort auto
+
+Cheese making is difficult to automate using work orders, because a single job
+can consume anything from a bucket was a single unit of milk to barrel
+containing up to 100 units of milk.
+
+The script will scan your fort for barrels with a certain minimum amount of milk
+(default: 50), create a cheese making job specifically for that barrel, and
+assign this job to one of your idle dwarves (giving preference to skilled cheese
+makers).
+
+When enabled using `gui/control-panel`, the script will run automatically, with
+default options, twice a month.
+
+Usage
+-----
+
+::
+
+    autocheese [<options>]
+
+Examples
+--------
+
+``autocheese -m 100``
+    Only create a job if there is a barrel that is filled to the maximum.
+
+Options
+-------
+
+``-m``, ``--min-milk``
+    Set the minimum number of milk items in a barrel for the barrel to be
+    considered for cheese making.

internal/control-panel/registry.lua

@@ -18,6 +18,8 @@ COMMANDS_BY_IDX = {
     {command='autobutcher target 10 10 14 2 BIRD_PEAFOWL_BLUE', group='automation', mode='run',
         desc='Enable if you usually want to raise peafowl.'},
     {command='autochop', group='automation', mode='enable'},
+    {command='autocheese', group='automation', mode='repeat',
+        params={'--time', '14', '--timeUnits', 'days', '--command', '[', 'autocheese', ']'}},
     {command='autoclothing', group='automation', mode='enable'},
     {command='autofarm', group='automation', mode='enable'},
     {command='autofarm threshold 150 grass_tail_pig', group='automation', mode='run',