dfhack/dfhack.init-example

##############################
# Generic dwarfmode bindings #
##############################

# toggle the display of water level as 1-7 tiles
keybinding add Ctrl-W twaterlvl

# with cursor:

# designate the whole vein for digging
keybinding add Ctrl-V digv
keybinding add Ctrl-Shift-V "digv x"

# clean the selected tile of blood etc
keybinding add Ctrl-C spotclean

# destroy items designated for dump in the selected tile
keybinding add Ctrl-Shift-K autodump-destroy-here

# with an item selected:

# destroy the selected item
keybinding add Ctrl-K autodump-destroy-item

# scripts:

# quicksave, only in main dwarfmode screen and menu page
keybinding add Ctrl-Alt-S@dwarfmode/Default quicksave

# gui/rename script - rename units and buildings
keybinding add Ctrl-Shift-N gui/rename
keybinding add Ctrl-Shift-T "gui/rename unit-profession"

# a dfhack prompt in df. Sublime text like.
keybinding add Ctrl-Shift-P command-prompt

##############################
# Generic adv mode bindings  #
##############################

keybinding add Ctrl-B adv-bodyswap
keybinding add Ctrl-Shift-B "adv-bodyswap force"

##############################
# Generic legends bindings   #
##############################

# export all information, or just the detailed maps (doesn't handle site maps)
keybinding add Ctrl-A@legends "exportlegends all"
keybinding add Ctrl-D@legends "exportlegends maps"

#############################
# Context-specific bindings #
#############################

# Stocks plugin
keybinding add Ctrl-Shift-Z@dwarfmode/Default "stocks show"

# open an overview window summarising some stocks (dfstatus)
keybinding add Ctrl-Shift-I@dwarfmode/Default "gui/dfstatus"

# q->stockpile; p - copy & paste stockpiles
keybinding add Alt-P copystock

# q->workshop - duplicate the selected job
keybinding add Ctrl-D job-duplicate

# materials: q->workshop; b->select items
keybinding add Shift-A "job-material ALUNITE"
keybinding add Shift-M "job-material MICROCLINE"
keybinding add Shift-D "job-material DACITE"
keybinding add Shift-R "job-material RHYOLITE"
keybinding add Shift-I "job-material CINNABAR"
keybinding add Shift-B "job-material COBALTITE"
keybinding add Shift-O "job-material OBSIDIAN"
keybinding add Shift-T "job-material ORTHOCLASE"
keybinding add Shift-G "job-material GLASS_GREEN"

# sort units and items in the on-screen list
keybinding add Alt-Shift-N "sort-units name" "sort-items description"
keybinding add Alt-Shift-R "sort-units arrival"
keybinding add Alt-Shift-T "sort-units profession" "sort-items type material"
keybinding add Alt-Shift-Q "sort-units squad_position" "sort-items quality"

# browse linked mechanisms
keybinding add Ctrl-M@dwarfmode/QueryBuilding/Some gui/mechanisms

# browse rooms of same owner
keybinding add Alt-R@dwarfmode/QueryBuilding/Some gui/room-list

# interface for the liquids plugin - spawn water/magma/obsidian
keybinding add Alt-L@dwarfmode/LookAround gui/liquids

# machine power sensitive pressure plate construction
keybinding add Ctrl-Shift-M@dwarfmode/Build/Position/Trap gui/power-meter

# siege engine control
keybinding add Alt-A@dwarfmode/QueryBuilding/Some/SiegeEngine gui/siege-engine

# military weapon auto-select
keybinding add Ctrl-W@layer_military/Equip/Customize/View gui/choose-weapons

# military copy uniform
keybinding add Ctrl-C@layer_military/Uniforms gui/clone-uniform

# minecart Guide path
keybinding add Alt-P@dwarfmode/Hauling/DefineStop/Cond/Guide gui/guide-path

# workshop job details
keybinding add Alt-A@dwarfmode/QueryBuilding/Some/Workshop/Job gui/workshop-job

# workflow front-end
keybinding add Alt-W@dwarfmode/QueryBuilding/Some/Workshop/Job gui/workflow
keybinding add Alt-W@overallstatus "gui/workflow status"

# autobutcher front-end
keybinding add Shift-B@pet/List/Unit "gui/autobutcher"

