Print

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

[PatrikLundell]

Acting on Toady's info in the FotF, a couple of dead civ related scripts have been made:
- slabciv: Kills off controllable civs (i.e. dwarven ones) if they haven't shows any sign of life for 100 years (arbitrary duration).
- permit_dead: Adds dead controllable civs to the pre embark civ selection list.

slabciv.lua

Spoiler (click to show/hide)

Code: [Select]

--  Ensures civs that die during worlgen history actually become dead civs rather than struggling ones.
--  Started before generating the world.
--[===[

slabciv
=======
--  This script is started before you starts to generate a world and runs while the world is generated.
--  Controllable (dwarven) civs that ought to be dead but refuse to realize it are slabbed to put them
--  to rest. Intended to be used in conjunction with the permit_dead script to allow you to embark as
--  those civs, but works "naturally" if all controllable civs are dead.
--  A civ is declared dead if it hasn't contained a histfig for 100 years and no generic population
--  changes have occured for 100 years. Thus, the script is useless if world gen is less than 100 years.
--  Version 0.2 2018-01-01
]===]
local new_progress = false

for field, value in pairs (df.global.world.worldgen_status) do
  if field == "place_caves" then
    new_progress = true
    break
  end
end

function slabciv ()
  if dfhack.isMapLoaded () then
    dfhack.color (COLOR_RED)
    dfhack.print("Error: This script is used for world generation manipulation and does not allow a map to be loaded")
    dfhack.color(COLOR_RESET)
    dfhack.println()
    return
  end

  local civ_state = {}
   
  local state = df.global.world.worldgen_status.state
  local active = (new_progress and not df.global.world.worldgen_status.place_caves) or
                 (not new_progress and not not df.global.world.worldgen_status.placed_caves)
  local finished_prehistory = false
  local century = 0
  local previous_year = 0
  local current_year
 
  local num_rejects = df.global.world.worldgen_status.num_rejects

  function callback ()
    if dfhack.isMapLoaded () then
      dfhack.println ("A map has been loaded, so slabciv terminates now.")
      return
    end
   
    if state > df.global.world.worldgen_status.state or
      num_rejects ~= df.global.world.worldgen_status.num_rejects then
      num_rejects = df.global.world.worldgen_status.num_rejects
      active = true
      state = df.global.world.worldgen_status.state
      finished_prehistory = false
      century = 0
      previous_year = 0
      dfhack.println ("Starting new run")
    end
   
    if active and df.global.world.worldgen_status.state == 9 then
      if not finished_prehistory and df.global.world.worldgen_status.finished_prehistory then
        finished_prehistory = true
     
        for i, entity in ipairs (df.global.world.entities.all) do
          if entity.type == df.historical_entity_type.Civilization and
             entity.entity_raw.flags.CIV_CONTROLLABLE then
            civ_state [i] = {entity_population_index = 0,
                             entity_population = 0,
                             entity_population_change_year = 1,
                             no_histfig_year = -1,
                             live_histfigs = 0,
                             slabbed = false}
         
            for k, pop in ipairs (df.global.world.entity_populations) do
              if pop.civ_id == i then
                civ_state [i].entity_population_index = k
           
                for l, count in ipairs (pop.counts) do
                  civ_state [i].entity_population = civ_state [i].entity_population + count
                end
           
                break
              end
            end

            local start_id = 0
         
            for k, histfig in ipairs (entity.histfig_ids) do
              for l = start_id, #df.global.world.history.figures - 1 do
                if df.global.world.history.figures [l].id == histfig then
                  found = true
                  start_id = l
             
                  if df.global.world.history.figures [l].died_year == -1 then
                    civ_state [i].live_histfigs = civ_state [i].live_histfigs + 1
                  end
             
                  break
                end
              end
            end
          end
        end
      end
   
      if finished_prehistory and df.global.world.worldgen_status.anon_4 < previous_year then
        century = century + 1
      end
   
      previous_year = df.global.world.worldgen_status.anon_4
      current_year = century * 100 + previous_year + 1
   
      for i, civ in pairs (civ_state) do
        local population = 0
        for k, count in ipairs (df.global.world.entity_populations [civ.entity_population_index].counts) do
          population = population + count
        end
     
        if population ~= civ.entity_population then
          civ.entity_population_change_year = current_year
          civ.entity_population = population
        end
     
        local histcount = 0
        local start_id = 0   
         
        for k, histfig in ipairs (df.global.world.entities.all [i].histfig_ids) do
          for l = start_id, #df.global.world.history.figures - 1 do
            if df.global.world.history.figures [l].id == histfig then
              start_id = l
             
              if df.global.world.history.figures [l].died_year == -1 then
                histcount = histcount + 1
              end
             
              break
            end
          end
        end
                 
        if histcount ~= 0 then
          civ.no_histfig_year = -1  --  To account for generation of histfig.
       
        elseif histcount == 0 and
           civ.live_histfigs ~= 0 then
          civ.no_histfig_year = current_year
        end
     
        civ.live_histfigs = histcount
     
        if civ.live_histfigs == 0 and
           not civ.slabbed and
           current_year - civ.no_histfig_year >= 100 and
           current_year - civ.entity_population_change_year >= 100 and  --  It seems the callback isn't triggered exactly on every year.
           civ.entity_population ~= 0 then
          dfhack.println ("Year " .. tostring (current_year) .. ": " ..
                          df.global.world.entities.all [i].entity_raw.translation ..
                          " civ " .. tostring (i) .. " lost last histfig in " ..
                          tostring (civ.no_histfig_year) ..
                          " and has had no pop changes for 100 years. Reported pop: " ..
                          tostring (civ.entity_population) ..
                          ". Slabbing it.")
          civ.slabbed = true
                   
          for k, count in ipairs (df.global.world.entity_populations [civ.entity_population_index].counts) do
            df.global.world.entity_populations [civ.entity_population_index].counts [k] = 0
          end
        end
      end
         
      if current_year == df.global.world.worldgen.worldgen_parms.end_year then
        dfhack.println ()
        dfhack.println ("End report")
        for i, civ in pairs (civ_state) do
          dfhack.print (df.global.world.entities.all [i].entity_raw.translation ..
                        " civ " .. tostring (i) .. " histfig count: " ..
                        tostring (civ.live_histfigs) .. ", population: " ..
                        tostring (civ.entity_population))
       
          if civ.no_histfig_year ~= -1 then
            dfhack.print (" no histfig year: " .. tostring (civ.no_histfig_year) ..
                          " last pop change year: " .. tostring (civ.entity_population_change_year))
          end
       
          if civ.slabbed then
            dfhack.println (" SLABBED " .. dfhack.TranslateName (df.global.world.entities.all [i].name, true))
          elseif civ.entity_population == 0 and civ.live_histfigs == 0 then
            dfhack.println (" Natural death " .. dfhack.TranslateName (df.global.world.entities.all [i].name, true))
          else
            dfhack.println ()
          end
        end
     
        dfhack.println ("slabciv is now done")
      else
        dfhack.timeout (1, 'frames', callback)
      end
   
    else
      dfhack.timeout (1, 'frames', callback)
    end
  end
 
  local started = dfhack.timeout (1, 'frames', callback)
  dfhack.println ("slabciv is now started.")
