diff --git a/COMPILE.rst b/COMPILE.rst index 175060060..273871142 100644 --- a/COMPILE.rst +++ b/COMPILE.rst @@ -64,18 +64,31 @@ For the code generation parts, you'll need perl and XML::LibXML. You can install * open a cmd.exe window and run "cpan XML::LibXML" (obviously without the quotes). This can take a while to complete. * Same with "cpan XML::LibXSLT". +If you already have a different version of perl (for example the one from cygwin), you can run into some trouble. Either remove the other perl install from PATH, or install libxml and libxslt for it instead. Strawberry perl works though and has all the required packages. + Build ===== -Open the ``build`` folder and double click the batch script there. This will eventually open -a cmake GUI window. Here, set CMAKE_INSTALL_PREFIX to your DF folder and set up any other -options you're interested in. Hit configure and generate, close the GUI. +There are several different batch files in the ``build`` folder along with a script that's used for picking the DF path. + +First, run set_df_path.vbs and point the dialog that pops up at your DF folder that you want to use for development. +Next, run one of the scripts with ``generate`` prefix. These create the MSVC solution file(s): + +* ``all`` will create a solution with everything enabled (and the kitchen sink). +* ``gui`` will pop up the cmake gui and let you pick and choose what to build. This is probably what you want most of the time. Set the options you are interested in, then hit configure, then generate. More options can appear after the configure step. +* ``minimal`` will create a minimal solution with just the bare necessities - the main library and standard plugins. -This crates a folder under build/ that contains the solution files for MSVC. +Then you can either open the solution with MSVC or use one of the msbuild scripts: -When you open the solution, make sure you never use the Debug builds. Those aren't +* Scripts with ``build`` prefix will only build. +* Scripts with ``install`` prefix will build DFHack and install it to the previously selected DF path. +* Scripts with ``package`` prefix will build and create a .zip package of DFHack. + +When you open the solution in MSVC, make sure you never use the Debug builds. Those aren't binary-compatible with DF. If you try to use a debug build with DF, you'll only get crashes. So pick either Release or RelWithDebInfo build and build the INSTALL target. +The ``debug`` scripts actually do RelWithDebInfo builds. + =========== Build types @@ -154,6 +167,7 @@ Good windows tools include: Good linux tools: +* angavrilov's df-structures gui (visit us on IRC for details). * edb (Evan's Debugger) * IDA Pro running under wine. * Some of the tools residing in the ``legacy`` dfhack branch. diff --git a/Compile.html b/Compile.html index 35e4ff3e6..c6d7226d2 100644 --- a/Compile.html +++ b/Compile.html @@ -391,15 +391,27 @@ Grab it from Microsoft's site.

  • open a cmd.exe window and run "cpan XML::LibXML" (obviously without the quotes). This can take a while to complete.
  • Same with "cpan XML::LibXSLT".
    • +

    If you already have a different version of perl (for example the one from cygwin), you can run into some trouble. Either remove the other perl install from PATH, or install libxml and libxslt for it instead. Strawberry perl works though and has all the required packages.

    Build

    -

    Open the build folder and double click the batch script there. This will eventually open -a cmake GUI window. Here, set CMAKE_INSTALL_PREFIX to your DF folder and set up any other -options you're interested in. Hit configure and generate, close the GUI.

    -

    This crates a folder under build/ that contains the solution files for MSVC.

    -

    When you open the solution, make sure you never use the Debug builds. Those aren't +

    There are several different batch files in the build folder along with a script that's used for picking the DF path.

    +

    First, run set_df_path.vbs and point the dialog that pops up at your DF folder that you want to use for development. +Next, run one of the scripts with generate prefix. These create the MSVC solution file(s):

    + +

    Then you can either open the solution with MSVC or use one of the msbuild scripts:

    + +

    When you open the solution in MSVC, make sure you never use the Debug builds. Those aren't binary-compatible with DF. If you try to use a debug build with DF, you'll only get crashes. So pick either Release or RelWithDebInfo build and build the INSTALL target.

    +

    The debug scripts actually do RelWithDebInfo builds.

    @@ -463,6 +475,7 @@ to look at machine code without getting crazy :)

    Good linux tools:

    -
    -
    The stonesense plugin might require some additional libraries on Linux:
    -
      -
    • libjpeg 8
      • -
    -
    -
    -

    If it refuses to load, check the stderr.log file created in your DF folder.

    +

    The stonesense plugin might require some additional libraries on Linux.

    +

    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 a quake console. 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.

    @@ -476,38 +495,55 @@ Some commands can't be used from hotkeys - this includes interactive commands li

    Most of the commands come from plugins. Those reside in 'DF/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.

    -

    Commands

    +

    Commands

    Almost all the commands have a 'help'/'?' option that will give you further help without having to look at this document.

    -

    autodump

    -

    Automated item dumping tool. All loose items on the floor marked -for dumping are insta-dumped to the position of the in-game cursor.

    -

    Cursor must be placed on a floor tile. Instadumped items may not -show up in the cursor description list until you save/reload.

    +

    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

    + + + + + + + +
    destroy:Destroy instead of dumping. Doesn't require a cursor.
    destroy-here:Destroy items only under the cursor.
    visible:Only process items that are not hidden.
    hidden:Only process hidden items.
    forbidden:Only process forbidden items (default: only unforbidden).
    +
    +

    autodump-destroy-here

    +

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

    +
    +
    +

    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.

    -

    Options

    +

    Options

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

    Extra options for 'map'

    +

    Extra options for 'map'

    @@ -536,15 +572,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.

    @@ -562,12 +598,16 @@ By default, owned food on the floor and rotten items are confistacted and dumped
    +
    +

    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

    @@ -579,12 +619,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 #".

    @@ -593,15 +633,16 @@ Generated worlds are placed into your DF folder, named "World #".

  • This is experimental! It will cause crashes.
  • If it works, the process takes quite a while to complete.
  • Do not use if you have any unsaved progress!
    • +
  • Non-square embarks are exported wrong. It's a known bug.
    • -

    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

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

    -

    drybuckets

    +

    drybuckets

    This utility removes all objects of type LIQUID_MISC:NONE and material WATER:NONE - that is, water stored in buckets.

    -

    fastdwarf

    +

    fastdwarf

    Makes your minions move at ludicrous speeds.

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

    -

    filltraffic

    +

    filltraffic

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

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

    -

    Other Options:

    +

    Other Options:

    @@ -669,16 +710,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.

    -
    -

    tiletraffic

    +
    +

    alltraffic

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

    -
    -

    Traffic Type Codes:

    +
    +

    Traffic Type Codes:

    @@ -694,20 +735,28 @@ Generated worlds are placed into your DF folder, named "World #".

    -
    -

    Example:

    -

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

    +
    +

    Example:

    +

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

    +
    +

    fixveins

    +

    Removes invalid references to mineral inclusions and restores missing ones. Use this if you broke your embark with tools like tiletypes.

    +
    +
    +

    fixwagons

    +

    Since DF v0.31.1 merchants no longer bring wagons due to a bug. 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

    @@ -726,15 +775,59 @@ Generated worlds are placed into your DF folder, named "World #".

    -

    grow

    +

    grow

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

    +
    +

    tidlers

    +

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

    +
    +
    +

    twaterlvl

    +

    Toggle between displaying/not displaying liquid depth as numbers.

    +
    +
    +

    job

    +

    Command for general job query and manipulation.

    +
    +
    Options:
    +
      +
    • no extra options - Print details of the current job. The job can be selected in a workshop, or the unit/jobs screen.
      • +
    • list - Print details of all jobs in the selected workshop.
      • +
    • item-material <item-idx> <material[:subtoken]> - Replace the exact material id in the job item.
      • +
    • item-type <item-idx> <type[:subtype]> - Replace the exact item type id in the job item.
      • +
    +
    +
    +
    +
    +

    job-material

    +

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

    +
    +
    Intended to be used as a keybinding:
    +
      +
    • In 'q' mode, when a job is highlighted within a workshop or furnace, changes the material of the job. Only inorganic materials can be used in this mode.n"
      • +
    • In 'b' mode, during selection of building components positions the cursor over the first available choice with the matching material.n"
      • +
    +
    +
    +
    +
    +

    job-duplicate

    +
    +
    Duplicate the selected job in a workshop:
    +
      +
    • In 'q' mode, when a job is highlighted within a workshop or furnace building, instantly duplicates the job.
      • +
    +
    +
    +
    -

    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.

    -
    @@ -750,11 +843,11 @@ The plants are turned into ashes instantly.

    -

    immolate

    +

    immolate

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

    -

    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.

    @@ -764,7 +857,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.

    @@ -776,7 +869,7 @@ 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

    -

    forcepause

    +

    forcepause

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

      @@ -786,23 +879,44 @@ You just lost a fortress and gained an adventurer.

    -

    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.

    -

    probe

    +

    probe

    Can be used to determine tile properties like temperature.

    -

    prospect

    -

    Lists all available minerals on the map, how much of them there is and the z-levels where they can be found. By default, only processes the already discovered part of the map.

    -
    -

    Options

    +

    prospect

    +

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

    +
    +++ + + + + + + + +
    all:Scan the whole map, as if it was revealed.
    value:Show material value in the output. Most useful for gems.
    hell:Show the Z range of HFS tubes. Implies 'all'.
    +
    +
    +

    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

    @@ -813,29 +927,66 @@ This is nice for digging under rivers.

    +
    +

    regrass

    +

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

    +
    +
    +

    rename

    +

    Allows renaming various things.

    +
    +

    Options

    + +++ + + + + + + + + + + + + + +
    rename squad <index> "name":
     Rename squad by index to 'name'.
    rename hotkey <index> "name":
     Rename hotkey by index. This allows assigning longer commands to the DF hotkeys.
    rename unit "nickname":
     Rename a unit/creature highlighted in the DF user interface.
    rename unit-profession "custom profession":
     Change proffession name of the highlighted unit/creature.
    +
    +
    -

    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

    +

    Shows items needed for current strange mood.

    +
    +
    +

    stockpiles

    +

    Copies the parameters of the currently highlighted stockpile to the custom stockpile settings. Basically a way to copy 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.

    @@ -845,39 +996,43 @@ This is nice for digging under rivers.

    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.

    -

    Patterns:

    +

    Patterns:

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

    diag5:diagonals separated by 5 tiles
    diag5r:diag5 rotated 90 degrees
    ladder:A 'ladder' pattern
    ladderr:ladder rotated 90 degrees
    clear:Just remove all dig designations
    cross:A cross, exactly in the middle of the map.
    -

    Filters:

    +

    Filters:

    @@ -902,20 +1057,32 @@ 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:

    -
      -
    • 'expdig diag5 hidden' = designate the diagonal 5 patter over all hidden tiles.
      • -
    • 'expdig' = apply last used pattern and filter.
      • -
    • 'expdig ladder designated' = Take current designations and replace them with the ladder pattern.
      • +

      Examples:

      +
      +
      designate the diagonal 5 patter over all hidden tiles:
      +
        +
      • expdig diag5 hidden
      +
      +
      apply last used pattern and filter:
      +
        +
      • expdig
        • +
      +
      +
      Take current designations and replace them with the ladder pattern:
      +
        +
      • expdig ladder designated
        • +
      +
      +
    -

    digcircle

    +

    digcircle

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

    @@ -930,7 +1097,7 @@ It has several types of options.

    -

    Action:

    +

    Action:

    @@ -945,7 +1112,7 @@ It has several types of options.

    -

    Designation types:

    +

    Designation types:

    @@ -967,8 +1134,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.
      • @@ -976,11 +1143,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'.

    -
    @@ -995,6 +1162,85 @@ repeats with the last selected parameters.

    +
    +

    workflow

    +

    Manage control of repeat jobs.

    +
    +

    Usage

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

    If no options are specified, enables or disables the plugin. +Otherwise, enables or disables any of the following options:

    +
      +
    • drybuckets: Automatically empty abandoned water buckets.
      • +
    • auto-melt: Resume melt jobs when there are objects to melt.
      • +
    +
    +
    workflow jobs
    +
    List workflow-controlled jobs (if in a workshop, filtered by it).
    +
    workflow list
    +
    List active constraints, and their job counts.
    +
    workflow count <constraint-spec> <cnt-limit> [cnt-gap], workflow amount <constraint-spec> <cnt-limit> [cnt-gap]
    +
    Set a constraint. The first form counts each stack as only 1 item.
    +
    workflow unlimit <constraint-spec>
    +
    Delete a constraint.
    +
    +
    +
    +

    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.

    +

    In addition, when any constraints on item amounts are set, repeat jobs that produce +that kind of item are automatically suspended and resumed as the item amount +goes above or below the limit. The gap specifies how much below the limit +the amount has to drop before jobs are resumed; this is intended to reduce +the frequency of jobs being toggled.

    +
    +
    +

    Constraint examples

    +
    +
    Keep metal bolts within 900-1000, and wood/bone within 150-200.
    +
      +
    • workflow amount AMMO:ITEM_AMMO_BOLTS/METAL 1000 100
      • +
    • workflow amount AMMO:ITEM_AMMO_BOLTS/WOOD,BONE 200 50
      • +
    +
    +
    Keep the number of prepared food & drink stacks between 90 and 120
    +
      +
    • workflow count FOOD 120 30
      • +
    • workflow count DRINK 120 30
      • +
    +
    +
    Make sure there are always 25-30 empty bins/barrels/bags.
    +
      +
    • workflow count BIN 30
      • +
    • workflow count BARREL 30
      • +
    • workflow count BOX/CLOTH,SILK,YARN 30
      • +
    +
    +
    Make sure there are always 15-20 coal and 25-30 copper bars.
    +
      +
    • workflow count BAR//COAL 20
      • +
    • workflow count BAR//COPPER 30
      • +
    +
    +
    Collect 15-20 sand bags and clay boulders.
    +
      +
    • workflow count POWDER_MISC/SAND 20
      • +
    • workflow count BOULDER/CLAY 20
      • +
    +
    +
    Make sure there are always 80-100 units of dimple dye.
    +
      +
    • workflow amount POWDER_MISC//MUSHROOM_CUP_DIMPLE:MILL 100 20
      • +
    +

    In order for this to work, you have to set the material of the PLANT input on +the Mill Plants job to MUSHROOM_CUP_DIMPLE using the 'job item-material' command.

    +
    +
    +
    +
    diff --git a/plugins/cleanowned.cpp b/plugins/cleanowned.cpp index a2ec4b763..c56e741c5 100644 --- a/plugins/cleanowned.cpp +++ b/plugins/cleanowned.cpp @@ -49,9 +49,9 @@ DFhackCExport command_result plugin_init ( Core * c, std::vector " x - confiscate & dump 'x' and worse damaged items\n" " X - confiscate & dump 'X' and worse damaged items\n" "Example:\n" - " confiscate scattered X\n" + " cleanowned scattered X\n" " This will confiscate rotten and dropped food, garbage on the floors\n" - " and any worn items wit 'X' damage and above.\n" + " and any worn items with 'X' damage and above.\n" )); return CR_OK; } diff --git a/plugins/colonies.cpp b/plugins/colonies.cpp index 21da2032a..f9c326cee 100644 --- a/plugins/colonies.cpp +++ b/plugins/colonies.cpp @@ -27,8 +27,8 @@ DFhackCExport command_result plugin_init ( Core * c, std::vector colonies, false, " Without any options, this command lists all the vermin colonies present.\n" "Options:\n" - " kill - destroy colonies\n" - " bees - turn colonies into honey bees\n" + //" kill - destroy colonies\n" // unlisted because it's likely broken anyway + " bees - turn colonies into honey bee hives\n" )); return CR_OK; }