Topic: trade-prefs script (Read 1456 times)

disacorns · « **on:** January 12, 2020, 05:26:43 am »

https://bitbucket.org/disacorns/df-trade-prefs/src/master/

trade-prefs

so, i created my first script for dfhack! lets call it the alpha version.

what it does:
shows you a list of items that your dwarves prefer, sorted as the trade agreements sort. it also shows where the trade negotiator will list the items, and how many you currently have in stocks.
e.g.

Spoiler (click to show/hide)

Leather Hagfish leather Not Found 0 Beaver leather Not Found 0 Giant muskox leather Not Found 0 Aardvark leather Not Found 0 White stork leather Not Found 0 Green tree frog leather Not Found 0 Wood Apricot wood logs 0, 0 22 Maple logs 0, 3 0 Larch logs 1, 0 0 Date palm wood logs Not Found 0 Rubber wood logs Not Found 0 Finger lime wood logs Not Found 0 Apple wood logs Not Found 0 Peach wood logs Not Found 0 Rambutan wood logs Not Found 1 MetalBars Gold bars 0, 1 58 Silver bars 0, 2 34 Copper bars 0, 3 64 Nickel bars 0, 4 30 Bronze bars 0, 6 47 Brass bars 0, 7 30 Steel bars 0, 8 57 Electrum bars 0, 10 31 Trifle pewter bars 0, 13 76 Lay pewter bars 0, 14 25 Lead bars 0, 15 55 Billon bars 1, 0 31 Black bronze bars 1, 2 31 Rose gold bars 1, 3 47 Aluminum bars Not Found 0 Gems Prase opal 0, 4 43 Milk quartz 1, 1 118 Onyx opal 1, 4 1 Red pyrope 2, 1 179 Morganite 2, 8 0 Kunzite 2, 11 0 Yellow zircon 2, 14 1 Yellow spessartine 2, 15 171 Clear garnet 3, 1 0 Clear zircon 3, 2 3 Chrysoberyl 3, 6 47 Crystal opal 3, 10 21 Levin opal 3, 11 32 Blue garnet 4, 1 1 Red grossular 4, 6 100 Honey yellow beryl 4, 9 0 Golden beryl 4, 10 3 Fire agate Not Found 0 Lace agate Not Found 0 Green jade Not Found 40 Light yellow diamond Not Found 0 Black diamond Not Found 0 White chalcedony Not Found 0 Bloodstone Not Found 1 Sapphire Not Found 0 Seeds Cowpea Not Found 0 Chestnut Not Found 0 Chickpea Not Found 0 Red bean Not Found 0 Broad bean Not Found 0 White millet Not Found 0 Hide root seed Not Found 0 Sliver barb seed Not Found 0 Peanut Not Found 0 Pets Drinks Dwarven wine 0, 0 9 Dwarven ale 0, 1 11 Hard wheat beer Not Matched0 Soft wheat beer Not Matched0 Raspberry wine Not Matched0 Purple amaranth beer Not Matched0 Wine Not Matched7 Artichoke wine Not Matched0 Quinoa beer Not Found 0 Durian wine Not Found 0 Tuber beer Not Found 0 Apricot wine Not Found 0 Rye beer Not Found 15 Beetroot wine Not Found 8 Radish wine Not Found 9 Kaniwa beer Not Found 8 Gutter cruor Not Found 0 Fisher berry wine Not Found 0 Perry Not Found 0 Sewer brew Not Found 13 Fonio beer Not Found 0 Sweet potato wine Not Found 0 Turnip wine Not Found 0 Bumblebee bumblebee mead Not Found 0 Sand pear cider Not Found 0 Mango wine Not Found 0 Plum wine Not Found 0 Cheese Donkey cheese 0, 2 1 Pig cheese 0, 5 6 Goat cheese 0, 6 14 Powders Gypsum plaster 0, 3 21 Rye flour Not Found 24 Finger millet flour Not Found 0 Foxtail millet flour Not Found 32 Teff flour Not Found 0 Flax flour Not Found 0 Extracts Pig's milk 0, 10 0 Kangaroo's milk Not Found 0 Kangaroo's milk Not Found 0 Meat Giant mole kidney 11, 14 0 Red-winged blackbird eye Not Found 0 Cod pancreatic Not Found 0 Giant parakeet spleen Not Found 0 Whale shark stomach Not Found 0 Giant fox eye Not Found 0 Ocean sunfish stomach Not Found 0 Giant warthog stomach Not Found 0 Lion tamarin heart Not Found 0 Hammerhead shark muscle Not Found 0 Dragonfly pancreatic Not Found 0 Giant coyote muscle Not Found 0 Fish Catastrophe of gopetuja Not Found 0 Catastrophe of gopetuja Not Found 0 Seahorse gut Not Found 0 Catastrophe of gopetuja Not Found 0 Catastrophe of gopetuja Not Found 0 Catastrophe of gopetuja Not Found 0 Catastrophe of gopetuja Not Found 0 Catastrophe of gopetuja Not Found 0 Catastrophe of gopetuja Not Found 0 Catastrophe of gopetuja Not Found 0 Catastrophe of gopetuja Not Found 0 Catastrophe of gopetuja Not Found 0 Plants Wild carrot plant Not Found 32 Turnip plant Not Found 0 GardenVegetables Artichoke hearts 0, 0 33 Raspberries 0, 1 34 Quarry bush leaves 0, 2 12 Strawberry plant 0, 3 11 Feather tree eggs Not Found 0 Bitter melon leaves Not Found 17 Bananas Not Found 0 Plums Not Found 23 Stones Limestone 0, 1 0 Dolomite 0, 2 11 Gabbro 0, 6 0 Schist 0, 10 1 Gneiss 0, 11 0 Malachite 1, 0 1 Petrified wood 1, 6 0 Graphite 1, 7 0 Microcline 1, 15 3 Mica 1, 16 3 Conglomerate 2, 1 0 Bauxite 2, 2 0 Claystone 2, 4 0 Saltpeter 2, 5 1 Ilmenite 2, 7 2 Sandstone 2, 9 1 Gypsum plaster Not Matched21 Borax Not Found 0 Brimstone Not Found 0 Marcasite Not Found 0 Hematite Not Found 0 Orpiment Not Found 0 Anhydrite Not Found 1 Rhyolite Not Found 0 Horn silver Not Found 1 Dacite Not Found 0 Gypsum Not Found 1 Puddingstone Not Found 1 Thread(Plant) Pig tail thread 0, 0 380 Rope reed thread Not Found 429 Linen thread Not Found 0 Eggs Glass Green glass 0, 0 2 Clear glass 0, 1 6 Crystal glass 0, 2 33 Thread(Yarn) Llama wool 0, 1 909 Crafts Mountain goat horn 6, 12 0 Yak horn 6, 15 0 Muskox horn 7, 5 0 Mule hoof 8, 9 0 Cow hoof 8, 13 0 Goat horn 9, 5 0 Pond turtle shell 15, 8 0 Common snapping turtle shell 17, 16 0 Giant red panda bone Not Found 0 Giant muskox hoof Not Found 0 Giant hare tooth Not Found 0 Sea otter tooth Not Found 0 Oyster shell Not Found 0 Bluefin tuna tooth Not Found 0 Kea bone Not Found 0 Capybara tooth Not Found 0 Great horned owl tooth Not Found 0 UNKNOWN Coral Not Found 0 2, -1 ITEMS_DELICATE Kenaf seed oil Not Found 0 420, 32 EDIBLE_COOKED, LIQUID_MISC_PLANT, LIQUID_MISC Axolotl parchment Not Found 0 38, 508 IMPLIES_ANIMAL_KILL