end

slabciv ()


permit_dead.lua:

Spoiler (click to show/hide)

Code: [Select]

--  Adds dead civs to the pre embark civ list to allow you to embark as them.
--
--[===[
permit_dead
=======
--  This script is started on the embark screen and causes dead playable civs to appear on the list
--  of civs you can select when you embark (on the civ tab screen). Struggling civs culled by DF from
--  the list are not added. This script can be used stand alone or be used in conjunction with slabciv
--  to pick up those civs put to rest by slabciv.
]===]
function permit_dead ()
  local histfigs
  local pops
  local start_id
  local found
 
  if not df.global.gview.view or
     not df.global.gview.view.child or
     not df.global.gview.view.child.available_civs then
    dfhack.color (COLOR_RED)
    dfhack.print("Error: This script is to be run on the pre embark screen")
    dfhack.color(COLOR_RESET)
    dfhack.println()
    return
  end
   
  for i, entity in ipairs (df.global.world.entities.all) do
    if entity.type == df.historical_entity_type.Civilization and
       entity.entity_raw.flags.CIV_CONTROLLABLE then
      histfigs = 0
      pops = 0
           
      for k, pop in ipairs (df.global.world.entity_populations) do
        if pop.civ_id == i then
          for l, count in ipairs (pop.counts) do
            pops = pops + count
          end
       
          break
        end
      end

      start_id = 0
   
      for k, histfig in ipairs (entity.histfig_ids) do
        for l = start_id, #df.global.world.history.figures - 1 do
          if df.global.world.history.figures [l].id == histfig then
            start_id = l
         
            if df.global.world.history.figures [l].died_year == -1 then
              histfigs = histfigs + 1
            end
         
            break
          end
        end
      end
   
      if histfigs == 0 and
         pops == 0 then
        found = false
   
        for k, civ in ipairs (df.global.gview.view.child.available_civs) do
          if civ == entity then
            found = true
            break
          end
        end
   
        if not found then
          df.global.gview.view.child.available_civs:insert ('#', entity)
          dfhack.println ("Permitting embark as " .. dfhack.TranslateName (entity.name, true))
        end
      end
    end
  end
