Print

Please login or register.
1 Hour 1 Day 1 Week 1 Month Forever
Login with username, password and session length

[Quarque]

I would like to modify the brew reaction, such that you need water first.

The reactions seems to work, but getting the dwarves to fill empty buckets with water is awkward.
I have built a well and designated a flat area as a pond. Then you can cancel the pond when a dwarf has filled a bucket. But is there any better way to do this? Perhaps by adding another reaction?

And can the reactions for booze be improved? What I have now is:

Spoiler (click to show/hide)

[REACTION:BREW_DRINK_FROM_PLANT]
   [NAME:brew drink from plant]
   [BUILDING:STILL:HOTKEY_STILL_BREW]
   [REAGENT:plant:1:PLANT:NONE:NONE:NONE]
      [HAS_MATERIAL_REACTION_PRODUCT:DRINK_MAT]
      [UNROTTEN]
   [REAGENT:barrel/pot:1:NONE:NONE:NONE:NONE]
      [EMPTY]
      [FOOD_STORAGE_CONTAINER] barrel or any non-absorbing tool with FOOD_STORAGE
      [PRESERVE_REAGENT]
      [DOES_NOT_DETERMINE_PRODUCT_AMOUNT]
   [REAGENT:water:150:LIQUID_MISC:NONE:WATER]
      [DOES_NOT_DETERMINE_PRODUCT_AMOUNT]
   [REAGENT:bucket:1:NONE:NONE:NONE:NONE]
      [CONTAINS:water]
      [PRESERVE_REAGENT]
      [DOES_NOT_DETERMINE_PRODUCT_AMOUNT]
   [PRODUCT:100:5:DRINK:NONE:GET_MATERIAL_FROM_REAGENT:plant:DRINK_MAT]
      [PRODUCT_TO_CONTAINER:barrel/pot]
      [PRODUCT_DIMENSION:150]
   [PRODUCT:100:1:SEEDS:NONE:GET_MATERIAL_FROM_REAGENT:plant:SEED_MAT]
   [SKILL:BREWING]

[REACTION:BREW_DRINK_FROM_PLANT_GROWTH]
   [NAME:brew drink from fruit]
   [BUILDING:STILL:CUSTOM_F]
   [REAGENT:plant:1:PLANT_GROWTH:NONE:NONE:NONE]
      [HAS_MATERIAL_REACTION_PRODUCT:DRINK_MAT]
      [UNROTTEN]
   [REAGENT:barrel/pot:1:NONE:NONE:NONE:NONE]
      [EMPTY]
      [FOOD_STORAGE_CONTAINER] barrel or any non-absorbing tool with FOOD_STORAGE
      [PRESERVE_REAGENT]
      [DOES_NOT_DETERMINE_PRODUCT_AMOUNT]
   [REAGENT:water:150:LIQUID_MISC:NONE:WATER]
      [DOES_NOT_DETERMINE_PRODUCT_AMOUNT]
   [REAGENT:bucket:1:NONE:NONE:NONE:NONE]
      [CONTAINS:water]
      [PRESERVE_REAGENT]
      [DOES_NOT_DETERMINE_PRODUCT_AMOUNT]
   [PRODUCT:100:5:DRINK:NONE:GET_MATERIAL_FROM_REAGENT:plant:DRINK_MAT]
      [PRODUCT_TO_CONTAINER:barrel/pot]
      [PRODUCT_DIMENSION:150]
   [PRODUCT:100:1:SEEDS:NONE:GET_MATERIAL_FROM_REAGENT:plant:SEED_MAT]
   [SKILL:BREWING]

[FantasticDorf]

A aged reply is that it could be possible by use of a script, but you'd have to make the solution yourself.

People prior to you have suggested a [NEEDS_WATER] function similar to [NEEDS_MAGMA] that works like the mentioned with the inaccessible tile, but the hermit "handpump" mentioned and the code provided is a startpoint to getting to grips with what you may need to do. In addition, if you set something up, it would be possible to assign this to a custom token in the latest DFhack.

So in essence, every time the desired directional space runs the reaction, it'd pull up water, then you could generate a water-bucket at the end of the reaction. The DFhack steam engine that's included with every release may use something similar as my own hint.

[Quarque]

Thanks for the pointer. So a better idea is to leave the reactions in the raws unchanged and use a script. With the eventful module it should be possible to alter the brew reactions:

