MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Format more of the NEWS file

develop
PeridexisErrant 2015-10-20 13:29:46 +11:00
parent 18d2bc6183
commit fb2fdd0e89
5 changed files with 302 additions and 191 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

425
NEWS.rst
Unescape Escape View File

@ -24,7 +24,7 @@ Changelog
######### #########
.. contents:: .. contents::
:depth: 1 :depth: 2
DFHack Future DFHack Future
@ -232,140 +232,172 @@ Misc Improvements
DFHack 0.40.24-r2 DFHack 0.40.24-r2
================= =================
::
Internals Internals
Lua scripts can set environment variables of each other with dfhack.run_script_with_env. ---------
Lua scripts can now call each others internal nonlocal functions with dfhack.script_environment(scriptName).functionName(arg1,arg2). - Lua scripts can set environment variables of each other with dfhack.run_script_with_env.
eventful Lua reactions no longer require LUA_HOOK as a prefix: you can register a - Lua scripts can now call each others internal nonlocal functions with dfhack.script_environment(scriptName).functionName(arg1,arg2).
callback for the completion of any reaction with a name - `eventful`: Lua reactions no longer require LUA_HOOK as a prefix; you can register a callback for the completion of any reaction with a name
Filesystem module now provides file access/modification times and can list directories (normally and recursively) - Filesystem module now provides file access/modification times and can list directories (normally and recursively)
Units Module: New functions: - Units Module: New functions::
isWar
isHunter isWar
isAvailableForAdoption isHunter
isOwnCiv isAvailableForAdoption
isOwnRace isOwnCiv
getRaceName isOwnRace
getRaceNamePlural getRaceName
getRaceBabyName getRaceNamePlural
getRaceChildName getRaceBabyName
isBaby getRaceChildName
isChild isBaby
isAdult isChild
isEggLayer isAdult
isGrazer isEggLayer
isMilkable isGrazer
isTrainableWar isMilkable
isTrainableHunting isTrainableWar
isTamable isTrainableHunting
isMale isTamable
isFemale isMale
isMerchant isFemale
isForest isMerchant
isMarkedForSlaughter isForest
Buildings Module: New Functions: isMarkedForSlaughter
isActivityZone
isPenPasture - Buildings Module: New Functions::
isPitPond
isActive isActivityZone
findPenPitAt isPenPasture
Fixes isPitPond
dfhack.run_script should correctly find save-specific scripts now. isActive
Updated add-thought to properly affect stress. findPenPitAt
hfs-pit should work now
Autobutcher takes gelding into account Fixes
init.lua existence checks should be more reliable (notably when using non-English locales) -----
Misc Improvements - ``dfhack.run_script`` should correctly find save-specific scripts now.
Multiline commands are now possible inside dfhack.init scripts. See dfhack.init-example for example usage. - `add-thought`: updated to properly affect stress.
- `hfs-pit`: should work now
- `autobutcher`: takes gelding into account
- init.lua existence checks should be more reliable (notably when using non-English locales)
Misc Improvements
-----------------
Multiline commands are now possible inside dfhack.init scripts. See :file:`dfhack.init-example` for example usage.
DFHack 0.40.24-r1 DFHack 0.40.24-r1
================= =================
::
Internals Internals
CMake shouldn't cache DFHACK_RELEASE anymore. People may need to manually update/delete ---------
their CMake cache files to get rid of it. CMake shouldn't cache DFHACK_RELEASE anymore. People may need to manually update/delete their CMake cache files to get rid of it.
DFHack 0.40.24-r0 DFHack 0.40.24-r0
================= =================
::
Internals Internals
EventManager: fixed crash error with EQUIPMENT_CHANGE event. ---------
key modifier state exposed to Lua - `EventManager`: fixed crash error with EQUIPMENT_CHANGE event.
Fixes - key modifier state exposed to Lua (ie :kbd:`Ctrl`, :kbd:`Alt`, :kbd:`Shift`)
dfhack script can now be run from other directories on OSX
New Plugins Fixes
blueprint: export part of your fortress to quickfort .csv files -----
New Scripts ``dfhack.sh`` can now be run from other directories on OSX
hotkey-notes: print key, name, and jump position of hotkeys
Removed New Plugins
embark.lua -----------
needs_porting/* - `blueprint`: export part of your fortress to quickfort .csv files
Misc Improvements
added support for searching more lists New Scripts
-----------
- `hotkey-notes`: print key, name, and jump position of hotkeys
Removed
-------
- embark.lua
- needs_porting/*
Misc Improvements
-----------------
Added support for searching more lists
DFHack 0.40.23-r1 DFHack 0.40.23-r1
================= =================
::
Internals Internals
plugins will not be loaded if globals they specify as required are not located (should prevent some crashes) - plugins will not be loaded if globals they specify as required are not located (should prevent some crashes)
Fixes
Fixed numerous (mostly Lua-related) crashes on OS X by including a more up-to-date libstdc++ Fixes
Alt should no longer get stuck on Windows (and perhaps other platforms as well) -----
advfort works again - Fixed numerous (mostly Lua-related) crashes on OS X by including a more up-to-date libstdc++
autobutcher takes sexualities into account - :kbd:`Alt` should no longer get stuck on Windows (and perhaps other platforms as well)
devel/export-dt-ini: Updated for 0.40.20+ - `gui/advfort` works again
digfort: now checks file type and existence - `autobutcher`: takes sexualities into account
exportlegends: Fixed map export - devel/export-dt-ini: Updated for 0.40.20+
full-heal: Fixed a problem with selecting units in the GUI - `digfort`: now checks file type and existence
gui/hack-wish: Fixed restrictive material filters - `exportlegends`: Fixed map export
mousequery: Changed box-select key to Alt+M - `full-heal`: Fixed a problem with selecting units in the GUI
plugins/dwarfmonitor: correct date display (month index, separator) - `gui/hack-wish`: Fixed restrictive material filters
scripts/putontable: added to the readme - `mousequery`: Changed box-select key to Alt+M
siren should work again - `dwarfmonitor`: correct date display (month index, separator)
stderr.log: removed excessive debug output on OS X - `putontable`: added to the readme
trackstop: No longer prevents cancelling the removal of a track stop or roller. - `siren` should work again
Fixed a display issue with PRINT_MODE:TEXT - stderr.log: removed excessive debug output on OS X
Fixed a symbol error (MapExtras::BiomeInfo::MAX_LAYERS) when compiling DFHack in Debug mode - `trackstop`: No longer prevents cancelling the removal of a track stop or roller.
New Plugins - Fixed a display issue with ``PRINT_MODE:TEXT``
fortplan: designate construction of (limited) buildings from .csv file, quickfort-style - Fixed a symbol error (MapExtras::BiomeInfo::MAX_LAYERS) when compiling DFHack in Debug mode
New Scripts
gui/stockpiles: an in-game interface for saving and loading stockpile New Plugins
settings files. -----------
position: Reports the current date, time, month, and season, plus - `fortplan`: designate construction of (limited) buildings from .csv file, quickfort-style
some location info. Port/update of position.py
hfs-pit: Digs a hole to hell under the cursor. Replaces needs_porting/hellhole.cpp New Scripts
Removed -----------
embark.lua: Obsolete, use `embark-tools` - `gui/stockpiles`: an in-game interface for saving and loading stockpile settings files.
New tweaks: - `position`: Reports the current date, time, month, and season, plus some location info. Port/update of position.py
eggs-fertile: Displays an egg fertility indicator on nestboxes - `hfs-pit`: Digs a hole to hell under the cursor. Replaces needs_porting/hellhole.cpp
max-wheelbarrow: Allows assigning more than 3 wheelbarrows to a stockpile
Misc Improvements Removed
embark-tools: Added basic mouse support on the local map -------
Made some adventure mode keybindings in dfhack.init-example only work in adventure mode - embark.lua: Obsolete, use `embark-tools`
Added a default keybinding for "gui/companion-order"
further work on needs_porting New tweaks
----------
- `eggs-fertile <tweak>`: Displays an egg fertility indicator on nestboxes
- `max-wheelbarrow <tweak>`: Allows assigning more than 3 wheelbarrows to a stockpile
Misc Improvements
-----------------
- `embark-tools`: Added basic mouse support on the local map
- Made some adventure mode keybindings in :file:`dfhack.init-example` only work in adventure mode
- `gui/companion-order`: added a default keybinding
- further work on needs_porting
DFHack 0.40.19-r1 DFHack 0.40.19-r1
================= =================
::
Fixes: Fixes
typo fix in modtools/reaction-trigger -----
modtools/item-trigger should now work with item types - `modtools/reaction-trigger`: fixed typo
New plugins: - `modtools/item-trigger`: should now work with item types
savestock and loadstock: two commands for saving and loading
stockpile settings to a file. They can be used to migrate stockpile New plugins
settings between worlds and saves. -----------
New scripts: - `savestock, loadstock <stocksettings>`: save and load stockpile settings across worlds and saves
remove-stress [all]: set selected or all units unit to -1,000,000 stress
this script replaces removebadthoughts.rb New scripts
Misc improvements: -----------
cmd-prompt can now access selected items, units, and buildings - `remove-stress`: set selected or all units unit to -1,000,000 stress (this script replaces removebadthoughts)
autolabor plugin: add an optional talent pool parameter
Misc improvements
-----------------
- `command-prompt`: can now access selected items, units, and buildings
- `autolabor`: add an optional talent pool parameter
DFHack 0.40.16-r1 DFHack 0.40.16-r1
================= =================
@ -414,96 +446,113 @@ DFHack 0.40.16-r1
DFHack 0.40.15-r1 DFHack 0.40.15-r1
================= =================
::
Fixes: Fixes
- mousequery: Fixed behavior when selecting a tile on the lowest z-level -----
Internals: - mousequery: Fixed behavior when selecting a tile on the lowest z-level
- EventManager: deals with frame_counter getting reset properly now.
- modtools/item-trigger: fixed equip/unequip bug and corrected minor documentation error Misc Improvements
- teleport: Updated with proper argument handling and proper unit-at-destination handling. -----------------
- autotrade: Removed the newly obsolete "Mark all" functionality. - `EventManager`: deals with frame_counter getting reset properly now.
- search: Adapts to the new trade screen column width - `modtools/item-trigger`: fixed equip/unequip bug and corrected minor documentation error
- tweak fast-trade: Switching the fast-trade keybinding to Shift-Up/Shift-Down, due to Select All conflict - `teleport`: Updated with proper argument handling and proper unit-at-destination handling.
- `autotrade <Stockpile automation>`: Removed the newly obsolete :guilabel:`Mark all` functionality.
- `search`: Adapts to the new trade screen column width
- `tweak fast-trade <tweak>`: Switching the fast-trade keybinding to Shift-Up/Shift-Down, due to Select All conflict
DFHack 0.40.14-r1 DFHack 0.40.14-r1
================= =================
::
Internals: Internals
- The DFHack console can now be disabled by setting the DFHACK_DISABLE_CONSOLE ---------
environment variable: "DFHACK_DISABLE_CONSOLE=1 ./dfhack" - The DFHack console can now be disabled by setting the DFHACK_DISABLE_CONSOLE environment variable: ``DFHACK_DISABLE_CONSOLE=1 ./dfhack``
Fixes:
- Stopped duplicate load/unload events when unloading a world Fixes
- Stopped "-e" from being echoed when DFHack quits on Linux -----
- automelt now uses a faster method to locate items - Stopped duplicate load/unload events when unloading a world
- autotrade: "Mark all" no longer double-marks bin contents - Stopped ``-e`` from being echoed when DFHack quits on Linux
- drainaquifer.rb: replaced with a faster less buggy drain-aquifer.lua - `automelt <Stockpile automation>`: now uses a faster method to locate items
- embark-tools no longer conflicts with keys on the notes screen - `autotrade <Stockpile automation>`: "Mark all" no longer double-marks bin contents
- fastdwarf: Fixed problems with combat/attacks - `drain-aquifer`: new script replaces the buggy plugin
- forum-dwarves should work now - `embark-tools`: no longer conflicts with keys on the notes screen
- manipulator now uses a stable sort, allowing sorting by multiple categories - `fastdwarf`: Fixed problems with combat/attacks
- rendermax updated to work with 0.40 - `forum-dwarves`: should work now
New plugins: - `manipulator`: now uses a stable sort, allowing sorting by multiple categories
- trackstop: Shows track stop friction and dump direction in its 'q' menu - `rendermax`: updated to work with 0.40
New tweaks:
- farm-plot-select: Adds "Select all" and "Deselect all" options to farm plot menus New Plugins
- import-priority-category: Allows changing the priority of all goods in a -----------
category when discussing an import agreement with the liaison - `trackstop`: Shows track stop friction and dump direction in its :kbd:`q` menu
- manager-quantity: Removes the limit of 30 jobs per manager order
- civ-view-agreement: Fixes overlapping text on the "view agreement" screen New Tweaks
- nestbox-color: Fixes the color of built nestboxes ----------
Misc Improvements: - farm-plot-select: Adds "Select all" and "Deselect all" options to farm plot menus
- exportlegends.lua can now handle site maps - import-priority-category: Allows changing the priority of all goods in a category when discussing an import agreement with the liaison
- manager-quantity: Removes the limit of 30 jobs per manager order
- civ-view-agreement: Fixes overlapping text on the "view agreement" screen
- nestbox-color: Fixes the color of built nestboxes
Misc Improvements
-----------------
- `exportlegends`: can now handle site maps
DFHack 0.40.13-r1 DFHack 0.40.13-r1
================= =================
::
Internals: Internals
- unified spatter structs ---------
- added ruby df.print_color(color, string) method for dfhack console - unified spatter structs
Fixes: - added ruby df.print_color(color, string) method for dfhack console
- no more -e after terminating
- fixed superdwarf Fixes
-----
- no more ``-e`` after terminating
- fixed `superdwarf`
DFHack 0.40.12-r1 DFHack 0.40.12-r1
================= =================
::
Fixes: Internals
- possible crash fixed for hack-wish ---------
- updated search to not conflict with BUILDJOB_SUSPEND - support for global :file:`onLoadWorld.init` and :file:`onUnloadWorld.init` files, called when loading and unloading a world
- workflow: job_material_category -> dfhack_material_category - Close file after loading a binary patch.
New plugins: New Plugins
- hotkeys (by Falconne): Shows ingame viewscreen with all dfhack keybindings active in current mode. -----------
- automelt: allows marking stockpiles for automelt - `hotkeys`: Shows ingame viewscreen with all dfhack keybindings active in current mode.
(i.e. any items placed in stocpile will be designated for melting) - `automelt <Stockpile automation>`: allows marking stockpiles so any items placed in them will be designated for melting
Fixes
-----
- possible crash fixed for `gui/hack-wish`
- `search`: updated to not conflict with BUILDJOB_SUSPEND
- `workflow`: job_material_category -> dfhack_material_category
Misc Improvements: Misc Improvements
- now you can use @ to print things in interactive Lua with subtley different semantics -----------------
- optimizations for stockpiles for autotrade and stockflow - now you can use ``@`` to print things in interactive Lua with subtley different semantics
- updated exportlegends.lua to work with new maps, dfhack 40.11 r1+ - optimizations for stockpiles for `autotrade <Stockpile automation>` and `stockflow`
- updated `exportlegends` to work with new maps, dfhack 40.11 r1+
Internals:
- support for global onLoadWorld.init and onUnloadWorld.init files,
called when loading and unloading a world
- Close file after loading a binary patch.
DFHack 0.40.11-r1 DFHack 0.40.11-r1
================= =================
::
Internals: Internals
- Plugins on OS X now use ".plug.dylib" as an extension instead of ".plug.so" - Plugins on OS X now use ``.plug.dylib` as an extension instead of ``.plug.so``
Fixes:
- 3dveins should no longer hang/crash on specific maps Fixes
- Fixed some autotrade and search layout issues -----
- Updated deathcause - `3dveins`: should no longer hang/crash on specific maps
- hack-wish should work now - `autotrade <Stockpile automation>`, `search`: fixed some layout issues
- reveal no longer allocates data for nonexistent map blocks - `deathcause`: updated
- Various documentation fixes and updates - `gui/hack-wish`: should work now
- `reveal`: no longer allocates data for nonexistent map blocks
- Various documentation fixes and updates
DFHack v0.40.10-r1 DFHack v0.40.10-r1
================== ==================

2
docs/Lua API.rst
Unescape Escape View File

@ -3291,6 +3291,8 @@ List of events
Is called after calling (or not) native fillSidebarMenu(). Useful for job button Is called after calling (or not) native fillSidebarMenu(). Useful for job button
tweaking (e.g. adding custom reactions) tweaking (e.g. adding custom reactions)
.. _EventManager:
Events from EventManager Events from EventManager
------------------------ ------------------------
These events are straight from EventManager module. Each of them first needs to be enabled. See functions for more info. If you register a listener before the game is loaded, be aware that no events will be triggered immediately after loading, so you might need to add another event listener for when the game first loads in some cases. These events are straight from EventManager module. Each of them first needs to be enabled. See functions for more info. If you register a listener before the game is loaded, be aware that no events will be triggered immediately after loading, so you might need to add another event listener for when the game first loads in some cases.

24
docs/Plugins.rst
Unescape Escape View File

@ -46,6 +46,8 @@ dwarfexport
----------- -----------
Export dwarves to RuneSmith-compatible XML; also unused by modern tools. Export dwarves to RuneSmith-compatible XML; also unused by modern tools.
.. _blueprint:
blueprint blueprint
--------- ---------
Exports a portion of your fortress into QuickFort style blueprint files.:: Exports a portion of your fortress into QuickFort style blueprint files.::
@ -354,6 +356,12 @@ UI Upgrades
When that is not appropriate because they merely add keybinding hints to When that is not appropriate because they merely add keybinding hints to
existing DF screens, they deliberately use red instead of green for the key. existing DF screens, they deliberately use red instead of green for the key.
.. _hotkeys:
hotkeys
=======
Shows the DFHack keybindings active on the current screen.
.. _manipulator: .. _manipulator:
manipulator manipulator
@ -451,6 +459,8 @@ using Permit Fats again while the list is filtered.
Game interface Game interface
============== ==============
.. _embark-tools:
embark-tools embark-tools
------------ ------------
A collection of embark-related tools. A collection of embark-related tools.
@ -533,6 +543,8 @@ Makes the game view follow the currently highlighted unit after you exit from th
current menu or cursor mode. Handy for watching dwarves running around. Deactivated current menu or cursor mode. Handy for watching dwarves running around. Deactivated
by moving the view manually. by moving the view manually.
.. _mousequery:
mousequery mousequery
---------- ----------
Adds mouse controls to the DF interface, eg click-and-drag designations. Adds mouse controls to the DF interface, eg click-and-drag designations.
@ -561,6 +573,8 @@ tidlers
------- -------
Toggle between all possible positions where the idlers count can be placed. Toggle between all possible positions where the idlers count can be placed.
.. _trackstop:
trackstop trackstop
--------- ---------
Adds a ``q`` menu for track stops, which is completely blank by default. Adds a ``q`` menu for track stops, which is completely blank by default.
@ -602,6 +616,8 @@ Note that files are relative to the DF folder, so put your files there or in a
subfolder for easy access. Filenames should not have spaces. Generated materials, subfolder for easy access. Filenames should not have spaces. Generated materials,
divine metals, etc are not saved as they are different in every world. divine metals, etc are not saved as they are different in every world.
.. _`Stockpile automation`:
Stockpile automation Stockpile automation
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
@ -639,6 +655,8 @@ Options:
The building must be one of stockpile, workshop, furnace, trap, The building must be one of stockpile, workshop, furnace, trap,
siege engine or an activity zone. siege engine or an activity zone.
.. _rendermax:
rendermax rendermax
--------- ---------
A collection of renderer replacing/enhancing filters. For better effect try changing the A collection of renderer replacing/enhancing filters. For better effect try changing the
@ -1267,6 +1285,8 @@ Example:
Fortress activity management Fortress activity management
============================ ============================
.. _dwarfmonitor:
dwarfmonitor dwarfmonitor
------------ ------------
Records dwarf activity to measure fort efficiency. Records dwarf activity to measure fort efficiency.
@ -2143,6 +2163,8 @@ Options:
:building: Subsequent items will become part of the currently selected building. :building: Subsequent items will become part of the currently selected building.
Good for loading traps; do not use with workshops (or deconstruct to use the item). Good for loading traps; do not use with workshops (or deconstruct to use the item).
.. _fastdwarf:
fastdwarf fastdwarf
========= =========
Controls speedydwarf and teledwarf. Speedydwarf makes dwarves move quickly Controls speedydwarf and teledwarf. Speedydwarf makes dwarves move quickly
@ -2156,6 +2178,8 @@ but do jobs at the same speed.
:fastdwarf 0 1: disables speedydwarf and enables teledwarf :fastdwarf 0 1: disables speedydwarf and enables teledwarf
:fastdwarf 1 1: enables both :fastdwarf 1 1: enables both
See `superdwarf` for a per-creature version.
.. _forceequip: .. _forceequip:
forceequip forceequip

38
docs/Scripts.rst
Unescape Escape View File

@ -135,6 +135,8 @@ directory.
existing DF screens, they deliberately use red instead of green for the key. existing DF screens, they deliberately use red instead of green for the key.
.. _gui/advfort:
gui/advfort gui/advfort
=========== ===========
This script allows to perform jobs in adventure mode. For more complete help This script allows to perform jobs in adventure mode. For more complete help
@ -194,6 +196,8 @@ page of the military screen with the cursor in the leftmost list.
When invoked, the script duplicates the currently selected uniform template, When invoked, the script duplicates the currently selected uniform template,
and selects the newly created copy. and selects the newly created copy.
.. _gui/companion-order:
gui/companion-order gui/companion-order
=================== ===================
A script to issue orders for companions. Select companions with lower case chars, issue orders with upper A script to issue orders for companions. Select companions with lower case chars, issue orders with upper
@ -255,6 +259,8 @@ the cursor over a Guide order.
The script displays the cached path that will be used by the order; the game The script displays the cached path that will be used by the order; the game
computes it when the order is executed for the first time. computes it when the order is executed for the first time.
.. _gui/hack-wish:
gui/hack-wish gui/hack-wish
============= =============
An alias for `gui/create-item`. Deprecated. An alias for `gui/create-item`. Deprecated.
@ -571,6 +577,8 @@ modtools/invader-item-destroyer
This tool configurably destroys invader items to prevent clutter or to prevent This tool configurably destroys invader items to prevent clutter or to prevent
the player from getting tools exclusive to certain races. the player from getting tools exclusive to certain races.
.. _modtools/item-trigger:
modtools/item-trigger modtools/item-trigger
===================== =====================
This powerful tool triggers DFHack commands when a unit equips, unequips, or This powerful tool triggers DFHack commands when a unit equips, unequips, or
@ -603,6 +611,8 @@ modtools/reaction-product-trigger
This triggers dfhack commands when reaction products are produced, once per This triggers dfhack commands when reaction products are produced, once per
product. product.
.. _modtools/reaction-trigger:
modtools/reaction-trigger modtools/reaction-trigger
========================= =========================
Triggers dfhack commands when custom reactions complete, regardless of whether Triggers dfhack commands when custom reactions complete, regardless of whether
@ -706,6 +716,8 @@ burial
Sets all unowned coffins to allow burial. ``burial -pets`` also allows burial Sets all unowned coffins to allow burial. ``burial -pets`` also allows burial
of pets. of pets.
.. _command-prompt:
command-prompt command-prompt
============== ==============
A one line command prompt in df. Same as entering command into dfhack console. Best A one line command prompt in df. Same as entering command into dfhack console. Best
@ -741,6 +753,8 @@ Examples::
create-items bar CREATURE:CAT:SOAP create-items bar CREATURE:CAT:SOAP
create-items bar adamantine create-items bar adamantine
.. _deathcause:
deathcause deathcause
========== ==========
Focus a body part ingame, and this script will display the cause of death of Focus a body part ingame, and this script will display the cause of death of
@ -779,6 +793,8 @@ as an offset for the pattern: instead of starting at the cursor, it will start
The script takes the plan filename, starting from the root df folder (where The script takes the plan filename, starting from the root df folder (where
``Dwarf Fortress.exe`` is found). ``Dwarf Fortress.exe`` is found).
.. _drain-aquifer:
drain-aquifer drain-aquifer
============= =============
Remove all 'aquifer' tag from the map blocks. Irreversible. Remove all 'aquifer' tag from the map blocks. Irreversible.
@ -873,11 +889,15 @@ or sterile. Optional arguments specify the target: no argument for the
selected unit, ``all`` for all units on the map, ``animals`` for all non-dwarf selected unit, ``all`` for all units on the map, ``animals`` for all non-dwarf
creatures, or ``only:<creature>`` to only process matching creatures. creatures, or ``only:<creature>`` to only process matching creatures.
.. _forum-dwarves:
forum-dwarves forum-dwarves
============= =============
Saves a copy of a text screen, formatted in bbcode for posting to the Bay12 Forums. Saves a copy of a text screen, formatted in bbcode for posting to the Bay12 Forums.
Use ``forum-dwarves help`` for more information. Use ``forum-dwarves help`` for more information.
.. _full-heal:
full-heal full-heal
========= =========
Attempts to fully heal the selected unit. ``full-heal -r`` attempts to resurrect the unit. Attempts to fully heal the selected unit. ``full-heal -r`` attempts to resurrect the unit.
@ -901,6 +921,8 @@ For example, to grow 40 plump helmet spawn::
growcrops plump 40 growcrops plump 40
.. _hfs-pit:
hfs-pit hfs-pit
======= =======
Creates a pit to the underworld at the cursor. Creates a pit to the underworld at the cursor.
@ -915,6 +937,8 @@ is "hfs-pit 1 0 0", ie single-tile wide with no walls or stairs.::
First example is a four-across pit with stairs but no walls; second is a First example is a four-across pit with stairs but no walls; second is a
two-across pit with stairs but no walls. two-across pit with stairs but no walls.
.. _hotkey-notes:
hotkey-notes hotkey-notes
============ ============
Lists the key, name, and jump position of your hotkeys in the DFHack console. Lists the key, name, and jump position of your hotkeys in the DFHack console.
@ -1021,6 +1045,8 @@ Sets available points at the embark screen to the specified number. Eg.
``points 1000000`` would allow you to buy everything, or ``points 0`` would ``points 1000000`` would allow you to buy everything, or ``points 0`` would
make life quite difficult. make life quite difficult.
.. _position:
position position
======== ========
Reports the current time: date, clock time, month, and season. Also reports Reports the current time: date, clock time, month, and season. Also reports
@ -1038,6 +1064,8 @@ and ``pref-adjust`` inserts an 'ideal' set which is easy to satisfy::
prickle berries, plump helmets, strawberry wine, fisher berry wine, prickle berry prickle berries, plump helmets, strawberry wine, fisher berry wine, prickle berry
wine, and dwarven wine. wine, and dwarven wine.
.. _putontable:
putontable putontable
========== ==========
Makes item appear on the table, like in adventure mode shops. Arguments: '-a' Makes item appear on the table, like in adventure mode shops. Arguments: '-a'
@ -1076,6 +1104,8 @@ rejuvenate
Set the age of the selected dwarf to 20 years. Useful if valuable citizens are Set the age of the selected dwarf to 20 years. Useful if valuable citizens are
getting old, or there are too many babies around... getting old, or there are too many babies around...
.. _remove-stress:
remove-stress remove-stress
============= =============
Sets stress to -1,000,000; the normal range is 0 to 500,000 with very stable or Sets stress to -1,000,000; the normal range is 0 to 500,000 with very stable or
@ -1136,6 +1166,8 @@ Use one or more of the following options:
:export: ``export:<filename>`` sends output to the given file, showing all :export: ``export:<filename>`` sends output to the given file, showing all
syndromes affecting each unit with the maximum and present duration. syndromes affecting each unit with the maximum and present duration.
.. _siren:
siren siren
===== =====
Wakes up sleeping units, cancels breaks and stops parties either everywhere, Wakes up sleeping units, cancels breaks and stops parties either everywhere,
@ -1208,9 +1240,11 @@ alternatively pass cage IDs as arguments::
stripcaged weapons 25321 34228 stripcaged weapons 25321 34228
.. _superdwarf:
superdwarf superdwarf
========== ==========
Similar to fastdwarf, per-creature. Similar to `fastdwarf`, per-creature.
To make any creature superfast, target it ingame using 'v' and:: To make any creature superfast, target it ingame using 'v' and::
@ -1220,6 +1254,8 @@ Other options available: ``del``, ``clear``, ``list``.
This script also shortens the 'sleeping' and 'on break' periods of targets. This script also shortens the 'sleeping' and 'on break' periods of targets.
.. _teleport:
teleport teleport
======== ========
Teleports a unit to given coordinates. Teleports a unit to given coordinates.

2
docs/conf.py.in
Unescape Escape View File

@ -184,7 +184,7 @@ html_favicon = 'dfhack-icon.ico'
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['../images'] html_static_path = []
# Add any extra paths that contain custom files (such as robots.txt or # Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied # .htaccess) here, relative to this directory. These files are copied