add exports for layers and region pops

Author: chdoc

docs/gui/export-world-map.rst

@@ -5,11 +5,17 @@ gui/export-world-map
     :summary: Export world map data for GIS and other external tools.
     :tags: inspection embark map
 
-This tool provides a GUI for the ``export-world-map`` plugin and a number of
+This tool provides a GUI for the `export-world-map` plugin and a number of
 additional exports written in Lua. Moreover, this tool automates the process of
 scrolling around the embark map to generate the region tiles used for the
 exports.
 
+The additional exports provided are:
+
+* Roads and tunnels
+* Geological layers and the veins included in them (pure data layer)
+* Animal and plant populations of regions (pure data layer)
+
 Usage
 -----
 

gui/export-world-map.lua

@@ -4,6 +4,8 @@ local gui = require('gui')
 local widgets = require('gui.widgets')
 
 local roads = reqscript('internal/export-world-map/export-roads')
+local layers = reqscript('internal/export-world-map/export-layers')
+local pops = reqscript('internal/export-world-map/export-pops')
 
 ---@type df.viewscreen_choose_start_sitest
 local viewscreen = dfhack.gui.getDFViewscreen(true)
@@ -80,8 +82,6 @@ local function invokeExport(by_world, by_date, fn)
 end
 
 function ExportMap:startExports()
-    self.subviews.indicator_label:setText("working ...")
-
     local by_date = self.subviews.by_date:getOptionValue()
     local by_world = by_date or self.subviews.by_world:getOptionValue()
 
@@ -90,8 +90,6 @@ function ExportMap:startExports()
             invokeExport(by_world, by_date, export.command)
         end
     end
-
-    self.subviews.indicator_label:setText("")
 end
 
 ---launch command from the C++ plugin
@@ -109,7 +107,9 @@ exports = {
     { id = 2, key = 'rivers', desc = 'River Export (rivers.csv)' , enabled = true, command = pluginCommand("rivers") },
     { id = 3, key = 'sites', desc = 'Site Export (sites.csv)' , enabled = true, command = pluginCommand("sites") },
     { id = 4, key = 'elevation', desc = 'Elevation Grid Export (elevation.dat, elevation.vrt)' , enabled = true, command = pluginCommand("elevation") },
-    { id = 5, key = 'roads', desc = 'Road Export (roads.geojson)' , enabled = true, command = roads.export }
+    { id = 5, key = 'roads', desc = 'Road Export (roads.geojson)' , enabled = true, command = roads.export },
+    { id = 6, key = 'layers', desc = 'Export Geological Layers (layers.csv)' , enabled = true, command = layers.export },
+    { id = 7, key = 'pops', desc = 'Export Plant and Animal Populations (*_pops.csv)' , enabled = true, command = pops.export }
 }
 
 local SELECTED_ICON = dfhack.pen.parse{ch=string.char(251), fg=COLOR_LIGHTGREEN}