# assign weapon racks to squads so that they can be used
keybinding add P@dwarfmode/QueryBuilding/Some/Weaponrack gui/assign-rack

############################
# UI and game logic tweaks #
############################

# stabilize the cursor of dwarfmode when switching menus
tweak stable-cursor

# stop military from considering training as 'patrol duty'
tweak patrol-duty

# display creature weight in build plate menu as ??K, instead of (???df: Max
tweak readable-build-plate

# improve FPS by squashing endless item temperature update loops
# tweak stable-temp

# speed up items reaching temp equilibrium with environment by
# capping the rate to no less than 1 degree change per 500 frames
# Note: will also cause stuff to melt faster in magma etc
# tweak fast-heat 500

# stop stacked liquid/bar/thread/cloth items from lasting forever
# if used in reactions that use only a fraction of the dimension.
tweak fix-dimensions

# make reactions requiring containers usable in advmode - the issue is
# that the screen asks for those reagents to be selected directly
tweak advmode-contained

# support Shift-Enter in Trade and Move Goods to Depot screens for faster
# selection; it selects the current item or stack and scrolls down one line
tweak fast-trade

# stop the right list in military->positions from resetting to top all the time
tweak military-stable-assign
# in same list, color units already assigned to squads in brown & green
tweak military-color-assigned

# remove inverse dependency of squad training speed on unit list size and use more sparring
# tweak military-training

# prevent crash if bees die in a hive with ungathered products by insta-gathering them
tweak hive-crash

# make crafted cloth items wear out with time like in old versions (bug 6003)
tweak craft-age-wear

# stop adamantine clothing from wearing out (bug 6481)
#tweak adamantine-cloth-wear

###########################
# Globally acting plugins #
###########################

# Dwarf Manipulator (simple in-game Dwarf Therapist replacement)
enable manipulator

# Search tool in various screens (by falconne)
enable search

# Improved build material selection interface (by falconne)
enable automaterial

# Other interface improvement tools
#enable dwarfmonitor mousequery autotrade buildingplan resume zone

# Auto Syndrome
#autoSyndrome enable

# allow the fortress bookkeeper to queue jobs through the manager
stockflow enable

###########
# Scripts #
###########

# write the correct season to gamelog on world load
soundsense-season

# write identifying information about the fort to gamelog on world load
log-region

# patch the material objects in memory to fix cloth stockpiles
fix/cloth-stockpile enable

# civs don't bring blood
#:lua dfhack.onStateChange.onLoadBloodDel = function(state) if state == SC_WORLD_LOADED then dfhack.run_command('repeat -time 1 -timeUnits months -command fix/blood-del') end end

# run growth bug regularly
#:lua dfhack.onStateChange.onLoadGrowthBug = function(state) if state == SC_WORLD_LOADED then dfhack.run_command('repeat -time 1 -timeUnits months -command fix/growth-bug') end end

#######################################################
# Apply binary patches at runtime                     #
#######################################################
Tweak showmood, add a few validity checks, commit a dfhack.init example. 2012-01-24 04:36:30 -07:00			`##############################`
			`# Generic dwarfmode bindings #`
			`##############################`

Add a way to only count locally-made items in workflow. 2012-11-10 23:58:05 -07:00			`# toggle the display of water level as 1-7 tiles`
Tweak showmood, add a few validity checks, commit a dfhack.init example. 2012-01-24 04:36:30 -07:00			`keybinding add Ctrl-W twaterlvl`

			`# with cursor:`
Add a way to only count locally-made items in workflow. 2012-11-10 23:58:05 -07:00
			`# designate the whole vein for digging`
Fix digv command in init script example 2012-04-08 16:59:22 -06:00			`keybinding add Ctrl-V digv`
			`keybinding add Ctrl-Shift-V "digv x"`
Add a way to only count locally-made items in workflow. 2012-11-10 23:58:05 -07:00
			`# clean the selected tile of blood etc`
Tweak showmood, add a few validity checks, commit a dfhack.init example. 2012-01-24 04:36:30 -07:00			`keybinding add Ctrl-C spotclean`
Add a way to only count locally-made items in workflow. 2012-11-10 23:58:05 -07:00
			`# destroy items designated for dump in the selected tile`
