diff --git a/CMakeLists.txt b/CMakeLists.txt index f5fb83b31..31f257812 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -27,10 +27,10 @@ endif() # set up versioning. set(DF_VERSION_MAJOR "0") set(DF_VERSION_MINOR "34") -set(DF_VERSION_PATCH "02") +set(DF_VERSION_PATCH "03") set(DF_VERSION "${DF_VERSION_MAJOR}.${DF_VERSION_MINOR}.${DF_VERSION_PATCH}") -set(DFHACK_RELEASE "1-dev") +set(DFHACK_RELEASE "1") set(DFHACK_VERSION "${DF_VERSION_MAJOR}.${DF_VERSION_MINOR}.${DF_VERSION_PATCH}-r${DFHACK_RELEASE}") add_definitions(-DDFHACK_VERSION="${DFHACK_VERSION}") diff --git a/Compile.html b/Compile.html index 35054fbd5..53fc959b4 100644 --- a/Compile.html +++ b/Compile.html @@ -395,7 +395,7 @@ program.

Windows

-

On Linux, DFHack replaces the SDL library distributed with DF.

+

On Windows, DFHack replaces the SDL library distributed with DF.

How to get the code

DFHack doesn't have any kind of system of code snapshots in place, so you will have to get code from the github repository using git. diff --git a/README.rst b/README.rst index 74d78bd7b..d1dcc2d21 100644 --- a/README.rst +++ b/README.rst @@ -86,6 +86,31 @@ Commands Almost all the commands support using the 'help ' built-in command to retrieve further help without having to look at this document. Alternatively, some accept a 'help'/'?' option on their command line. +adv-bodyswap +============ +This allows taking control over your followers and other creatures in adventure mode. For example, you can make them pick up new arms and armor and equip them properly. + +Usage +----- + * When viewing unit details, body-swaps into that unit. + * In the main adventure mode screen, reverts transient swap. + +advtools +======== +A package of different adventure mode tools (currently just one) + +Usage +----- +:list-equipped [all]: List armor and weapons equipped by your companions. If all is specified, also lists non-metal clothing. + +changevein +========== +Changes material of the vein under cursor to the specified inorganic RAW material. + +follow +====== +Makes the game view follow the currently highlighted unit after you exit from current menu/cursor mode. Handy for watching dwarves running around. Deactivated by moving the view manually. + forcepause ========== Forces DF to pause. This is useful when your FPS drops below 1 and you lose control of the game. diff --git a/Readme.html b/Readme.html index d9620a5ac..41040b2de 100644 --- a/Readme.html +++ b/Readme.html @@ -318,7 +318,7 @@ ul.auto-toc {

-

Introduction

+

Introduction

DFHack is a Dwarf Fortress memory access library and a set of basic tools that use it. Tools come in the form of plugins or (not yet) external tools. It is an attempt to unite the various ways tools @@ -326,146 +326,156 @@ access DF memory and allow for easier development of new tools.

Contents

-

Getting DFHack

+

Getting DFHack

The project is currently hosted on github, for both source and binaries at http://github.com/peterix/dfhack

Releases can be downloaded from here: https://github.com/peterix/dfhack/downloads

All new releases are announced in the bay12 thread: http://tinyurl.com/dfhack-ng

-

Compatibility

+

Compatibility

DFHack works on Windows XP, Vista, 7 or any modern Linux distribution. OSX is not supported due to lack of developers with a Mac.

Currently, only version 0.31.25 is supported. If you need DFHack @@ -474,7 +484,7 @@ for older versions, look for older releases.

It is possible to use the Windows DFHack under wine/OSX.

-

Installation/Removal

+

Installation/Removal

Installing DFhack involves copying files into your DF folder. Copy the files from a release archive so that:

@@ -494,7 +504,7 @@ Copy the files from a release archive so that:

If any of the plugins or dfhack itself refuses to load, check the stderr.log file created in your DF folder.

-

Using DFHack

+

Using DFHack