@@ -158,7 +158,7 @@ function ExportMap:init()
             text = "Select exports to place in dfhack-config/map-export:",
         },
         widgets.List{
-            frame={t=9, h = 6},
+            frame={t=9, h = 7},
             view_id = "export_list",
             on_submit=self:callback("toggleExport"),
             icon_width = 2,
@@ -167,7 +167,7 @@ function ExportMap:init()
         widgets.CycleHotkeyLabel{
             view_id = 'by_world',
             key = 'CUSTOM_W',
-            frame = { w = 40, h = 1 , t = 15, l = 0 },
+            frame = { w = 40, h = 1 , t = 17, l = 0 },
             options = { { label = 'Yes' , value = true, pen = COLOR_LIGHTGREEN}, { label = 'No' , value = false} },
             initial_option = false,
             label = "Create folder for world name",
@@ -180,7 +180,7 @@ function ExportMap:init()
         widgets.CycleHotkeyLabel{
             view_id = 'by_date',
             key = 'CUSTOM_D',
-            frame = { w = 40, h = 1 , t = 16, l = 0 },
+            frame = { w = 40, h = 1 , t = 18, l = 0 },
             options = { { label = 'Yes' , value = true, pen = COLOR_LIGHTGREEN}, { label = 'No' , value = false} },
             initial_option = false,
             label = "Create subfolder for world date",
@@ -191,18 +191,13 @@ function ExportMap:init()
             end
         },
         widgets.TextButton{
-            frame = { w = 18, h = 1 , t = 18 },
+            frame = { w = 18, h = 1 , t = 20 },
             label = "Run Map Exports!",
             on_click = self:callback('startExports'),
             enabled = function()
                 local cur,max = getLoadedTileRatio()
                 return cur == max
             end
-        },
-        widgets.Label{
-            view_id = 'indicator_label',
-            frame={ t = 20 , h = 1 },
-            text = ""
         }
     }
     self:updateRatio()

internal/export-world-map/export-layers.lua

@@ -0,0 +1,38 @@
+--@ module = true
+local util = reqscript('internal/export-world-map/util')
+
+function writeOutput(out)
+    local column_headers = "geo_index;type;material;top_height;bottom_height\n"
+    out:write(column_headers)
+
+    for _, geo_biome in ipairs(df.global.world.world_data.geo_biomes) do
+        for _, layer in ipairs(geo_biome.layers) do
+            out:write(('%s;%s;%s;%s;%s\n'):format(
+                geo_biome.index,
+                "LAYER",
+                df.inorganic_raw.find(layer.mat_index).id,
+                layer.top_height,
+                layer.bottom_height
+            ))
+            for i = 0, #layer.vein_mat - 1 do
+                local material = df.inorganic_raw[layer.vein_mat[i]]
+                out:write(('%s;%s;%s;%s;%s\n'):format(
+                    geo_biome.index,
+                    df.inclusion_type[layer.vein_type[i]],
+                    df.inorganic_raw.find(layer.vein_mat[i]).id,
+                    layer.top_height,
+                    layer.bottom_height
+                ))
+            end
+        end
+    end
+end
+
+--- export geological layers
+function export(by_world, by_date)
+    return function()
+        local out = io.open(util.getOutputFolder(by_world, by_date).."layers.csv", 'w')
+        writeOutput(out)
+        out:close()
+    end
+end

internal/export-world-map/export-pops.lua

@@ -0,0 +1,59 @@
+--@ module = true
+local util = reqscript('internal/export-world-map/util')
+
+local plants_filename = "plant_pops.csv"
+local creature_filename = "creature_pops.csv"
+local vermin_filename = "vermin_pops.csv"
+local column_headers = "region_id;population_type;raw_id;pop_count_min;pop_count_max\n"
+
+function writeOutput(base_folder)
+    local plants = io.open(base_folder..plants_filename, 'w')
+    local creatures = io.open(base_folder..creature_filename, 'w')
+    local vermin = io.open(base_folder..vermin_filename, 'w')
+
+    plants:write(column_headers)
+    creatures:write(column_headers)
+    vermin:write(column_headers)
+
+    for _, region in ipairs(df.global.world.world_data.regions) do
+        for _, pop in ipairs(region.population) do
+            local raw_id
+            local out
+            if pop.type >= 5 then
+                raw_id = df.plant_raw.find(pop.plant).id
+                out = plants
+            else
+                raw_id = df.creature_raw.find(pop.plant).creature_id
+                if
+                    pop.type == df.world_population_type.Vermin or
+                    pop.type == df.world_population_type.VerminInnumerable
+                then
+                    out = vermin
+                else
+                    out = creatures
+                end
+            end
+
+            if out then
+                out:write(('%s;%s;%s;%s;%s\n'):format(
+                    region.index,
+                    df.world_population_type[pop.type],
+                    raw_id,
+                    pop.count_min,
+                    pop.count_max
+                ))
+            end
+        end
+    end
+
+    plants:close()
+    vermin:close()
+    creatures:close()
+end
+
+--- export animal and plant populations
+function export(by_world, by_date)
+    return function()
+        writeOutput(util.getOutputFolder(by_world, by_date))
+    end
+end