• check if there is water nearby the still
• remove a unit of water if there is
• if there is no water, cancel the job with a warning

Another relevant old post contains a script that almost does what I need: http://www.bay12forums.com/smf/index.php?topic=141497.15
But this post is from 2014 and some functions/data structures used by this script have changed.
I almost got it to work, but not quite:

Spoiler (click to show/hide)

-- Forces brewing in a still to require water
local eventful = require 'plugins.eventful'
local utils = require 'utils'

function usewater(reaction,reaction_product,unit,input_items,input_reagents,output_items,call_native)
   local building = dfhack.buildings.findAtTile(unit.pos)
   local pos = {}
   pos.x1 = building.x1
   pos.x2 = building.x2
   pos.y1 = building.y1
   pos.y2 = building.y2
   pos.z = building.z
   for x = pos.x1-1, pos.x2+1, 1 do
      for y = pos.y1-1, pos.y2+1, 1 do
         baseBlock = dfhack.maps.ensureTileBlock(x,y,pos.z)
         liquidBlock = dfhack.maps.ensureTileBlock(x,y,pos.z-1)
         if liquidBlock.designation[x%16][y%16].flow_size > 0 and liquidBlock.designation[x%16][y%16].liquid_type == false then
            liquidBlock.designation[x%16][y%16].flow_size = liquidBlock.designation[x%16][y%16].flow_size - 1
            call_native.value = true
            return
         end
      end
   end
   dfhack.gui.showZoomAnnouncement(df.announcement_type.CANCEL_JOB, unit.pos, dfhack.TranslateName(unit.name).." cancels "..reaction.name..": Needs water." , COLOR_RED, true)
   call_native.value = false
   dfhack.job.setJobCooldown(building, unit, 5) -- Prevent the worker from immediately re-attempting the failed Job.
   return
end

dfhack.onStateChange.loadUseLiquid = function(code)
   if code==SC_MAP_LOADED then
      --registered_reactions = {}
      for i,reaction in ipairs(df.global.world.raws.reactions.reactions) do
         if string.startswith(reaction.code,'BREW_DRINK') then
            eventful.registerReaction(reaction.code,usewater)
         end
      end
   elseif code==SC_MAP_UNLOADED then
   end
end

if dfhack.isMapLoaded() then dfhack.onStateChange.loadUseLiquid(SC_MAP_LOADED) end

The problem is that the seventh argument (call_native) is never passed on. In DFHack I get an error message that I am trying to write to a nil value.

I found another post from 2017 where someone else has the same problem:

I hate Fortress Mode modding 

Me too. The raws modding too .

Can you print all the args to lua? I.e.

Code: [Select]

function reaction() local args={...}; printall(args); end

Oh derp I didn't think to do that when trying to work stuff out.
It only receives 6 args, where the 7th should be the call_native: 1 is a reaction, 2 is a reaction product item table, 3 is a unit, 4 is a table of items, 5 is a table of reaction reagents, 6 is a table of items.

Maybe it's something related to the reaction using a custom building? That's the only thing I could think of that deviates slightly from the norm.

I suspect this is a bug in the eventful module of dfhack that was introduced, somewhere between 2014 and 2017 the function was changed. Originally it only took 6 parameters; the second parameter (reaction_product) is new. It isn't present in the old scripts from 2014 and if you look at the documentation of https://docs.dfhack.org/en/stable/docs/Lua%20API.html?highlight=eventful#eventful, you see the parameter mentioned in the description of onReactionComplete, but it is missing in the example code.

Am I missing something? Can I report bugs in DFHack somewhere? And is there another way to cancel the reaction? I tried reaction_product.probability = 0, but that had no effect.

[FantasticDorf]

Am I missing something? Can I report bugs in DFHack somewhere? And is there another way to cancel the reaction? I tried reaction_product.probability = 0, but that had no effect.

Ill PM you a discord link to the DFhack hub, elsewise like most of us its merely waiting around for inspiration to strike or someone to dive in and finish the last piece of the puzzle out of their own initative.

Probability doesn't physically turn it off, it just executes it with no chance of procuring the *product, as a alternative you could have it be probability 0 then return the water if false to where it came from, assuming it the same water that got drawn up (perhaps into a 1x1 solid cavity in the workshop to "hold" the water, but im unsure if the dynamics of having that much water nearby would make it deconstruct.)

[Quarque]

Thanks, I will see if I can get some help on discord.