the output columns go like:
<name> <page number>, <row number> <stocks>
page number is how many pages down in 'Meat' or whatever the item will be shown, <row number> is how many items down on that page. Stocks is how many of that item you currently have.
'Not Found' means the script believes the civilazition doesn't offer that item.
'Not Matched' means the civilization offers another form of that item, but seems not to offer that particular item. e.g. dwarves don't offer strawberry wine in drinks, but they could offer strawberries. This also happens with gypsum plaster, your citizen may want it a stone, but the dwarves offer it as a powder.
----
To further explain what this script is for I thought I should describe why I made it:
I like to buy my citizens stuff they want. Gold, quartzite, whatever, but stuff my fortress doesn't produce. Just using DwarfTherapist's preferences dock was tedious, so i started using a spreadsheet to keep track of what they want, and if the traders actually offer it. Updating that was also tedious and full of human error, (going through the list of meat to find a specific animal, and then missing it, or not realizing 'Larch' is a kind of tree.) So I made this script.
---
While this script works (for my purposes at least), anyone looking at the code will realize quickly I have no idea what Im doing. If anyone who does have some idea what they're doing could look at it and give me some advice, or even clean it up, i would be supremely grateful.
My biggest problem at the moment, is looking up :LikeItem preferences.
e.g. picks. I know picks have a sub_type 7, but so do other things in the itemdefs, and I cant figure out what dance_form: 24 is telling me about a pick?!?
Having written one script, im working on another, and really need to know this.
Thanks in advance for any help.