DFHack basically extends what DF can do with something similar to the drop-down console found in Quake engine games. On Windows, this is a separate command line window. On linux, the terminal used to launch the dfhack script is taken over (so, make sure you start from a terminal). Basic interaction with dfhack involves entering commands into the console. For some basic instroduction, use the 'help' command. To list all possible commands, use the 'ls' command. Many commands have their own help or detailed description. You can use 'command help' or 'command ?' to show that.

@@ -505,19 +515,56 @@ Many commands have their own help or detailed description. You can use 'command

Most of the commands come from plugins. Those reside in 'hack/plugins/'.

-

Something doesn't work, help!

+

Something doesn't work, help!

First, don't panic :) Second, dfhack keeps a few log files in DF's folder - stderr.log and stdout.log. You can look at those and possibly find out what's happening. If you found a bug, you can either report it in the bay12 DFHack thread, the issues tracker on github, contact me (peterix@gmail.com) or visit the #dfhack IRC channel on freenode.

-

The init file

+

The init file

If your DF folder contains a file named dfhack.init, its contents will be run every time you start DF. This allows setting up keybindings. An example file is provided as dfhack.init-example - you can tweak it and rename to dfhack.init if you want to use this functionality.

-

Commands

+

Commands

Almost all the commands support using the 'help <command-name>' built-in command to retrieve further help without having to look at this document. Alternatively, some accept a 'help'/'?' option on their command line.

+
+

adv-bodyswap

+

This allows taking control over your followers and other creatures in adventure mode. For example, you can make them pick up new arms and armor and equip them properly.

+
+

Usage

+
+
    +
  • When viewing unit details, body-swaps into that unit.
    • +
  • In the main adventure mode screen, reverts transient swap.
    • +
+
+
+
+
+

advtools

+

A package of different adventure mode tools (currently just one)

+
+

Usage

+ +++ + + + + +
list-equipped [all]:
 List armor and weapons equipped by your companions. If all is specified, also lists non-metal clothing.
+
+
+
+

changevein

+

Changes material of the vein under cursor to the specified inorganic RAW material.

+
+
+

follow

+

Makes the game view follow the currently highlighted unit after you exit from current menu/cursor mode. Handy for watching dwarves running around. Deactivated by moving the view manually.

+
-

forcepause

+

forcepause

Forces DF to pause. This is useful when your FPS drops below 1 and you lose control of the game.

    @@ -527,23 +574,23 @@ If you found a bug, you can either report it in the bay12 DFHack thread, the iss
-

nopause

+

nopause

Disables pausing (both manual and automatic) with the exception of pause forced by 'reveal hell'. This is nice for digging under rivers.

-

die

+

die

Instantly kills DF without saving.

-

autodump

+

autodump

This utility lets you quickly move all items designated to be dumped. Items are instantly moved to the cursor position, the dump flag is unset, and the forbid flag is set, as if it had been dumped normally. Be aware that any active dump item tasks still point at the item.

Cursor must be placed on a floor tile so the items can be dumped there.

-

Options

+

Options

@@ -563,20 +610,20 @@ Be aware that any active dump item tasks still point at the item.

-

autodump-destroy-here

+

autodump-destroy-here

Destroy items marked for dumping under cursor. Identical to autodump destroy-here, but intended for use as keybinding.

-

autodump-destroy-item

+

autodump-destroy-item

Destroy the selected item. The item may be selected in the 'k' list, or inside a container. If called again before the game is resumed, cancels destroy.

-

clean

+

clean

Cleans all the splatter that get scattered all over the map, items and creatures. In an old fortress, this can significantly reduce FPS lag. It can also spoil your !!FUN!!, so think before you use it.

-
@@ -591,7 +638,7 @@ In an old fortress, this can significantly reduce FPS lag. It can also spoil you
-

Extra options for 'map'

+

Extra options for 'map'

@@ -605,15 +652,15 @@ In an old fortress, this can significantly reduce FPS lag. It can also spoil you
-

spotclean

+

spotclean

Works like 'clean map snow mud', but only for the tile under the cursor. Ideal if you want to keep that bloody entrance 'clean map' would clean up.

-

cleanowned

+

cleanowned

Confiscates items owned by dwarfs. By default, owned food on the floor and rotten items are confistacted and dumped.

