Print

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

[Urist McTeellox]

DFHack Script Collection

Here are a list of additional scripts for DFHack. Please add any you know about to this list:

• announce.lua - Print an announcement to the screen and the gamelog.
• df-ai - a script that plays alone in fortress mode.
• force - Allows forcing of events. Some of them are iffy, some don't work at all. It's mostly functional.
• hackWish - Use a swanky GUI interface to create an item with any material and quality.
• instant transmission - Allows teleportation to units in adventure mode by adventurer. Also gives power level readout.
• itemsyndrome - Allows items to impart syndromes when equipped.
• moddableGods - Allows custom gods to be added as hist figures. They do nothing as of now. Might do something funny next version, but nobody knows what exactly.
• Probability Syndrome - Run AutoSyndrome commands which honour reaction probabilities.
• projectileExpansion - Allows a lot of stuff related to projectiles, such as explosions, syndrome addition and script running-on-creatures.
• rip-heart - removes units heart for a better storage (usually kills in process)
• shapechange - Allows willful polymorph into arbitrary creature with filtering by ID or size.
• skillroll - Allows for skills to be considered when running Lua scripts. Probability Syndrome is probably better for most purposes.
• take-slave - Like hire-guard, but with more transformation. Requires a SLAVE caste for currently played race.
• teleport - Allows simple teleportation of unit to position. Position can be cursor or hardcoded.
• trainskill - Raises the skill level of an unit.
• fovcommand - Executes a dfhack command on targets within the line of sight of an unit.
• callsiege - Causes a random siege, you can set a probability for this to happen.
• naturalSkills - Make sure creatures have their natural skills.
• points - Allows to pick any number of embark points.
• construct-creature - Allows you to construct creatures with reactions that incorporate the reagent materials into the creature's body.  Perfect for robots and golems.
• slam - A simple script that slams a creature into the ground at a given velocity.  Can cause targets to explode at high enough values.
• exile - Sends units away into the wild. Options include fort members, pets, wild animals, invaders, merchants, and diplomats.
• hfspit - Creates a pit under the target leading straight to the underworld.  Instant death to non-fliers.  Very small chance of triggering a demon attack.
• DFHack spells - Set of scripts for more complex interaction based spells
• spawn unit - finally a central place for spawn unit script updates
• heal unit - heal units script
• rubble_fluids module - Functions for easy fluid and minecart interaction from Lua code.
• rubble_fluids command - Test driver and autoSyndrome command for the rubble_fluids module.
• whosout - lists any dorfs who are not in any of the burrows passed as arguments.
• show-cursed - list assumed name of any cursed dorfs
• show-dfhack-version - outputs dfhack release to the console (put it in your dfhack.init)
• show-speeds - Shows current speed and encumbrance for each citizen.
• add-exp - Adds a set amount of experience in a particular skill to a particular unit, and levels them up accordingly.
• timestream - Multiplies the speed of calendar time by the specified value.

This top-post is generated automatically!  You can edit it in markdown format if you think it's missing something.  Be bold with your edits, they're easy to undo!

[Urist McTeellox]

Hi everyone,

Meph nudged me and said it would be great to have a post that keeps track of all the third-party DFHack scripts. And it would be even better if anyone could edit that post to make sure it stay up to date.

As it happens, I have the ability to turn wiki pages into automatically updating phpBB forum posts. So in a couple of minutes this top-post is going to be replaced with wiki content.  In the meantime, you can edit the wiki-page used to generate it here.

I'll also duplicate this information in the second post, so it doesn't get lost. There'll also be a short discussion on how you and do this yourself (all the tools are open source), but only after I've had a coffee.

Many thanks,

~ T

[milo christiansen]

AWSOME! I'll add my announce script right now...

[Meph]

Just as a completion, I will leave this here as well. Its also an announcement script. Its way inferior to milos, since this one has hardcoded announcements in the script, and needs an inorganic/interaction to call it. milo christiansen version adds the announcements into the inorganics/interactions directly, which takes out one work step.

Spoiler: Announcement.lua (click to show/hide)

-- makes custom announcements, for example for important items/events that are created in workshops.
-- needs to be called with autosyndrome, using a boiling rock with synclass:announcement.
-- can also be called with syndrometrigger, for example for a disease system that does not clog up the combat log.

local utils = require 'utils'