Tweak showmood, add a few validity checks, commit a dfhack.init example. 2012-01-24 04:36:30 -07:00			`keybinding add Ctrl-Shift-K autodump-destroy-here`

Add a way to only count locally-made items in workflow. 2012-11-10 23:58:05 -07:00			`# with an item selected:`

			`# destroy the selected item`
Tweak showmood, add a few validity checks, commit a dfhack.init example. 2012-01-24 04:36:30 -07:00			`keybinding add Ctrl-K autodump-destroy-item`

Add a way to only count locally-made items in workflow. 2012-11-10 23:58:05 -07:00			`# scripts:`

Add an example of focus string usage and a lua command keybinding. 2012-06-06 09:05:07 -06:00			`# quicksave, only in main dwarfmode screen and menu page`
			`keybinding add Ctrl-Alt-S@dwarfmode/Default quicksave`

Add a way to only count locally-made items in workflow. 2012-11-10 23:58:05 -07:00			`# gui/rename script - rename units and buildings`
Support renaming some buildings, and arbitrary units, via gui script. 2012-09-05 11:27:42 -06:00			`keybinding add Ctrl-Shift-N gui/rename`
Fix representation and parsing of built-in materials. The trick is to support both FOO and FOO:NONE for all of them, including INORGANIC[:NONE]. Otherwise the workflow gui scripts have problems. 2012-11-07 02:31:36 -07:00			`keybinding add Ctrl-Shift-T "gui/rename unit-profession"`
Support renaming some buildings, and arbitrary units, via gui script. 2012-09-05 11:27:42 -06:00
Command prompt plugin with docs and readme patch. 2014-02-13 14:55:13 -07:00			`# a dfhack prompt in df. Sublime text like.`
			`keybinding add Ctrl-Shift-P command-prompt`

Add a command for swapping body with another units in adventure mode. Based on dfusion code, with lots of safety checks added. Supports two swap modes: transient and permanent; the former does a minimal change and is intended for managing companion inventory. The permanent one performs all known actions necessary to turn it into the real adventurer. Note: the transient mode is a hack and may cause the game to crash if not reverted while within range of the real adventurer unit. 2012-02-25 06:08:05 -07:00			`##############################`
			`# Generic adv mode bindings #`
			`##############################`

			`keybinding add Ctrl-B adv-bodyswap`
			`keybinding add Ctrl-Shift-B "adv-bodyswap force"`

added two scripts Added scripts `exportlegends` and `log-region`, including init and readme entries. The init file now has a section for legends-mode keybindings. 2014-05-04 22:59:59 -06:00			`##############################`
			`# Generic legends bindings #`
			`##############################`

			`# export all information, or just the detailed maps (doesn't handle site maps)`
			`keybinding add Ctrl-A@legends "exportlegends all"`
			`keybinding add Ctrl-D@legends "exportlegends maps"`

Tweak showmood, add a few validity checks, commit a dfhack.init example. 2012-01-24 04:36:30 -07:00			`#############################`
			`# Context-specific bindings #`
			`#############################`

Add example keybindings 2013-04-24 05:47:37 -06:00			`# Stocks plugin`
			`keybinding add Ctrl-Shift-Z@dwarfmode/Default "stocks show"`

fixed dfstatus script, readme and init entries replaced magic numbers in dfstatus script with `df.item_type.TOKEN`; added dfstatus to readme and init_example; myself to contributors list, updated needs_porting notes and removed script 2014-05-06 20:26:18 -06:00			`# open an overview window summarising some stocks (dfstatus)`
Updated dfhack.init-example for script reorganization. 2014-06-27 01:52:36 -06:00			`keybinding add Ctrl-Shift-I@dwarfmode/Default "gui/dfstatus"`
fixed dfstatus script, readme and init entries replaced magic numbers in dfstatus script with `df.item_type.TOKEN`; added dfstatus to readme and init_example; myself to contributors list, updated needs_porting notes and removed script 2014-05-06 20:26:18 -06:00
Add a way to only count locally-made items in workflow. 2012-11-10 23:58:05 -07:00			`# q->stockpile; p - copy & paste stockpiles`
Tweak showmood, add a few validity checks, commit a dfhack.init example. 2012-01-24 04:36:30 -07:00			`keybinding add Alt-P copystock`