-
@@ -632,15 +679,15 @@ By default, owned food on the floor and rotten items are confistacted and dumped
-

Example:

+

Example:

cleanowned scattered X : This will confiscate rotten and dropped food, garbage on the floors and any worn items with 'X' damage and above.

-

colonies

+

colonies

Allows listing all the vermin colonies on the map and optionally turning them into honey bee colonies.

-
-

Options

+
+

Options

@@ -652,12 +699,12 @@ By default, owned food on the floor and rotten items are confistacted and dumped
-

deramp (by zilpin)

+

deramp (by zilpin)

Removes all ramps designated for removal from the map. This is useful for replicating the old channel digging designation. It also removes any and all 'down ramps' that can remain after a cave-in (you don't have to designate anything for that to happen).

-

df2minecraft

+

df2minecraft

This generates a minecraft world out of the currently loaded fortress. Generated worlds are placed into your DF folder, named "World #".

@@ -671,11 +718,11 @@ Generated worlds are placed into your DF folder, named "World #".

-

dfusion

+

dfusion

This is the DFusion lua plugin system by warmist/darius, running as a DFHack plugin.

See the bay12 thread for details: http://www.bay12forums.com/smf/index.php?topic=69682.15

@@ -695,11 +742,11 @@ Generated worlds are placed into your DF folder, named "World #".

-

drybuckets

+

drybuckets

This utility removes water from all buckets in your fortress, allowing them to be safely used for making lye.

-

fastdwarf

+

fastdwarf

Makes your minions move at ludicrous speeds.

    @@ -709,10 +756,10 @@ Generated worlds are placed into your DF folder, named "World #".

-

filltraffic

+

filltraffic

Set traffic designations using flood-fill starting at the cursor.

@@ -729,7 +776,7 @@ Generated worlds are placed into your DF folder, named "World #".

-

Other Options:

+

Other Options:

@@ -743,16 +790,16 @@ Generated worlds are placed into your DF folder, named "World #".

-
-

Example:

+
+

Example:

'filltraffic H' - When used in a room with doors, it will set traffic to HIGH in just that room.

-

alltraffic

+

alltraffic

Set traffic designations for every single tile of the map (useful for resetting traffic designations).

-
-

Traffic Type Codes:

+
+

Traffic Type Codes:

@@ -768,36 +815,36 @@ Generated worlds are placed into your DF folder, named "World #".

-
-

Example:

+
+

Example:

'alltraffic N' - Set traffic to 'normal' for all tiles.

-

fixdiplomats

+

fixdiplomats

Up to version 0.31.12, Elves only sent Diplomats to your fortress to propose tree cutting quotas due to a bug; once that bug was fixed, Elves stopped caring about excess tree cutting. This command adds a Diplomat position to all Elven civilizations, allowing them to negotiate tree cutting quotas (and allowing you to violate them and potentially start wars) in case you haven't already modified your raws accordingly.

-

fixmerchants

+

fixmerchants

This command adds the Guild Representative position to all Human civilizations, allowing them to make trade agreements (just as they did back in 0.28.181.40d and earlier) in case you haven't already modified your raws accordingly.

-

fixveins

+

fixveins

Removes invalid references to mineral inclusions and restores missing ones. Use this if you broke your embark with tools like tiletypes, or if you accidentally placed a construction on top of a valuable mineral floor.

-

fixwagons

+

fixwagons

Due to a bug in all releases of version 0.31, merchants no longer bring wagons with their caravans. This command re-enables them for all appropriate civilizations.

-

flows

+

flows

A tool for checking how many tiles contain flowing liquids. If you suspect that your magma sea leaks into HFS, you can use this tool to be sure without revealing the map.

-

getplants

+

getplants

This tool allows plant gathering and tree cutting by RAW ID. Specify the types of trees to cut down and/or shrubs to gather by their plant names, separated by spaces.

-
-

Options

+
+

Options

@@ -816,15 +863,15 @@ Generated worlds are placed into your DF folder, named "World #".

-

tidlers

+

tidlers

Toggle between all possible positions where the idlers count can be placed.

-

twaterlvl

+

twaterlvl

Toggle between displaying/not displaying liquid depth as numbers.

-

job

+

job

Command for general job query and manipulation.

Options:
@@ -838,7 +885,7 @@ Generated worlds are placed into your DF folder, named "World #".

-

job-material

+

job-material

Alter the material of the selected job. Invoked as: job-material <inorganic-token>

Intended to be used as a keybinding:
@@ -850,7 +897,7 @@ Generated worlds are placed into your DF folder, named "World #".

-

job-duplicate

+

job-duplicate

Duplicate the selected job in a workshop:
    @@ -860,10 +907,10 @@ Generated worlds are placed into your DF folder, named "World #".

-

keybinding

+

keybinding

Manages DFHack keybindings. Currently it supports any combination of Ctrl/Alt/Shift with F1-F9, or A-Z.

-
@@ -886,7 +933,7 @@ Generated worlds are placed into your DF folder, named "World #".

-

liquids

+

liquids

Allows adding magma, water and obsidian to the game. It replaces the normal dfhack command line and can't be used from a hotkey. For more information, refer to the command's internal help.

@@ -896,7 +943,7 @@ temperatures (creating heat traps). You've been warned.

-

mode

+

mode

This command lets you see and change the game mode directly. Not all combinations are good for every situation and most of them will produce undesirable results. There are a few good ones though.

@@ -908,11 +955,11 @@ You just lost a fortress and gained an adventurer.

I take no responsibility of anything that happens as a result of using this tool :P

-

extirpate

+

extirpate

A tool for getting rid of trees and shrubs. By default, it only kills a tree/shrub under the cursor. The plants are turned into ashes instantly.

-
@@ -928,22 +975,22 @@ The plants are turned into ashes instantly.

-

grow

+

grow

Makes all saplings present on the map grow into trees (almost) instantly.

-

immolate

+

immolate

Very similar to extirpate, but additionally sets the plants on fire. The fires can and will spread ;)