I hope someone else finds this useful.

PatrikLundell · « **Reply #1 on:** January 12, 2020, 06:24:59 am »

I think you'd want two scripts: one for the trade liaison to order things for the next caravan, and another to select things that the caravan currently at the trade depot actually offers.
I've got a version of the latter, although it selects for food preferences only, and it doesn't check current stock (so I have to manually deselect some things that are brought in abundance).
I've had very little experience looking at Ruby scripts (using Lua for DF myself), so I won't comment on your script (Though DF is indeed lying when it displays a food preference for e.g. Mole, when the actual preference is Mole Liver, as testing has showed only the specific item has any effect on food satisfaction).

Obviously, the conclusion that there's a connection to a dance form from a pick isn't correct, although I can't tell you what the correct conclusion is. It may be that the subtype field references something the DFHack community hasn't figured out yet, but it's probably not important for preferences anyway: the bugger likes picks, and so any pick would do, although a steel one would be better liked if the dorf likes steel as well.
Note that item and material preferences tend to be used mainly for noble mandates and craftdorf production quality purposes, although it does affect trinket and clothing acquisition to some extent, and there are rare cases where dorfs nick other items of liked types or materials. Furniture in their rooms presumably help, but quality and value probably trump preferences.

My script:

Spoiler (click to show/hide)

Code: [Select]

function buy_food_needs ()
  if df.global.gview.view.child.child == nil or
     df.global.gview.view.child.child._type ~= df.viewscreen_tradelistst or
     df.global.gview.view.child.child.child._type ~= df.viewscreen_tradegoodsst then
    dfhack.error ("This script must be run when the trade screen is open")
  end
  
  local preferences = {}
  
  for i, unit in ipairs (df.global.world.units.all) do
    if dfhack.units.isCitizen (unit) and
       dfhack.units.isAlive (unit) and
       unit.status.current_soul then
      for k, preference in ipairs (unit.status.current_soul.preferences) do
        if preference.active then
          if  preference.type == df.unit_preference.T_type.LikeFood then
            local found = false
            
            for l, pref in ipairs (preferences) do
              if pref.mattype == preference.mattype and
                 pref.matindex == preference.matindex and
                 pref.item_type == preference_item_type then
                found = true
                break
              end
            end
            
            if not found then
             table.insert (preferences, preference)
            end
          end
        end
      end
    end
  end
  
  for i, item in ipairs (df.global.gview.view.child.child.child.trader_items) do
    if item._type == df.item_cagest then  --  may contain food item_critterst, but at most one.
      local found = false
      
      if #item.general_refs > 2 then
        for k, ref in ipairs (item.general_refs) do
          if ref._type == df.general_ref_contains_unitst then
            local unit = df.unit.find (ref.unit_id)
        
            for l, preference in ipairs (preferences) do
              if preference.matindex == -1 then  --  It's an animal
                if unit.race == preference.mattype then
                  dfhack.println ("Buying caged " .. df.global.world.raws.creatures.all [preference.mattype].name [0])
                  df.global.gview.view.child.child.child.trader_selected [i] = 1
                  found = true
                  break
                end
                
              else
                local material = dfhack.matinfo.decode (preference.mattype, preference.matindex)
                
                if material.mode == "creature" and
                   df.global.world.raws.creatures.all [unit.race].creature_id == material.creature.creature_id and
                   material.material.id ~= "CHEESE" and
                   material.material.id ~= "MILK" and
                   material.material.id ~= "EGGSHELL" and  --  Are there any preferences for eggs at all?
                   material.material.id ~= "EGG_WHITE" and
                   material.material.id ~= "EGG_YOLK" then     
                  local pref
            
                  if material.material.prefix == "" then
                    pref = material.material.state_name.Solid
              
                  else
                    pref = material.material.prefix .. " " .. material.material.state_name.Solid
                  end
            
                  dfhack.println ("Buying caged " .. material.creature.name [0] .. " for " .. pref)               
                  df.global.gview.view.child.child.child.trader_selected [i] = 1
                  found = true 
                  break
                end
              end
            end
          end
          
          if found then
            break
          end
        end        
      end

    elseif item._type == df.item_liquid or  --  ###
           item._type == df.item_powder or  --  ###
           item._type == df.item_seedst or
           item._type == df.item_meatst or
           item._type == df.item_plantst or
           item._type == df.item_plant_growthst or
           item._type == df.item_cheesest or
           item._type == df.item_globst then
      for k, preference in ipairs (preferences) do
        local material = dfhack.matinfo.decode (preference.mattype, preference.matindex)
          
        if preference.matindex ~= -1 and
           item.mat_type == preference.mattype and
           item.mat_index == preference.matindex then
          local pref
            
          if material.material.prefix == "" then
            pref = material.material.state_name.Solid
            
          else
            pref = material.material.prefix .. " " .. material.material.state_name.Solid
          end
            
          dfhack.println ("Buying " .. pref)               
          df.global.gview.view.child.child.child.trader_selected [i] = 1
          break
        end
      end
           
    elseif item._type == df.item_fishst or
           item._type == df.item_fish_rawst then --  Which one? This or previous one?
      for k, preference in ipairs (preferences) do
        local material = dfhack.matinfo.decode (preference.mattype, preference.matindex)
        
        if preference.item_type == df.item_type.FISH then
          if preference.matindex == -1 then
            if preference.mattype == item.race then
              dfhack.println ("Buying " .. df.global.world.raws.creatures.all [preference.mattype].name [0])
              df.global.gview.view.child.child.child.trader_selected [i] = 1
              break
            end
            
          elseif material.mode == "creature" and  --  No fish producing milk or eggs, yet...
                 item.race == preference.mattype then
            local pref
            
            if material.material.prefix == "" then
              pref = material.material.state_name.Solid
            
            else
              pref = material.material.prefix .. " " .. material.material.state_name.Solid
            end
            
            dfhack.println ("Buying " .. pref)               
            df.global.gview.view.child.child.child.trader_selected [i] = 1
            break
          end
        end
      end
      