To be clear, all I've tried so far is to modify the brew reactions. I haven't tried yet to add a check when building the still.

I reported the issue with the registerReaction function on the DFHack issue tracker. The folks there have already confirmed it as a bug and they're working on it.

[Quarque]

This script makes brewing use one unit of clean water.

Place the still adjacent to clean water, such as a river, pool or channel.
Water that is salt or stagnant will be ignored.
The water has to be accessible. A grate on top works, a floor on top doesn't.

Making mead will not require water. Honey is already a liquid.

The script does not work with old versions of DFHack.
It needs version 0.47.05-r6 or newer.

Spoiler (click to show/hide)

-- Makes brewing use one unit of clean water.
--
--[====[

brew-needs-water
======

Makes brewing use one unit of clean water.

Place the still adjacent to clean water, such as a river, pool or channel.
Water that is salt or stagnant will be ignored.
The water has to be accessible. A grate on top works, a floor on top doesn't.

Making mead will not require water. Honey is already a liquid.

]====]

local eventful = require 'plugins.eventful'

local waterFound = true

function intToBool(i)
   return (i ~= 0)
end

function getWaterFromTile(x, y, z)
   local liquidBlock = dfhack.maps.ensureTileBlock(x,y,z-1)
   local blockDesignation = liquidBlock.designation[x%16][y%16]
   
   waterFound = false

   if
      blockDesignation.flow_size > 0 and
      blockDesignation.liquid_type == intToBool(df.tile_liquid.Water) and
      not blockDesignation.water_stagnant and
      not blockDesignation.water_salt
   then
      local tiletype = dfhack.maps.getTileType(x,y,z)
      local shape = df.tiletype.attrs[tiletype].shape
      
      if -- check if the water is accessible from above
         shape == df.tiletype_shape.EMPTY or
         shape == df.tiletype_shape.STAIR_DOWN or
         shape == df.tiletype_shape.STAIR_UPDOWN or
         shape == df.tiletype_shape.RAMP_TOP
      then
         blockDesignation.flow_size = blockDesignation.flow_size - 1
         waterFound = true
      end
   end
   return
end

function usewater(reaction,reaction_product,unit,input_items,input_reagents,output_items,call_native)
   -- The reaction calls this function once for each product.
   --  call 1: produce drink
   --  call 2: produce seeds
   -- We only want to check for water the first time.
   if reaction_product.item_type ~= df.item_type.DRINK then
      call_native.value = waterFound
      return
   end

   local pos = unit.pos
   call_native.value = true
   
   -- check the tiles above and below the still for water
   for x = pos.x - 1, pos.x + 1, 1 do
      for y = pos.y - 2, pos.y + 2, 4 do
         getWaterFromTile(x, y, pos.z)
         if waterFound then
            return
         end
      end
   end
   -- check the tiles left and right of the still for water
   for x = pos.x - 2, pos.x + 2, 4 do
      for y = pos.y - 1, pos.y + 1, 1 do
         getWaterFromTile(x, y, pos.z)
         if waterFound then
            return
         end
      end
   end

   dfhack.gui.showZoomAnnouncement(df.announcement_type.CANCEL_JOB, unit.pos, dfhack.TranslateName(unit.name).." cancels "..reaction.name..": Needs clean water." , COLOR_RED, true)
   call_native.value = false
   
   return
end

local args = {...}

if args[1] == 'help' then
    print(dfhack.script_help())
else
   if dfhack.isMapLoaded() then
      for i,reaction in ipairs(df.global.world.raws.reactions.reactions) do
         if string.startswith(reaction.code,'BREW_DRINK') then
            eventful.registerReaction(reaction.code,usewater)
         end
      end
      print('Brewing (except mead) now uses one unit of clean water.')
      print('Water will be taken from any source adjacent to the still.')
      print('For details, run "brew-needs-water help"')
   else
      print('Load a map before running this script.')
   end
end

[brewer bob]

Looks interesting...

This script makes brewing use one unit of clean water.

Place the still adjacent to clean water, such as a river, pool or channel.
Water that is salt or stagnant will be ignored.
The water has to be accessible. A grate on top works, a floor on top doesn't.

If salt water can be ignored, could the script be changed so that salt contaminated water is needed instead of clean water? Been thinking of modding in salterns as a custom building for salt production, but the best idea so far was to do a modified version of an "empty bucket" reaction which has a chance of giving salt.