end

permit_dead ()

slabciv is started before generating a world and acts in the background during world gen, while permit_dead is run while on the pre embark screen to extend the civ selection list.

A quirk with permit_dead is that a if you have embarked and abandoned (and presumably also retired) a fortress that civ is neither picked up by DF nor by permit_dead for subsequent embarks.

The scripts are stored in a "text" file as<DF>\hack\scripts\<script name.lua> and are invoked from the DFHack console by typing the script name without the .lua suffix.

Edit: Updated to handle changed field names.
Edit2: Inserted permit_dead, which was missing, for some reason.
Edit 3: For some reason one of the indices was missing (line 159) from slabciv, which has been corrected.

[Fleeting Frames]

Huh. Well, I'll toast to another script solution to worldgen difficulty. I can already see an use, a world that uses more dwarven fortresses for major site control, less population and more scholars, while allowing one to still embark as dead civ so that visitors would be only source of 'migrants' - perhaps at an archeological dig.

I see no reason why not include something like this in a map I'm having dim dream of for 0.45, tbh.

(Alas, it seems I don't generate worlds as often as you do.)

[PatrikLundell]

Actually my intended usage was for the next release to allow artifact disagreements (and possible associated diplomacy) with other dwarven civs while still having my own civ in the twilight zone. However, how it's used depends on the user's wishes. More options is a good thing in my book (as long as that doesn't mean unending mandatory selection of things you don't really care about, of course).
As an aside, I did get some use out of the Breakout Box for this.

Edit: It seems I have bungled the post by missing to apply the code indicator correctly (it was present at the end, but not at the beginning), resulting in all the indices being stripped out of slabciv. Furthermore, my own copy also had the save error, for some reason (which is how I detected it). I believe I've corrected the first post (I've made a test world gen with it, indicating it probably works).

[myk]

@PatrikLundell there has been some interest in these scripts for the current Steam version. Would you consider updating them/allowing them to be updated and included in the DFHack distribution?

[PatrikLundell]

I won't do anything with DF until it becomes playable (i.e. keyboard support has been fully restored).

However, I don't have anything against others continuing to work on, or at least maintain them, (as long as I'm not demanded to fix resulting issues), nor anything against the scripts I've made being incorporated into DFHack.

In my view, such scripts should not be locked in by people not actively working on them.

[myk]

Thank you. I'll see if we can start getting some of your scripts incorporated into the DFHack distribution. You've done a lot of great work!