--    elseif --  item._type == item_foodst or  --  Cooked meals aren't sold (yet)
--           item._type == df.item_drinkst or  --  Should always be in a barrel
--           item._type == df.item_eggst then  --  Don't think there can be egg preferences due to eggs being 3 "creature" parts...               
         
    elseif item._type == df.item_barrelst or 
           item._type == df.item_boxst then  -- for bags...
      if #item.general_refs > 2 then
        local found = false
        
        for k, ref in ipairs (item.general_refs) do
          if ref._type == df.general_ref_contains_itemst then
            local content = df.item.find (ref.item_id)
        
            for l, preference in ipairs (preferences) do
              local material = dfhack.matinfo.decode (preference.mattype, preference.matindex)
          
              if preference.matindex ~= -1 and
                 content.mat_type == preference.mattype and
                 content.mat_index == preference.matindex then
                local pref

                found = true

                if preference.item_type == df.item_type.DRINK or 
                   preference.item_type == df.item_type.LIQUID_MISC then
                  if material.material.prefix == "" then
                    pref = material.material.state_name.Liquid
              
                  else
                    pref = material.material.prefix .. " " .. material.material.state_name.Liquid
                  end
            
                  dfhack.println ("Buying barrel of " .. pref)               
                  df.global.gview.view.child.child.child.trader_selected [i] = 1
                  
                else
                  if material.material.prefix == "" then
                    pref = material.material.state_name.Solid
              
                   else
                    pref = material.material.prefix .. " " .. material.material.state_name.Solid
                  end
            
                  dfhack.println ("Buying bag with " .. pref)               
                  df.global.gview.view.child.child.child.trader_selected [i] = 1
                end
                
                break
              end
            end
          end
          
          if found then
            break
          end
        end       
      end
    end
  end
end

buy_food_needs ()

disacorns · « **Reply #2 on:** January 12, 2020, 06:57:29 am »

