Edit docs.

develop
Alexander Gavrilov 2012-09-29 13:17:28 +04:00
parent 7a74088287
commit cb2acc169c
3 changed files with 30 additions and 8 deletions

3
.gitignore vendored

@ -36,6 +36,9 @@ build/tools
build/plugins
build/depends
build/install_manifest.txt
build/README.html
build/LUA_API.html
build/COMPILE.html
#ignore Kdevelop stuff
.kdev4

@ -20,6 +20,7 @@ DFHack v0.34.11-r2 (UNRELEASED)
- prospect: pre-embark prospector accounts for caves & magma sea in its estimate.
- rename: supports renaming stockpiles, workshops, traps, siege engines.
- fastdwarf: now has an additional option to make dwarves teleport to their destination.
New commands:
- misery: multiplies every negative thought gained (2x by default).
- digtype: designates every tile of the same type of vein on the map for 'digging' (any dig designation).
New tweaks:

@ -1746,6 +1746,14 @@ In-game interface tools
These tools work by displaying dialogs or overlays in the game window, and
are mostly implemented by lua scripts.
.. note::
In order to avoid user confusion, as a matter of policy all these tools
display the word "DFHack" on the screen somewhere while active.
As an exception, the tweak plugin described above does not follow this
guideline because it arguably just fixes small usability bugs in the game UI.
Dwarf Manipulator
=================
@ -1765,7 +1773,7 @@ move 10 tiles at a time.
Press the Z-Up (<) and Z-Down (>) keys to move quickly between labor/skill
categories. The numpad Z-Up and Z-Down keys seek to the first or last unit
in the list.
in the list. Backspace seeks to the top left corner.
Press Enter to toggle the selected labor for the selected unit, or Shift+Enter
to toggle all labors within the selected category.
@ -1850,6 +1858,12 @@ These plugins, when activated via configuration UI or by detecting certain
structures in RAWs, modify the game engine behavior concerning the target
objects to add features not otherwise present.
.. admonition:: DISCLAIMER
The plugins in this section have mostly been created for fun as an interesting
technical challenge, and do not represent any long-term plans to produce more
similar modifications of the game.
Siege Engine
============
@ -1859,6 +1873,17 @@ aimed at an arbitrary rectangular area across Z levels, instead of the original
four directions. Also, catapults can be ordered to load arbitrary objects, not
just stones.
Rationale
---------
Siege engines are a very interesting feature, but sadly almost useless in the current state
because they haven't been updated since 2D and can only aim in four directions. This is an
attempt to bring them more up to date until Toady has time to work on it. Actual improvements,
e.g. like making siegers bring their own, are something only Toady can do.
Configuration UI
----------------
The configuration front-end to the plugin is implemented by the gui/siege-engine
script. Bind it to a key and activate after selecting a siege engine in 'q' mode.
@ -1882,13 +1907,6 @@ Exiting from the siege engine script via ESC reverts the view to the state prior
the script. Shift-ESC retains the current viewport, and also exits from the 'q' mode to main
menu.
.. admonition:: DISCLAIMER
Siege engines are a very interesting feature, but sadly almost useless in the current state
because they haven't been updated since 2D and can only aim in four directions. This is an
attempt to bring them more up to date until Toady has time to work on it. Actual improvements,
e.g. like making siegers bring their own, are something only Toady can do.
Power Meter
===========