local function findCiv(arg)
   local entities = df.global.world.entities.all
   if tonumber(arg) then return arg end
   if arg and not tonumber(arg) then
      for eid,entity in ipairs(entities) do
         if entity.entity_raw.code == arg then return entity end
      end
   end
end

local args = {...}

if not args then qerror("Needs an argument, for example: announcement golem") end

local EventType = args[1]

if not dfhack.isMapLoaded() then
    qerror('Map is not loaded.')
end

local function eventTypeIsNotValid()
   local eventTypes =
   {
   "example1",
   "example2",
   }
   for _,v in ipairs(eventTypes) do
      if args[1] == v then return false end
   end
   return true
end   
   
   -- if your argument doesnt match the list above
if eventTypeIsNotValid() then
   qerror('Invalid argument. You need the name of an announcement to call.')
end

-- here comes your text
-- you can do ~60 symbols before a line-break is added. Keep it short for best effect.
-- color accepts all color tokens that are valid in raws.
-- COLOR_CYAN, COLOR_WHITE, COLOR_MAGENTA, COLOR_RED, COLOR_BLACK, COLOR_GREEN, COLOR_YELLOW, COLOR_GREY, COLOR_BLUE
-- Text accepts all ANSI symbols, even things like ©¥¤¢†‡‰, calling tiles from the tileset.
-- If played without TrueTypeFont, this allows to make announcements that show tiles.

local function announcement_example1()
dfhack.gui.showAnnouncement(
    'The text you will see ingame when you call example 1',
    COLOR_BROWN, true
)
end

local function announcement_example2()
dfhack.gui.showAnnouncement(
    'The text you will see ingame when you call example 2',
    COLOR_BROWN, true
)
end

-- for each announcement you need another line here.
if EventType=="example1" then announcement_example1()
   elseif EventType=="example2" then announcement_example2()
end

-- This script has been made possible by code from Siren.lua, ForceEvent.lua (Putnam) and coding by Meph.

Spoiler: Announcement Readme (click to show/hide)

This script adds announcememts to the game that you can control. You can call them with autosyndrome or syndrometrigger.

You need a inorganic to create in a reaction:
[PRODUCT:0:1:BOULDER:NONE:INORGANIC:ANNOUNCEMENT_EXAMPLE1]

[INORGANIC:ANNOUNCEMENT_EXAMPLE1]
[USE_MATERIAL_TEMPLATE:STONE_VAPOR_TEMPLATE]
[STATE_NAME_ADJ:ALL_SOLID:announcement]
[SYNDROME][SYN_CLASS:\AUTO_SYNDROME]
[SYN_CLASS:\COMMAND]
[SYN_CLASS:announcement]
[SYN_CLASS:example1]

[milo christiansen]

Why don't you take a look at my script
The messages are specified in the raws rather than in the script, so adding new messages is MUCH easier, plus it writes to the gamelog...

(Actually it's not all my script, I made the first version then... (I forget who, one of the DFHack experts) polished up my lua a little, then I made further edits until it was perfect.)

[Putnam]

I decided to be bold and add all of mine.

[Boltgun]

I went bolder in my a few scripts of mine.

[Warmist]

natural skills should be incorporated into spawn unit script really because afaik it's the only source of units not having natural skills set.

[Boltgun]

natural skills should be incorporated into spawn unit script really because afaik it's the only source of units not having natural skills set.

Transformations also cause that, I originally wrote because I was using trueTransform in my mod. However it is true that spawnunit can use this. I'll have a look.

[expwnent]

Posting to watch.

[Putnam]

I'm damn impressed by that AI so far, btw.

[fricy]

ptw

[Meph]

dwarves.rb - type "dwarves #" at the embark selector/map before you embark. It will raise your starting dwarves to the number you entered.

Code: [Select]

# patch start dwarf count

nr = $script_args[0].to_i

raise 'too low' if nr < 7

addr = df.get_global_address('start_dwarf_count')
df.memory_patch(addr, [nr].pack('L'))

points.lua - type "points #" at the embark selector/map before you embark. It will raise your embark points to that number.

Code: [Select]

df.global.world.worldgen.worldgen_parms.embark_points=tonumber(...)

[Roses]

Added a link to my set of scripts.

[IndigoFenix]

I'll add mine as they come out.  I might update occasionally though.
Added constructCreature to start.