thaks for the help!
my script doesn't actually deal with trading with the caravans at the depot. yours looks helpful.
thanks for the tip about the specific meat. "mole liver" that question was bothering me.
would you know what the deal is with "kangaroo milk"? my dorf likes kangaroo milk, the traders allow me to request kangaroo milk, but dfhack shows the kangaroo milk i'm asking for is actually "kangarooman kangaroo milk" (super gross). would it still satisfy food satisfaction requirements?
my "pick" problem is how do I know the guy likes picks? (I know because dwarftherapist tells me so) i can figure out which pref of his must be the pick by process of elimination, but i cant do it programmatically. i think your telling me it doesn't matter, and it really doesn't for this script, but as i mentioned i'm working on something else that needs to know what items they prefer, (and not just picks).

PatrikLundell · « **Reply #3 on:** January 12, 2020, 07:52:08 am »

There's another bug in the food preferences in that Giant and anthropogenic versions of animals are falsely displayed as the regular animal version, although I think the "only" preferences you can have for animal sapients is milk and cheese (but I don't think it's been investigated in depth). A further bug allows for preferences for things that cannot be acquired, like vermin parts (e.g. moghopper eyes), or parts that are too small to be gained from the animal (cavy eyes, for instance). Only exactly the thing matching preferences will do.

I don't remember off the top of my head exactly how to decode preferences, but this script does it https://github.com/PatrikLundell/scripts/blob/own_scripts/thoughts.lua, and it ought to be possible to find the relevant part there. Note that it's a web page with the script on it, not the script itself. It's basically a research tool where I've added things bit by bit, and some of it required investigation (which resulted in updates to the corresponding DF structures). It started out trying to replicate the thought screen for dorfs, but expanded to show the info that's actually there (such as the specific food part preferences, or which piece of music a thought involved), plus a bit about relations (from the relations screen), although that part has bugs I haven't bothered to deal with. The "research" is on hold since a fair while, though.

disacorns · « **Reply #4 on:** January 12, 2020, 02:23:45 pm »

thanks Patrik, it looks like that may be helpful with converting to readable names.
im starting to think I should have used lua, but I really like ruby.

also considering doing something like you did with the caravan, if the trade agreement page is open, the script should automatically change the priorities. i had considered changing the agreement even after the meeting, but decided against it.

Fleeting Frames · « **Reply #5 on:** January 13, 2020, 09:28:35 pm »

Huh, seems similar to script I did five days ago, based on what Patrik mentioned: https://dwarffortresswiki.org/index.php/User:Fleeting_Frames/order_takeout

Though, that one doesn't check things already in fortress and only works for items, both worthy improvements - but it does provide example of changing the priorities while trade screen is open.

A possible future improvement might be a gui to set what categories to import (ex are you really going to cook that flour or get them to haul Mountain Goat Horn amulet?)

Feather tree eggs are growths on feather trees - elves bring their yolks into your depot sometimes, but you can't use those for cooking.

Kenaf seed oil should probably be "Not Matched" i.e. able to import seeds but not the oil itself.

Like Patrik, I don't know much of ruby, including anything stopping you from using it for this purpose.

disacorns · « **Reply #6 on:** January 14, 2020, 12:22:07 am »

wow, thanks fleeting frames.
i would have been surprised if no one else had thought of this.
a quick glance shows me a lot that will be helpful. e.g. the difference between plants and garden vegetables. that was bothering me.

your way seems a lot shorter. just using the trade screen saves a lot of trouble, e.g. trying output a readable name, as well as user effort.
but yeah, automatically ordering everything could have drawbacks.

checking stocks is probably the shortest part of my script, but the slowest.

p.s. kenaf seed oil would show as not matched if the traders offered kenaf seeds. its alone at the bottom there because i dont know what category to put it in. another problem that just doesnt exist with your script.

disacorns · « **Reply #7 on:** January 14, 2020, 12:29:19 am »

just noticed something is broken with fish, i know i had it working earlier. will get to it.

News:

Author Topic: trade-prefs script (Read 1456 times)

disacorns

trade-prefs script

PatrikLundell

Re: trade-prefs script

disacorns

Re: trade-prefs script

PatrikLundell

Re: trade-prefs script

disacorns

Re: trade-prefs script

Fleeting Frames

Re: trade-prefs script

disacorns

Re: trade-prefs script

disacorns

Re: trade-prefs script