Add a way to only count locally-made items in workflow. 2012-11-10 23:58:05 -07:00			`# q->workshop - duplicate the selected job`
Tweak showmood, add a few validity checks, commit a dfhack.init example. 2012-01-24 04:36:30 -07:00			`keybinding add Ctrl-D job-duplicate`

			`# materials: q->workshop; b->select items`
			`keybinding add Shift-A "job-material ALUNITE"`
			`keybinding add Shift-M "job-material MICROCLINE"`
			`keybinding add Shift-D "job-material DACITE"`
			`keybinding add Shift-R "job-material RHYOLITE"`
			`keybinding add Shift-I "job-material CINNABAR"`
			`keybinding add Shift-B "job-material COBALTITE"`
			`keybinding add Shift-O "job-material OBSIDIAN"`
Implement the common suggestion of Shift-Enter in trade screens. 2012-09-28 03:32:41 -06:00			`keybinding add Shift-T "job-material ORTHOCLASE"`
Tweak showmood, add a few validity checks, commit a dfhack.init example. 2012-01-24 04:36:30 -07:00			`keybinding add Shift-G "job-material GLASS_GREEN"`
Add a script that implements a linked mechanism browser. 2012-08-20 13:04:01 -06:00
Add a way to only count locally-made items in workflow. 2012-11-10 23:58:05 -07:00			`# sort units and items in the on-screen list`
New tweaks for the military assign to position screen. 2012-09-28 08:01:17 -06:00			`keybinding add Alt-Shift-N "sort-units name" "sort-items description"`
			`keybinding add Alt-Shift-R "sort-units arrival"`
			`keybinding add Alt-Shift-T "sort-units profession" "sort-items type material"`
			`keybinding add Alt-Shift-Q "sort-units squad_position" "sort-items quality"`

Add a script that implements a linked mechanism browser. 2012-08-20 13:04:01 -06:00			`# browse linked mechanisms`
			`keybinding add Ctrl-M@dwarfmode/QueryBuilding/Some gui/mechanisms`
Expose a few API functions to lua, and implement a room browser overlay. 2012-08-24 08:26:18 -06:00
			`# browse rooms of same owner`
Add yet one more performance-oriented tweak for temperature updates. 2012-09-14 02:14:36 -06:00			`keybinding add Alt-R@dwarfmode/QueryBuilding/Some gui/room-list`
Expose the liquids plugin engine to lua, and make a wrapper gui script. 2012-08-25 00:37:03 -06:00
Add a way to only count locally-made items in workflow. 2012-11-10 23:58:05 -07:00			`# interface for the liquids plugin - spawn water/magma/obsidian`
Expose the liquids plugin engine to lua, and make a wrapper gui script. 2012-08-25 00:37:03 -06:00			`keybinding add Alt-L@dwarfmode/LookAround gui/liquids`
Add a tweak to save the cursor position of dwarfmode between menus. 2012-08-26 11:19:56 -06:00
Implement a pressure plate sensitive to machine power. When built next to a gearbox, it will monitor its powered state. 2012-09-06 02:37:29 -06:00			`# machine power sensitive pressure plate construction`
			`keybinding add Ctrl-Shift-M@dwarfmode/Build/Position/Trap gui/power-meter`

Add a tweak to fix subtractDimension of small amounts. 2012-09-17 07:19:24 -06:00			`# siege engine control`
			`keybinding add Alt-A@dwarfmode/QueryBuilding/Some/SiegeEngine gui/siege-engine`

Add a script to reclassify 'individual choice' weapons based on unit skill. 2012-09-29 07:21:49 -06:00			`# military weapon auto-select`
			`keybinding add Ctrl-W@layer_military/Equip/Customize/View gui/choose-weapons`

Add a script that clones the currently selected military uniform. To be precise, it applies to the entity uniform templates, not uniforms for specific squad positions. 2014-03-24 09:39:34 -06:00			`# military copy uniform`
			`keybinding add Ctrl-C@layer_military/Uniforms gui/clone-uniform`

