Index of DFHack tools

3 | a | b | c | d | e | f | g | h | i | j | k | l | m | n | o | p | q | r | s | t | u | v | w | x | z

	3
	3dveins	Rewrite layer veins to expand in 3D space.
	a
	adaptation	Adjust a unit's cave adaptation level.
	add-recipe	Add crafting recipes to a civ.
	add-spatter (plugin)	Make tagged reactions produce contaminants.
	add-thought	Adds a thought to the selected unit.
	adv-fix-sleepers	Fix units who refuse to awaken in adventure mode.
	adv-max-skills	Raises adventurer stats to max.
	adv-rumors	Improves the rumors menu in adventure mode.
	alias	Configure helper aliases for other DFHack commands.
	animal-control	Quickly view, butcher, or geld groups of animals.
	armoks-blessing	Bless units with superior stats and traits.
	assign-attributes	Adjust physical and mental attributes.
	assign-beliefs	Adjust a unit's beliefs and values.
	assign-facets	Adjust a unit's facets and traits.
	assign-goals	Adjust a unit's goals and dreams.
	assign-minecarts	Assign minecarts to hauling routes.
	assign-preferences	Adjust a unit's preferences.
	assign-profile	Adjust characteristics of a unit according to saved profiles.
	assign-skills	Adjust a unit's skills.
	autobutcher	Automatically butcher excess livestock.
	autochop (plugin)	Auto-harvest trees when low on stockpiled logs.
	autoclothing	Automatically manage clothing work orders.
	autodump (plugin)	Automatically set items in a stockpile to be dumped.
	autodump	Teleports items marked for dumping to the cursor position.
	autodump-destroy-here	Destroy items marked for dumping under the cursor.
	autodump-destroy-item	Destroys the selected item.
	autofarm	Automatically manage farm crop selection.
	autogems (plugin)	Automatically cut rough gems.
	autogems-reload	Reloads the autogems configuration file.
	autohauler	Automatically manage hauling labors.
	autolabor	Automatically manage dwarf labors.
	autolabor-artisans	Configures autolabor to produce artisan dwarves.
	automaterial (plugin)	Sorts building materials by recent usage.
	automelt (plugin)	Quickly designate items to be melted.
	autonestbox	Auto-assign egg-laying female pets to nestbox zones.
	autonick	Give dwarves random unique nicknames.
	autotrade (plugin)	Quickly designate items to be traded.
	autounsuspend	Keep construction jobs unsuspended.
	alltraffic	Set traffic designations for every single tile of the map.
	b
	ban-cooking	Protect entire categories of ingredients from being cooked.
	binpatch	Applies or removes binary patches.
	blueprint	Record a live game map in a quickfort blueprint.
	bodyswap	Take direct control of any visible unit.
	brainwash	Set the personality of a dwarf to an ideal.
	break-dance	Fixes buggy tavern dances.
	build-now	Instantly completes building construction jobs.
	building-hacks (plugin)	Provides a Lua API for creating powered workshops.
	buildingplan	Plan building construction before you have materials.
	burial	Configures all unowned coffins to allow burial.
	burrows (plugin)	Auto-expand burrows as you dig.
	burrow	Quickly add units/tiles to burrows.
	bprobe	Display low-level properties of the selected building.
	c
	cannibalism	Allows a player character to consume sapient corpses.
	caravan	Adjust properties of caravans on the map.
	catsplosion	Cause pregnancies.
	changeitem	Change item material or base quality.
	changelayer	Change the material of an entire geology layer.
	changevein	Change the material of a mineral inclusion.
	channel-safely	Auto-manage channel designations to keep dwarves safe.
	cleanconst	Cleans up construction materials.
	cleaners (plugin)	Provides commands for cleaning spatter from the map.
	clean	Removes contaminants.
	cleanowned	Confiscates and dumps garbage owned by dwarves.
	clear-smoke	Removes all smoke from the map.
	clear-webs	Removes all webs from the map.
	cls	Clear the terminal screen.
	colonies	Manipulate vermin colonies and hives.
	color-schemes	Modify the colors used by the DF UI.
	combat-harden	Set the combat-hardened value on a unit.
	combine-drinks	Merge stacks of drinks in the selected stockpile.
	combine-plants	Merge stacks of plants in the selected container or stockpile.
	command-prompt	An in-game DFHack terminal where you can run other commands.
	confirm	Adds confirmation dialogs for destructive actions.
	create-items	Spawn items under the cursor.
	createitem	Create arbitrary items.
	cursecheck	Check for cursed creatures.
	cxxrandom (plugin)	Provides a Lua API for random distributions.
	cprobe	Display low-level properties of the selected unit.
	copystock	Copies the configuration of the selected stockpile.
	d
	deathcause	Find out the cause of death for a creature.
	debug (plugin)	Provides commands for controlling debug log verbosity.
	debugfilter	Configure verbosity of DFHack debug output.
	deep-embark	Start a fort deep underground.
	deramp	Removes all ramps designated for removal from the map.
	deteriorate	Cause corpses, clothes, and/or food to rot away over time.
	devel/all-bob	Changes the first name of all units to "Bob"..
	devel/annc-monitor	Track announcements and reports and echo them to the console.
	devel/block-borders	Outline map blocks on the map screen.
	devel/check-other-ids	Verify that game entities are referenced by the correct vectors.
	devel/check-release	Perform basic checks for DFHack release readiness.
	devel/clear-script-env	Clear a lua script environment.
	devel/click-monitor	Displays the grid coordinates of mouse clicks in the console.
	devel/cmptiles	List or compare two tiletype material groups.
	devel/dump-offsets	Dump the contents of the table of global addresses.
	devel/dump-rpc	Dump RPC endpoint info.
	devel/eventful-client	Simple client for testing event callbacks.
	devel/export-dt-ini	Export memory addresses for Dwarf Therapist configuration.
	devel/find-offsets	Find memory offsets of DF data structures.
	devel/find-primitive	Discover memory offsets for new variables.
	devel/find-twbt	Display the memory offsets of some important TWBT functions.
	devel/hello-world	A basic GUI example script.
	devel/inject-raws	Add objects and reactions into an existing world.
	devel/inspect-screen	Show glyph and color info for screen tiles.
	devel/kill-hf	Kill a historical figure.
	devel/light	Experiment with lighting overlays.
	devel/list-filters	List input items for the selected building type.
	devel/lsmem	Print memory ranges of the DF process.
	devel/lua-example	An example lua script.
	devel/luacov	Lua script coverage report generator.
	devel/modstate-monitor	Display changes in key modifier state.
	devel/nuke-items	Deletes all free items in the game.
	devel/pop-screen	Forcibly closes the current screen.
	devel/prepare-save	Set internal game state to known values for memory analysis.
	devel/print-args	Echo parameters to the output.
	devel/print-args2	Echo parameters to the output.
	devel/print-event	Show historical events.
	devel/query	Search/print data algorithmically.
	devel/save-version	Display what DF version has handled the current save.
	devel/sc	Scan DF structures for errors.
	devel/scanitemother	Display the item lists that the selected item is part of.
	devel/send-key	Deliver key input to a viewscreen.
	devel/spawn-unit-helper	Prepares the game for spawning creatures by switching to arena.
	devel/test-perlin	Generate an image based on perlin noise.
	devel/unit-path	Inspect where a unit is going and how it's getting there.
	devel/visualize-structure	Display raw memory of a DF data structure.
	devel/watch-minecarts	Inspect minecart coordinates and speeds.
	die	Instantly exit DF without saving.
	dig (plugin)	Provides commands for designating tiles for digging.
	digv	Designate all of the selected vein for digging.
	digvx	Dig a vein across z-levels, digging stairs as needed.
	digl	Dig all of the selected layer stone.
	diglx	Dig layer stone across z-levels, digging stairs as needed.
	digcircle	Designate circles.
	digtype	Designate all vein tiles of the same type as the selected tile.
	digexp	Designate dig patterns for exploratory mining.
	dig-now	Instantly complete dig designations.
	digFlood	Digs out veins as they are discovered.
	diggingInvaders	Invaders dig and destroy to get to your dwarves.
	disable	Deactivate a DFHack tool that has some persistent effect.
	do-job-now	Mark the job related to what you're looking at as high priority.
	drain-aquifer	Remove all aquifers on the map.
	dwarf-op	Tune units to perform underrepresented job roles in your fortress.
	dwarfmonitor	Report on dwarf preferences and efficiency.
	dwarfvet	Allows animals to be treated at animal hospitals.
	e
	elevate-mental	Set mental attributes of a dwarf to an ideal.
	elevate-physical	Set physical attributes of a dwarf to an ideal.
	embark-assistant	Embark site selection support.
	embark-skills	Adjust dwarves' skills when embarking.
	embark-tools	Extend the embark screen functionality.
	emigration	Allow dwarves to emigrate from the fortress when stressed.
	empty-bin	Empty the contents of containers onto the floor.
	enable	Activate a DFHack tool that has some persistent effect.
	eventful (plugin)	Provides a Lua API for reacting to in-game events.
	exportlegends	Exports legends data for external viewing.
	exterminate	Kills things.
	extinguish	Put out fires.
	f
	fastdwarf	Dwarves teleport and/or finish jobs instantly.
	feature	Control discovery flags for map features.
	fillneeds	Temporarily satisfy the needs of a unit.
	filltraffic	Set traffic designations using flood-fill starting at the cursor.
	firestarter	Lights things on fire.
	fix-ster	Toggle infertility for units.
	fix-unit-occupancy	Fix phantom unit occupancy issues.
	fix/blood-del	Removes unusable liquids from caravan manifests.
	fix/corrupt-equipment	Fixes some game crashes caused by corrupt military equipment.
	fix/dead-units	Remove dead units from the list so migrants can arrive again.
	fix/drop-webs	Make floating webs drop to the ground.
	fix/dry-buckets	Allow discarded water buckets to be used again.
	fix/item-occupancy	Fixes errors with phantom items occupying site.
	fix/loyaltycascade	Halts loyalty cascades where dwarves are fighting dwarves.
	fix/population-cap	Ensure the population cap is respected.
	fix/retrieve-units	Allow stuck offscreen units to enter the map.
	fix/stable-temp	Solve FPS issues caused by fluctuating temperature.
	fix/stuck-merchants	Dismiss merchants that are stuck off the edge of the map.
	fix/stuckdoors	Allow doors that are stuck open to close.
	fix/tile-occupancy	Fix tile occupancy flags.
	fixnaked	Removes all unhappy thoughts due to lack of clothing.
	fixveins	Restore missing mineral inclusions.
	flashstep	Teleport your adventurer to the cursor.
	flows	Counts map blocks with flowing liquids.
	follow	Make the screen follow the selected unit.
	force	Trigger in-game events.
	forceequip	Move items into a unit's inventory.
	forget-dead-body	Removes emotions associated with seeing a dead body.
	forum-dwarves	Exports the text you see on the screen for posting to the forums.
	fpause	Forces DF to pause.
	full-heal	Fully heal the selected unit.
	fix-job-postings	Fixes crashes caused by old versions of workflow.
	g
	gaydar	Shows the sexual orientation of units.
	geld	Geld and ungeld animals.
	generated-creature-renamer (plugin)	Automatically renames generated creatures.
	getplants	Designate trees for chopping and shrubs for gathering.
	ghostly	Toggles an adventurer's ghost status.
	growcrops	Instantly grow planted seeds into crops.
	gui/advfort	Perform fort-like jobs in adventure mode.
	gui/autobutcher	Automatically butcher excess livestock.
	gui/autogems	Automatically cut rough gems.
	gui/blueprint	Record a live game map in a quickfort blueprint.
	gui/choose-weapons	Ensure military dwarves choose appropriate weapons.
	gui/clone-uniform	Duplicate an existing military uniform.
	gui/color-schemes	Modify the colors in the DF UI.
	gui/companion-order	Issue orders to companions.
	gui/confirm-opts	Configure which confirmation dialogs are enabled.
	gui/cp437-table	Virtual keyboard for typing with the mouse.
	gui/create-item	Magically summon any item.
	gui/create-tree	Create a tree.
	gui/dfstatus	Show a quick overview of critical stock quantities.
	gui/extended-status	Add information on beds and bedrooms to the status screen.
	gui/family-affairs	Inspect or meddle with romantic relationships.
	gui/gm-editor	Inspect and edit DF game data.
	gui/gm-unit	Inspect and edit unit attributes.
	gui/guide-path	Visualize minecart guide paths.
	gui/kitchen-info	Show food item uses in the kitchen status screen.
	gui/launcher	In-game DFHack command launcher with integrated help.
	gui/liquids	Interactively paint liquids or obsidian onto the map.
	gui/load-screen	Replace DF's continue game screen with a searchable list.
	gui/manager-quantity	Set the quantity of the selected manager workorder.
	gui/mass-remove	Mass select buildings and constructions to suspend or remove.
	gui/mechanisms	List mechanisms and links connected to a building.
	gui/mod-manager	Easily install and uninstall mods.
	gui/overlay	Manage DFHack overlays and overlay widgets.
	gui/pathable	Highlights reachable tiles.
	gui/petitions	Show information about your fort's petitions.
	gui/power-meter	Allow pressure plates to measure power.
	gui/prerelease-warning	Shows a warning if you are using a pre-release build of DFHack.
	gui/quantum	Quickly and easily create quantum stockpiles.
	gui/quickcmd	Quickly run saved commands.
	gui/quickfort	Apply pre-designed blueprints to your fort.
	gui/rename	Give buildings and units new names, optionally with special chars.
	gui/room-list	Manage rooms owned by a dwarf.
	gui/settings-manager	Dynamically adjust global DF settings.
	gui/siege-engine	Extend the functionality and usability of siege engines.
	gui/stamper	Copy, paste, and transform dig designations.
	gui/stockpiles	Import and export stockpile settings.
	gui/teleport	Teleport a unit anywhere.
	gui/unit-info-viewer	Display detailed information about a unit.
	gui/workflow	Manage automated item production rules.
	gui/workorder-details	Adjust input materials and traits for workorders.
	gui/workshop-job	Adjust the input materials used for a job at a workshop.
	h
	help	Display help about a command or plugin.
	hermit	Go it alone in your fortress and attempt the hermit challenge.
	hfs-pit	Creates a pit straight to the underworld.
	hide	Hide the DFHack terminal window.
	hotkey-notes	Show info on DF map location hotkeys.
	hotkeys	Show all DFHack keybindings for the current context.
	i
	infiniteSky	Automatically allocate new z-levels of sky
	install-info	Exports information about DFHack for bug reports.
	isoworldremote (plugin)	Provides a remote API used by Isoworld.
	j
	jobutils (plugin)	Provides commands for interacting with jobs.
	job	Inspect or modify details of workshop jobs.
	job-duplicate	Duplicates the highlighted job.
	job-material	Alters the material of the selected job.
	k
	keybinding	Create hotkeys that will run DFHack commands.
	kill-lua	Gracefully stop any currently-running Lua scripts.
	l
	load-art-image-chunk	Gets an art image chunk by index.
	list-generated	List the token names of all generated creatures.
	labormanager	Automatically manage dwarf labors.
	lair	Mark the map as a monster lair.
	launch	Thrash your enemies with a flying suplex.
	lever	Inspect and pull levers.
	light-aquifers-only	Change heavy and varied aquifers to light aquifers.
	linger	Take control of your adventurer's killer.
	liquids	Place magma, water or obsidian.
	liquids-here	Spawn liquids on the selected tile.
	list-agreements	List guildhall and temple agreements.
	list-waves	Show migration wave information for your dwarves.
	load	Load and register a plugin library.
	load-save	Load a savegame.
	locate-ore	Scan the map for metal ores.
	ls	List available DFHack commands.
	lua	Run Lua script commands.
	luasocket (plugin)	Provides a Lua API for accessing network sockets.
	loadstock	Imports the configuration of the selected stockpile.
	m
	make-legendary	Boost skills of the selected dwarf.
	make-monarch	Crown the selected unit as a monarch.
	manipulator (plugin)	An in-game labor management interface.
	map-render (plugin)	Provides a Lua API for re-rendering portions of the map.
	markdown	Exports the text you see on the screen for posting online.
	masspit	Designate creatures for pitting.
	max-wave	Dynamically limit the next immigration wave.
	migrants-now	Trigger a migrant wave.
	misery	Increase the intensity of negative dwarven thoughts.
	mode	See and change the game mode.
	modtools/add-syndrome	Add and remove syndromes from units.
	modtools/anonymous-script	Run dynamically generated script code.
	modtools/change-build-menu	Add or remove items from the build sidebar menus.
	modtools/create-item	Create arbitrary items.
	modtools/create-tree	Spawn trees.
	modtools/create-unit	Create arbitrary units.
	modtools/equip-item	Force a unit to equip an item.
	modtools/extra-gamelog	Write info to the gamelog for Soundsense.
	modtools/fire-rate	Alter the fire rate of ranged weapons.
	modtools/force	Trigger game events.
	modtools/if-entity	Run DFHack commands based on current civ id.
	modtools/interaction-trigger	Run DFHack commands when a unit attacks or defends.
	modtools/invader-item-destroyer	Destroy invader items when they die.
	modtools/item-trigger	Run DFHack commands when a unit uses an item.
	modtools/moddable-gods	Create deities.
	modtools/outside-only	Set building inside/outside restrictions.
	modtools/pref-edit	Modify unit preferences.
	modtools/projectile-trigger	Run DFHack commands when projectiles hit their targets.
	modtools/random-trigger	Randomly select DFHack scripts to run.
	modtools/raw-lint	Check for errors in raw files.
	modtools/reaction-product-trigger	Call DFHack commands when reaction products are produced.
	modtools/reaction-trigger	Run DFHack commands when custom reactions complete.
	modtools/reaction-trigger-transition	Help create reaction triggers.
	modtools/set-belief	Change the beliefs/values of a unit.
	modtools/set-need	Change the needs of a unit.
	modtools/set-personality	Change a unit's personality.
	modtools/skill-change	Modify unit skills.
	modtools/spawn-flow	Creates flows at the specified location.
	modtools/spawn-liquid	Spawn water or lava.
	modtools/syndrome-trigger	Trigger DFHack commands when units acquire syndromes.
	modtools/transform-unit	Transform a unit into another unit type.
	mousequery	Adds mouse controls to the DF interface.
	multicmd	Run multiple DFHack commands.
	n
	names	Rename units or items with the DF name generator.
	nestboxes (plugin)	Protect fertile eggs incubating in a nestbox.
	nopause	Disable pausing.
	o
	on-new-fortress	Run commands when a fortress is first started.
	once-per-save	Run commands only if they haven't been run before in this world.
	open-legends	Open a legends screen from fort or adventure mode.
	orders	Manage manager orders.
	overlay	Manage on-screen overlay widgets.
	p
	pathable (plugin)	Marks tiles that are reachable from the cursor.
	petcapRemover	Modify the pet population cap.
	plants (plugin)	Provides commands that interact with plants.
	plant	Create a plant or make an existing plant grow up.
	plug	List available plugins and whether they are enabled.
	points	Sets available points at the embark screen.
	pop-control	Controls population and migration caps persistently per-fort.
	position	Report cursor and mouse position, along with other info.
	power-meter (plugin)	Allow pressure plates to measure power.
	pref-adjust	Set the preferences of a dwarf to an ideal.
	prefchange	Set strange mood preferences.
	prioritize	Automatically boost the priority of selected job types.
	probe	Display low-level properties of the selected tile.
	prospector (plugin)	Provides commands that help you analyze natural resources.
	prospect	Shows a summary of resources that exist on the map.
	putontable	Make an item appear on a table.
	q
	questport	Teleport to your quest log map cursor.
	quickfort	Apply pre-designed blueprints to your fort.
	quicksave	Immediately save the game.
	r
	RemoteFortressReader (plugin)	Backend for Armok Vision.
	RemoteFortressReader_version	Print the loaded RemoteFortressReader version.
	restrictice	Restrict traffic on all tiles on top of visible ice.
	restrictliquids	Restrict traffic on all visible tiles with liquid.
	region-pops	Change regional animal populations.
	regrass	Regrow all the grass.
	rejuvenate	Sets unit age to 20 years.
	reload	Reload a loaded plugin.
	remove-stress	Reduce stress values for fortress dwarves.
	remove-wear	Remove wear from items in your fort.
	rename	Easily rename things.
	rendermax	Modify the map lighting.
	repeat	Call a DFHack command at a periodic interval.
	resurrect-adv	Bring a dead adventurer back to life.
	reveal	Reveals the map.
	revforget	Discard records about what was visible before revealing the map.
	revtoggle	Switch between reveal and unreveal.
	revflood	Hide everything, then reveal tiles with a path to the cursor.
	reveal-adv-map	Reveal or hide the world map.
	reveal-hidden-sites	Reveal all sites in the world.
	reveal-hidden-units	Reveal sneaking units.
	ruby (plugin)	Allow Ruby scripts to be executed as DFHack commands.
	rb	Eval() a ruby string.
	rb_eval	Eval() a ruby string.
	s
	spotclean	Remove all contaminants from the tile under the cursor.
	save-generated-raws	Export a creature graphics file for modding.
	sc-script	Run commands when game state changes occur.
	script	Execute a batch file of DFHack commands.
	search (plugin)	Adds search capabilities to the UI.
	season-palette	Swap color palettes when the seasons change.
	seedwatch	Manages seed and plant cooking based on seed stock levels.
	set-orientation	Alter a unit's romantic inclinations.
	set-timeskip-duration	Modify the duration of the pre-game world update.
	setfps	Set the graphics FPS cap.
	show	Unhides the DFHack terminal window.
	show-unit-syndromes	Inspect syndrome details.
	showmood	Shows all items needed for the active strange mood.
	siege-engine (plugin)	Extend the functionality and usability of siege engines.
	siren	Wake up sleeping units and stop parties.
	sort (plugin)	Sort lists shown in the DF interface.
	sort-items	Sort the visible item list.
	sort-units	Sort the visible unit list.
	source	Create an infinite magma or water source.
	spawnunit	Create a unit.
	spectate	Automatically follow productive dwarves.
	startdwarf	Increase the number of dwarves you embark with.
	starvingdead	Prevent infinite accumulation of roaming undead.
	steam-engine (plugin)	Allow modded steam engine buildings to function.
	stockflow	Queue manager jobs based on free space in stockpiles.
	stockpiles (plugin)	Import and export stockpile settings.
	savestock	Exports the configuration of the selected stockpile.
	stocks	Enhanced fortress stock management interface.
	stonesense	A 3D isometric visualizer.
	ssense	An alias for stonesense.
	strangemood	Trigger a strange mood.
	stripcaged	Remove items from caged prisoners.
	superdwarf	Make a dwarf supernaturally speedy.
	t
	tags	List the categories of DFHack tools or the tools with those tags.
	tailor	Automatically keep your dwarves in fresh clothing.
	tame	Tame and train animals.
	teleport	Teleport a unit anywhere.
	tidlers	Change where the idlers count is displayed.
	tiletypes	Paints tiles of specified types onto the map.
	tiletypes-command	Run tiletypes commands.
	tiletypes-here	Paint map tiles starting from the cursor.
	tiletypes-here-point	Paint the map tile under the cursor.
	timestream	Fix FPS death.
	title-folder (plugin)	Displays the DF folder name in the window title bar.
	title-version (plugin)	Displays the DFHack version on DF's title screen.
	trackstop (plugin)	Add dynamic configuration options for track stops.
	troubleshoot-item	Inspect properties of the selected item.
	tubefill	Replenishes mined-out adamantine.
	twaterlvl	Show/hide numeric liquid depth on the map.
	tweak	A collection of tweaks and bugfixes.
	type	Describe how a command is implemented.
	u
	unreveal	Hides previously hidden tiles again.
	undump-buildings	Undesignate building base materials for dumping.
	unforbid	Unforbid all items.
	ungeld	Undo gelding for an animal.
	uniform-unstick	Make military units reevaluate their uniforms.
	unload	Unload a plugin from memory.
	unretire-anyone	Adventure as any living historical figure.
	unsuspend	Unsuspends building construction jobs.
	v
	view-item-info	Extend item and unit descriptions with more information.
	view-unit-reports	Show combat reports for a unit.
	w
	warn-starving	Report units that are dangerously hungry, thirsty, or drowsy.
	warn-stealers	Watch for and warn about units that like to steal your stuff.
	weather	Change the weather.
	workNow	Reduce the time that dwarves idle after completing a job.
	workflow	Manage automated item production rules.
	workorder	Create manager workorders.
	workorder-recheck	Recheck start conditions for a manager workorder.
	x
	xlsxreader (plugin)	Provides a Lua API for reading xlsx files.
	z
	zone	Manage activity zones, cages, and the animals therein.