-

probe

+

probe

Can be used to determine tile properties like temperature.

-

prospect

+

prospect

Prints a big list of all the present minerals and plants. By default, only the visible part of the map is scanned.

-
@@ -958,13 +1005,13 @@ The plants are turned into ashes instantly.

-

Pre-embark estimate

+

Pre-embark estimate

If called during the embark selection screen, displays an estimate of layer stone availability. If the 'all' option is specified, also estimates veins. The estimate is computed either for 1 embark tile of the blinking biome, or for all tiles of the embark rectangle.

-
-

Options

+
+

Options

@@ -976,14 +1023,14 @@ for 1 embark tile of the blinking biome, or for all tiles of the embark rectangl
-

regrass

+

regrass

Regrows all surface grass, restoring outdoor plant growth for pre-0.31.19 worlds.

-

rename

+

rename

Allows renaming various things.

-
@@ -1005,36 +1052,36 @@ for 1 embark tile of the blinking biome, or for all tiles of the embark rectangl
-

reveal

+

reveal

This reveals the map. By default, HFS will remain hidden so that the demons don't spawn. You can use 'reveal hell' to reveal everything. With hell revealed, you won't be able to unpause until you hide the map again. If you really want to unpause with hell revealed, use 'reveal demons'.

-

unreveal

+

unreveal

Reverts the effects of 'reveal'.

-

revtoggle

+

revtoggle

Switches between 'reveal' and 'unreveal'.

-

revflood

+

revflood

This command will hide the whole map and then reveal all the tiles that have a path to the in-game cursor.

-

seedwatch

+

seedwatch

Tool for turning cooking of seeds and plants on/off depending on how much you have of them.

See 'seedwatch help' for detailed description.

-

showmood

+

showmood

Shows all items needed for the currently active strange mood.

-

copystock

+

copystock

Copies the parameters of the currently highlighted stockpile to the custom stockpile settings and switches to custom stockpile placement mode, effectively allowing you to copy/paste stockpiles easily.

-

ssense / stonesense

+

ssense / stonesense

An isometric visualizer that runs in a second window. This requires working graphics acceleration and at least a dual core CPU (otherwise it will slow down DF).