Start making a script for viewing and changing minecart Guide paths. 2012-10-11 09:32:41 -06:00			`# minecart Guide path`
			`keybinding add Alt-P@dwarfmode/Hauling/DefineStop/Cond/Guide gui/guide-path`

Add a gui script for viewing and changing job_item properties. 2012-10-20 11:57:36 -06:00			`# workshop job details`
Pass the hotkey keys to dwarfmode from overlays, and fix gui/workshop-job. 2012-10-21 11:45:51 -06:00			`keybinding add Alt-A@dwarfmode/QueryBuilding/Some/Workshop/Job gui/workshop-job`
Add a gui script for viewing and changing job_item properties. 2012-10-20 11:57:36 -06:00
Start working on gui for workflow. 2012-10-23 11:42:03 -06:00			`# workflow front-end`
Remove the C++ version of the job output deduction code and switch to lua. 2012-10-25 02:44:23 -06:00			`keybinding add Alt-W@dwarfmode/QueryBuilding/Some/Workshop/Job gui/workflow`
Implement the history graph in the workflow status screen. 2012-12-01 05:50:03 -07:00			`keybinding add Alt-W@overallstatus "gui/workflow status"`
Start working on gui for workflow. 2012-10-23 11:42:03 -06:00
Added some more commands to autobutcher UI script. Changed autobutcher behavior a bit: now protected units count towards the target quota, units available for adoption are considered as protected. Added filters for caged, male and female to assignement UI for cages, pastures and pits. 2013-04-06 07:10:13 -06:00			`# autobutcher front-end`
			`keybinding add Shift-B@pet/List/Unit "gui/autobutcher"`

Add a script to complement the weapon rack binary patch. 2012-10-27 10:16:27 -06:00			`# assign weapon racks to squads so that they can be used`
			`keybinding add P@dwarfmode/QueryBuilding/Some/Weaponrack gui/assign-rack`

Add yet one more performance-oriented tweak for temperature updates. 2012-09-14 02:14:36 -06:00			`############################`
			`# UI and game logic tweaks #`
			`############################`
Add a tweak to save the cursor position of dwarfmode between menus. 2012-08-26 11:19:56 -06:00
			`# stabilize the cursor of dwarfmode when switching menus`
			`tweak stable-cursor`
Use generic DOCTOR tile for wound dresser labor. 2012-08-30 09:01:43 -06:00
			`# stop military from considering training as 'patrol duty'`
			`tweak patrol-duty`
Add some APIs required by steam engine to the core. 2012-09-02 04:10:58 -06:00
			`# display creature weight in build plate menu as ??K, instead of (???df: Max`
			`tweak readable-build-plate`
Add a tweak to work around the endless temperature update bug. This obsoletes fix/stable-temp.lua, which only fixes items once. 2012-09-03 11:11:35 -06:00
			`# improve FPS by squashing endless item temperature update loops`
Remove stuff that doesn't exist anymore from dfhack.init-example and documentation. 2014-08-15 01:03:25 -06:00			`# tweak stable-temp`
Add yet one more performance-oriented tweak for temperature updates. 2012-09-14 02:14:36 -06:00
			`# speed up items reaching temp equilibrium with environment by`
			`# capping the rate to no less than 1 degree change per 500 frames`
			`# Note: will also cause stuff to melt faster in magma etc`
Remove stuff that doesn't exist anymore from dfhack.init-example and documentation. 2014-08-15 01:03:25 -06:00			`# tweak fast-heat 500`
Add a tweak to fix subtractDimension of small amounts. 2012-09-17 07:19:24 -06:00
			`# stop stacked liquid/bar/thread/cloth items from lasting forever`
			`# if used in reactions that use only a fraction of the dimension.`
			`tweak fix-dimensions`
Add a tweak workaround for the issue with container reactions in advmode. 2012-09-18 07:39:37 -06:00
			`# make reactions requiring containers usable in advmode - the issue is`
			`# that the screen asks for those reagents to be selected directly`
			`tweak advmode-contained`
Implement the common suggestion of Shift-Enter in trade screens. 2012-09-28 03:32:41 -06:00
			`# support Shift-Enter in Trade and Move Goods to Depot screens for faster`
			`# selection; it selects the current item or stack and scrolls down one line`
			`tweak fast-trade`