(I have no idea about scripting or what's possible or not, so sorry if this is a dumb question.)

[Quarque]

(I have no idea about scripting or what's possible or not, so sorry if this is a dumb question.)

No man, no apology needed at all. The learning curve for writing DFHack scripts is a cliff, I spent days cursing my computer before I got it right (and only thanks to people on Discord helping out).

Anyway, yes, you can change the script so that brewing requires salt water. The part of the script that controls the accepted fluids is these lines:

Code: [Select]

      blockDesignation.flow_size > 0 and
      blockDesignation.liquid_type == intToBool(df.tile_liquid.Water) and
      not blockDesignation.water_stagnant and
      not blockDesignation.water_salt
The 4th line checks for salt. To make brewing accept only salt water, change it to:

Code: [Select]

      blockDesignation.flow_size > 0 and
      blockDesignation.liquid_type == intToBool(df.tile_liquid.Water) and
      not blockDesignation.water_stagnant and
      blockDesignation.water_salt
I would recommend also changing the error message from:

Code: [Select]

   dfhack.gui.showZoomAnnouncement(df.announcement_type.CANCEL_JOB, unit.pos, dfhack.TranslateName(unit.name).." cancels "..reaction.name..": Needs clean water." , COLOR_RED, true)
to:

Code: [Select]

   dfhack.gui.showZoomAnnouncement(df.announcement_type.CANCEL_JOB, unit.pos, dfhack.TranslateName(unit.name).." cancels "..reaction.name..": Needs salt water." , COLOR_RED, true)
If you want to be thorough, you could also change the help text to match.

I've been toying with the idea to allow brewing from magma in case there is only magma available and no water.. someone on discord suggested that it could yield liquid fire. Any ideas welcome.

[Quarque]

P.S.: reading your post again, I see you don't want to brew booze from salt water, but you want to produce salt from salt water.

That's more difficult, but it should be possible. You would need to add a custom reaction to the raws that produces water from salt, and couple the script to your custom reaction. To do this, replace this code:

Code: [Select]

         if string.startswith(reaction.code,'BREW_DRINK') then
            eventful.registerReaction(reaction.code,usewater)
         end
with something like

Code: [Select]

         if reaction.code == 'YOUR_SALTERN_REACTION') then
            eventful.registerReaction(reaction.code,usewater)
         end
In addition, you can simplify the script further. I had to work around the problem that the callback function (usewater) is invoked once for each reaction product. Brewing has two products (drink and seeds) and you have to prevent the callback function from consuming water twice, or throwing two error messages. That is why I needed to add:

Code: [Select]

   -- The reaction calls this function once for each product.
   --  call 1: produce drink
   --  call 2: produce seeds
   -- We only want to check for water the first time.
   if reaction_product.item_type ~= df.item_type.DRINK then
      call_native.value = waterFound
      return
   endBut you would probably not need that.

The more difficult part is how to add your custom reaction to a workshop. It should be possible, but I don't know how. Hopefully someone else can help you there. You could also overwrite an existing reaction like `make mead` as a workaround.

[FantasticDorf]

Salt has its own hardcoded material token, so its relatively straightfoward to set up, i wonder what bob has in mind for it.

Alternatively for instance, by following a variant of the process you've already described for saltwater, you could "extract" stagnant water and then generate *actual filth, mud, and other conspicous things.

[brewer bob]

Thanks! Good to know it'd be technically possible (and I even understood the explanations).

Making the 'water to salt' reaction isn't in itself a problem, though I guess in reagents you can't use contaminants (or that's how I've understood)? Which won't be a problem if the building itself just checks if there's salt water next/near to it, so I could just leave the water reagent away.

Anyway, it'll take time before I'll try to test the saltern script. Better finish other modding stuff first before trying something which I'll have to spend much time learning.

Salt has its own hardcoded material token, so its relatively straightfoward to set up, i wonder what bob has in mind for it.

Just working on a personal mod (which has sort of gotten out of hand) with all sorts of medieval industries, of which making salt is one. I don't have much use for the salt yet, except for a salting meat prototype.

you could "extract" stagnant water and then generate *actual filth, mud, and other conspicous things.

Haha, I've actually thought about what'd be a good way to have dwarves produce, err, "yellow filth", as it'd be great to have it in wool-working reactions (like, fulling in a tub filled ankle-deep with said "filth")