All the data resides in the 'stonesense' directory. For detailed instructions, see stonesense/README.txt

Compatible with Windows > XP SP3 and most modern Linux distributions.

@@ -1044,31 +1091,31 @@ for 1 embark tile of the blinking biome, or for all tiles of the embark rectangl http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository

-

tiletypes

+

tiletypes

Can be used for painting map tiles and is a interactive command, much like liquids. You can paint tiles by their properties - shape, general material and a few others (paint). You can also paint only over tiles that match a set of properties (filter)

For more details, see the 'help' command while using this.

-

tubefill

+

tubefill

Fills all the adamantine veins again. Veins that were empty will be filled in too, but might still trigger a demon invasion (this is a known bug).

-

vdig

+

vdig

Designates a whole vein for digging. Requires an active in-game cursor placed over a vein tile. With the 'x' option, it will traverse z-levels (putting stairs between the same-material tiles).

-

vdigx

+

vdigx

A permanent alias for 'vdig x'.

-

expdig

+

expdig

This command can be used for exploratory mining.

See: http://df.magmawiki.com/index.php/DF2010:Exploratory_mining

There are two variables that can be set: pattern and filter.

@@ -1089,7 +1136,7 @@ You can also paint only over tiles that match a set of properties (filter)

-

Filters:

+

Filters:

@@ -1105,7 +1152,7 @@ You can also paint only over tiles that match a set of properties (filter)

After you have a pattern set, you can use 'expdig' to apply it again.

-

Examples:

+

Examples:

designate the diagonal 5 patter over all hidden tiles:
    @@ -1126,11 +1173,11 @@ You can also paint only over tiles that match a set of properties (filter)

-

digcircle

+

digcircle

A command for easy designation of filled and hollow circles. It has several types of options.

@@ -1145,7 +1192,7 @@ It has several types of options.

-

Action:

+

Action:

@@ -1160,7 +1207,7 @@ It has several types of options.

-

Designation types:

+

Designation types:

@@ -1182,8 +1229,8 @@ It has several types of options.

After you have set the options, the command called with no options repeats with the last selected parameters.

-
-

Examples:

+
+

Examples:

  • 'digcircle filled 3' = Dig a filled circle with radius = 3.
  • 'digcircle' = Do it again.
    • @@ -1191,11 +1238,11 @@ repeats with the last selected parameters.

-

weather

+

weather

Prints the current weather map by default.

Also lets you change the current weather to 'clear sky', 'rainy' or 'snowing'.

-
@@ -1211,10 +1258,10 @@ repeats with the last selected parameters.

-

workflow

+

workflow

Manage control of repeat jobs.

-
-

Usage

+
+

Usage

workflow enable [option...], workflow disable [option...]

If no options are specified, enables or disables the plugin. @@ -1235,7 +1282,7 @@ Otherwise, enables or disables any of the following options:

-

Function

+

Function

When the plugin is enabled, it protects all repeat jobs from removal. If they do disappear due to any cause, they are immediately re-added to their workshop and suspended.

@@ -1246,7 +1293,7 @@ the amount has to drop before jobs are resumed; this is intended to reduce the frequency of jobs being toggled.

-

Constraint examples

+

Constraint examples

Keep metal bolts within 900-1000, and wood/bone within 150-200.

 workflow amount AMMO:ITEM_AMMO_BOLTS/METAL 1000 100
@@ -1283,11 +1330,11 @@ the Mill Plants job to MUSHROOM_CUP_DIMPLE using the 'job item-material' command
-

mapexport

+

mapexport

Export the current loaded map as a file. This will be eventually usable with visualizers.

-

dwarfexport

+

dwarfexport

Export dwarves to RuneSmith-compatible XML.

diff --git a/library/xml b/library/xml index 1f1a6600d..0c8d7fbf2 160000 --- a/library/xml +++ b/library/xml @@ -1 +1 @@ -Subproject commit 1f1a6600d52220abce35e7d955b4940e7cf51e25 +Subproject commit 0c8d7fbf2eae4814947ac4eeb22f39a7cafaf40c