New tweaks for the military assign to position screen. 2012-09-28 08:01:17 -06:00
			`# stop the right list in military->positions from resetting to top all the time`
			`tweak military-stable-assign`
			`# in same list, color units already assigned to squads in brown & green`
			`tweak military-color-assigned`
Add a script for manipulating binary patches at runtime, and some patches. 2012-11-11 06:24:13 -07:00
Add a tweak to speed up melee squad training. 2012-11-16 11:51:07 -07:00			`# remove inverse dependency of squad training speed on unit list size and use more sparring`
Remove stuff that doesn't exist anymore from dfhack.init-example and documentation. 2014-08-15 01:03:25 -06:00			`# tweak military-training`
Add a tweak to speed up melee squad training. 2012-11-16 11:51:07 -07:00
Fix a crash in beehive code if bees die with yet uncollected products. http://www.bay12games.com/dwarves/mantisbt/view.php?id=6368 2013-08-26 06:55:30 -06:00			`# prevent crash if bees die in a hive with ungathered products by insta-gathering them`
			`tweak hive-crash`

Add new tweaks to NEWS and dfhack.init-example. 2014-05-11 03:19:14 -06:00			`# make crafted cloth items wear out with time like in old versions (bug 6003)`
			`tweak craft-age-wear`

			`# stop adamantine clothing from wearing out (bug 6481)`
			`#tweak adamantine-cloth-wear`

Add built-in enable and disable commands. 2013-09-30 03:19:51 -06:00			`###########################`
			`# Globally acting plugins #`
			`###########################`

			`# Dwarf Manipulator (simple in-game Dwarf Therapist replacement)`
			`enable manipulator`

			`# Search tool in various screens (by falconne)`
			`enable search`

			`# Improved build material selection interface (by falconne)`
			`enable automaterial`

			`# Other interface improvement tools`
			`#enable dwarfmonitor mousequery autotrade buildingplan resume zone`

			`# Auto Syndrome`
			`#autoSyndrome enable`
tweak dfhack.init-example 2013-03-16 06:20:53 -06:00
Stockflow plugin v1.0 2013-05-24 12:43:40 -06:00			`# allow the fortress bookkeeper to queue jobs through the manager`
			`stockflow enable`
tweak dfhack.init-example 2013-03-16 06:20:53 -06:00
Add a script to expose the correct season to soundsense on world load. 2012-12-06 08:00:48 -07:00			`###########`
			`# Scripts #`
			`###########`

			`# write the correct season to gamelog on world load`
			`soundsense-season`

added two scripts Added scripts `exportlegends` and `log-region`, including init and readme entries. The init file now has a section for legends-mode keybindings. 2014-05-04 22:59:59 -06:00			`# write identifying information about the fort to gamelog on world load`
			`log-region`

Add a script to fix cloth stockpiles by patching memory objects. This patching needs to be done every time raws are reloaded. 2013-02-13 02:54:49 -07:00			`# patch the material objects in memory to fix cloth stockpiles`
			`fix/cloth-stockpile enable`

Added example for repeatedly running lua fixes to dfhack.init-example. 2014-06-28 01:01:05 -06:00			`# civs don't bring blood`
Fix repeat comments in dfhack.init-example. 2014-07-09 05:06:30 -06:00			`#:lua dfhack.onStateChange.onLoadBloodDel = function(state) if state == SC_WORLD_LOADED then dfhack.run_command('repeat -time 1 -timeUnits months -command fix/blood-del') end end`
Added example for repeatedly running lua fixes to dfhack.init-example. 2014-06-28 01:01:05 -06:00
			`# run growth bug regularly`
Fix repeat comments in dfhack.init-example. 2014-07-09 05:06:30 -06:00			`#:lua dfhack.onStateChange.onLoadGrowthBug = function(state) if state == SC_WORLD_LOADED then dfhack.run_command('repeat -time 1 -timeUnits months -command fix/growth-bug') end end`
Added example for repeatedly running lua fixes to dfhack.init-example. 2014-06-28 01:01:05 -06:00
Add a script for manipulating binary patches at runtime, and some patches. 2012-11-11 06:24:13 -07:00			`#######################################################`
			`# Apply binary patches at runtime #`
			`#######################################################`