From 19e1711a2ffa9689e1c4a92704126f0f6cb2c0d6 Mon Sep 17 00:00:00 2001 From: Quietust Date: Wed, 19 Sep 2012 10:20:18 -0500 Subject: [PATCH 01/18] Several Manipulator updates * Add documentation to README, cleanup some docs for other plugins * Preserve existing unit list order and cursor/scroll position * Adjust mouse input handling, don't move cursor on left-click --- README.rst | 48 +++++++++++++++++----- plugins/manipulator.cpp | 90 ++++++++++++++++++++++++++++------------- 2 files changed, 98 insertions(+), 40 deletions(-) diff --git a/README.rst b/README.rst index 8b6974abf..526add3ed 100644 --- a/README.rst +++ b/README.rst @@ -199,7 +199,8 @@ Examples: changevein ========== Changes material of the vein under cursor to the specified inorganic RAW -material. +material. Only affects tiles within the current 16x16 block - for veins and +large clusters, you will need to use this command multiple times. Example: -------- @@ -512,12 +513,6 @@ 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 -========= -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 ===== A tool for checking how many tiles contain flowing liquids. If you suspect that @@ -1477,10 +1472,41 @@ are mostly implemented by lua scripts. Dwarf Manipulator ================= -Implemented by the manipulator plugin. To activate, open the unit screen and press 'l'. - -This tool implements a Dwarf Therapist-like interface within the game ui. - +Implemented by the manipulator plugin. To activate, open the unit screen and +press 'l'. + +This tool implements a Dwarf Therapist-like interface within the game UI. The +far left column displays the unit's Happiness (color-coded based on its +value), and the right half of the screen displays each dwarf's labor settings +and skill levels (0-9 for Dabbling thru Professional, A-E for Great thru Grand +Master, and U-Z for Legendary thru Legendary+5). Cells with red backgrounds +denote skills not controlled by labors. + +Use the arrow keys or number pad to move the cursor around, holding Shift to +move 10 tiles at a time. + +Press the Z-Up (<) and Z-Down (>) keys to move quickly between labor/skill +categories. + +Press Enter to toggle the selected labor for the selected unit, or Shift+Enter +to toggle all labors within the selected category. + +Press the +- keys to sort the unit list according to the currently selected +skill/labor, and press the */ keys to sort the unit list by Name, Profession, +or Happiness (using Tab to select which sort method to use here). + +With a unit selected, you can press the "v" key to view its properties (and +possibly set a custom nickname or profession) or the "c" key to exit +Manipulator and zoom to its position within your fortress. + +The following mouse shortcuts are also available: +* Click on a column header to sort the unit list. Left-click to sort it in one + direction (descending for happiness or labors/skills, ascending for name or + profession) and right-click to sort it in the opposite direction. +* Left-click on a labor cell to toggle that labor. Right-click to move the + cursor onto that cell instead of toggling it. +* Left-click on a unit's name or profession to view its properties. +* Right-click on a unit's name or profession to zoom to it. Liquids ======= diff --git a/plugins/manipulator.cpp b/plugins/manipulator.cpp index 1ad46ab28..2b3fc86fc 100644 --- a/plugins/manipulator.cpp +++ b/plugins/manipulator.cpp @@ -338,7 +338,7 @@ public: std::string getFocusString() { return "unitlabors"; } - viewscreen_unitlaborsst(vector &src); + viewscreen_unitlaborsst(vector &src, int cursor_pos); ~viewscreen_unitlaborsst() { }; protected: @@ -354,7 +354,7 @@ protected: void calcSize (); }; -viewscreen_unitlaborsst::viewscreen_unitlaborsst(vector &src) +viewscreen_unitlaborsst::viewscreen_unitlaborsst(vector &src, int cursor_pos) { for (size_t i = 0; i < src.size(); i++) { @@ -382,12 +382,23 @@ viewscreen_unitlaborsst::viewscreen_unitlaborsst(vector &src) units.push_back(cur); } - std::sort(units.begin(), units.end(), sortByName); - altsort = ALTSORT_NAME; - first_row = sel_row = 0; first_column = sel_column = 0; + + first_row = 0; + sel_row = cursor_pos; calcSize(); + + // recalculate first_row to roughly match the original layout + first_row = 0; + while (first_row < sel_row - num_rows + 1) + first_row += num_rows + 2; + // make sure the selection stays visible + if (first_row > sel_row) + first_row = sel_row - num_rows + 1; + // don't scroll beyond the end + if (first_row > units.size() - num_rows) + first_row = units.size() - num_rows; } void viewscreen_unitlaborsst::calcSize() @@ -528,7 +539,11 @@ void viewscreen_unitlaborsst::feed(set *events) if (first_column < sel_column - col_widths[DISP_COLUMN_LABORS] + 1) first_column = sel_column - col_widths[DISP_COLUMN_LABORS] + 1; - // handle mouse input + int input_row = sel_row; + int input_column = sel_column; + int input_sort = altsort; + + // Translate mouse input to appropriate keyboard input if (enabler->tracking_on && gps->mouse_x != -1 && gps->mouse_y != -1) { int click_header = DISP_COLUMN_MAX; // group ID of the column header clicked @@ -560,34 +575,44 @@ void viewscreen_unitlaborsst::feed(set *events) case DISP_COLUMN_HAPPINESS: if (enabler->mouse_lbut || enabler->mouse_rbut) { - descending = enabler->mouse_lbut; - std::sort(units.begin(), units.end(), sortByHappiness); + input_sort = ALTSORT_HAPPINESS; + if (enabler->mouse_lbut) + events->insert(interface_key::SECONDSCROLL_PAGEUP); + if (enabler->mouse_rbut) + events->insert(interface_key::SECONDSCROLL_PAGEDOWN); } break; case DISP_COLUMN_NAME: if (enabler->mouse_lbut || enabler->mouse_rbut) { - descending = enabler->mouse_rbut; - std::sort(units.begin(), units.end(), sortByName); + input_sort = ALTSORT_NAME; + if (enabler->mouse_lbut) + events->insert(interface_key::SECONDSCROLL_PAGEDOWN); + if (enabler->mouse_rbut) + events->insert(interface_key::SECONDSCROLL_PAGEUP); } break; case DISP_COLUMN_PROFESSION: if (enabler->mouse_lbut || enabler->mouse_rbut) { - descending = enabler->mouse_rbut; - std::sort(units.begin(), units.end(), sortByProfession); + input_sort = ALTSORT_PROFESSION; + if (enabler->mouse_lbut) + events->insert(interface_key::SECONDSCROLL_PAGEDOWN); + if (enabler->mouse_rbut) + events->insert(interface_key::SECONDSCROLL_PAGEUP); } break; case DISP_COLUMN_LABORS: if (enabler->mouse_lbut || enabler->mouse_rbut) { - descending = enabler->mouse_lbut; - sort_skill = columns[click_labor].skill; - sort_labor = columns[click_labor].labor; - std::sort(units.begin(), units.end(), sortBySkill); + input_column = click_labor; + if (enabler->mouse_lbut) + events->insert(interface_key::SECONDSCROLL_UP); + if (enabler->mouse_rbut) + events->insert(interface_key::SECONDSCROLL_DOWN); } break; } @@ -603,12 +628,12 @@ void viewscreen_unitlaborsst::feed(set *events) // left-click to view, right-click to zoom if (enabler->mouse_lbut) { - sel_row = click_unit; + input_row = click_unit; events->insert(interface_key::UNITJOB_VIEW); } if (enabler->mouse_rbut) { - sel_row = click_unit; + input_row = click_unit; events->insert(interface_key::UNITJOB_ZOOM_CRE); } break; @@ -617,21 +642,28 @@ void viewscreen_unitlaborsst::feed(set *events) // left-click to toggle, right-click to just highlight if (enabler->mouse_lbut || enabler->mouse_rbut) { - sel_row = click_unit; - sel_column = click_labor; if (enabler->mouse_lbut) + { + input_row = click_unit; + input_column = click_labor; events->insert(interface_key::SELECT); + } + if (enabler->mouse_rbut) + { + sel_row = click_unit; + sel_column = click_labor; + } } break; } enabler->mouse_lbut = enabler->mouse_rbut = 0; } - UnitInfo *cur = units[sel_row]; - if (events->count(interface_key::SELECT) && (cur->allowEdit) && (columns[sel_column].labor != unit_labor::NONE)) + UnitInfo *cur = units[input_row]; + if (events->count(interface_key::SELECT) && (cur->allowEdit) && (columns[input_column].labor != unit_labor::NONE)) { df::unit *unit = cur->unit; - const SkillColumn &col = columns[sel_column]; + const SkillColumn &col = columns[input_column]; bool newstatus = !unit->status.labors[col.labor]; if (col.special) { @@ -650,7 +682,7 @@ void viewscreen_unitlaborsst::feed(set *events) if (events->count(interface_key::SELECT_ALL) && (cur->allowEdit)) { df::unit *unit = cur->unit; - const SkillColumn &col = columns[sel_column]; + const SkillColumn &col = columns[input_column]; bool newstatus = !unit->status.labors[col.labor]; for (int i = 0; i < NUM_COLUMNS; i++) { @@ -675,15 +707,15 @@ void viewscreen_unitlaborsst::feed(set *events) if (events->count(interface_key::SECONDSCROLL_UP) || events->count(interface_key::SECONDSCROLL_DOWN)) { descending = events->count(interface_key::SECONDSCROLL_UP); - sort_skill = columns[sel_column].skill; - sort_labor = columns[sel_column].labor; + sort_skill = columns[input_column].skill; + sort_labor = columns[input_column].labor; std::sort(units.begin(), units.end(), sortBySkill); } if (events->count(interface_key::SECONDSCROLL_PAGEUP) || events->count(interface_key::SECONDSCROLL_PAGEDOWN)) { descending = events->count(interface_key::SECONDSCROLL_PAGEUP); - switch (altsort) + switch (input_sort) { case ALTSORT_NAME: std::sort(units.begin(), units.end(), sortByName); @@ -718,7 +750,7 @@ void viewscreen_unitlaborsst::feed(set *events) { for (int i = 0; i < unitlist->units[unitlist->page].size(); i++) { - if (unitlist->units[unitlist->page][i] == units[sel_row]->unit) + if (unitlist->units[unitlist->page][i] == units[input_row]->unit) { unitlist->cursor_pos[unitlist->page] = i; unitlist->feed(events); @@ -964,7 +996,7 @@ struct unitlist_hook : df::viewscreen_unitlistst { if (units[page].size()) { - Screen::show(new viewscreen_unitlaborsst(units[page])); + Screen::show(new viewscreen_unitlaborsst(units[page], cursor_pos[page])); return; } } From b5ede66224f2fe9d112bbcf3b748dfa5a0569ca7 Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Wed, 19 Sep 2012 19:46:54 +0400 Subject: [PATCH 02/18] Switch some plugins to using world load/unload instead of map. Otherwise they apply and remove hooks every time fast travel is used. --- plugins/add-spatter.cpp | 8 ++++---- plugins/power-meter.cpp | 8 ++++---- plugins/steam-engine.cpp | 8 ++++---- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/plugins/add-spatter.cpp b/plugins/add-spatter.cpp index 35ea11ef5..425ffe9d0 100644 --- a/plugins/add-spatter.cpp +++ b/plugins/add-spatter.cpp @@ -397,7 +397,7 @@ static void enable_hooks(bool enable) DFhackCExport command_result plugin_onstatechange(color_ostream &out, state_change_event event) { switch (event) { - case SC_MAP_LOADED: + case SC_WORLD_LOADED: if (find_reactions(out)) { out.print("Detected spatter add reactions - enabling plugin.\n"); @@ -406,7 +406,7 @@ DFhackCExport command_result plugin_onstatechange(color_ostream &out, state_chan else enable_hooks(false); break; - case SC_MAP_UNLOADED: + case SC_WORLD_UNLOADED: enable_hooks(false); reactions.clear(); products.clear(); @@ -420,8 +420,8 @@ DFhackCExport command_result plugin_onstatechange(color_ostream &out, state_chan DFhackCExport command_result plugin_init ( color_ostream &out, std::vector &commands) { - if (Core::getInstance().isMapLoaded()) - plugin_onstatechange(out, SC_MAP_LOADED); + if (Core::getInstance().isWorldLoaded()) + plugin_onstatechange(out, SC_WORLD_LOADED); return CR_OK; } diff --git a/plugins/power-meter.cpp b/plugins/power-meter.cpp index 0466b68e4..17261adb2 100644 --- a/plugins/power-meter.cpp +++ b/plugins/power-meter.cpp @@ -200,7 +200,7 @@ DFHACK_PLUGIN_LUA_FUNCTIONS { DFhackCExport command_result plugin_onstatechange(color_ostream &out, state_change_event event) { switch (event) { - case SC_MAP_LOADED: + case SC_WORLD_LOADED: { auto pworld = Core::getInstance().getWorld(); bool enable = pworld->GetPersistentData("power-meter/enabled").isValid(); @@ -212,7 +212,7 @@ DFhackCExport command_result plugin_onstatechange(color_ostream &out, state_chan } } break; - case SC_MAP_UNLOADED: + case SC_WORLD_UNLOADED: enable_hooks(false); break; default: @@ -224,8 +224,8 @@ DFhackCExport command_result plugin_onstatechange(color_ostream &out, state_chan DFhackCExport command_result plugin_init ( color_ostream &out, std::vector &commands) { - if (Core::getInstance().isMapLoaded()) - plugin_onstatechange(out, SC_MAP_LOADED); + if (Core::getInstance().isWorldLoaded()) + plugin_onstatechange(out, SC_WORLD_LOADED); return CR_OK; } diff --git a/plugins/steam-engine.cpp b/plugins/steam-engine.cpp index cacfc6e16..d884191e5 100644 --- a/plugins/steam-engine.cpp +++ b/plugins/steam-engine.cpp @@ -972,7 +972,7 @@ static void enable_hooks(bool enable) DFhackCExport command_result plugin_onstatechange(color_ostream &out, state_change_event event) { switch (event) { - case SC_MAP_LOADED: + case SC_WORLD_LOADED: if (find_engines()) { out.print("Detected steam engine workshops - enabling plugin.\n"); @@ -981,7 +981,7 @@ DFhackCExport command_result plugin_onstatechange(color_ostream &out, state_chan else enable_hooks(false); break; - case SC_MAP_UNLOADED: + case SC_WORLD_UNLOADED: enable_hooks(false); engines.clear(); break; @@ -994,8 +994,8 @@ DFhackCExport command_result plugin_onstatechange(color_ostream &out, state_chan DFhackCExport command_result plugin_init ( color_ostream &out, std::vector &commands) { - if (Core::getInstance().isMapLoaded()) - plugin_onstatechange(out, SC_MAP_LOADED); + if (Core::getInstance().isWorldLoaded()) + plugin_onstatechange(out, SC_WORLD_LOADED); return CR_OK; } From a80f574be8869cb8dc308ccb3da31257ad02e57c Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Wed, 19 Sep 2012 19:52:57 +0400 Subject: [PATCH 03/18] Only initialize siege engine in dwarf mode. --- plugins/siege-engine.cpp | 1 + 1 file changed, 1 insertion(+) diff --git a/plugins/siege-engine.cpp b/plugins/siege-engine.cpp index 3b95aba35..2e362afec 100644 --- a/plugins/siege-engine.cpp +++ b/plugins/siege-engine.cpp @@ -1821,6 +1821,7 @@ DFhackCExport command_result plugin_onstatechange(color_ostream &out, state_chan { switch (event) { case SC_MAP_LOADED: + if (!gamemode || *gamemode == game_mode::DWARF) { auto pworld = Core::getInstance().getWorld(); bool enable = pworld->GetPersistentData("siege-engine/enabled").isValid(); From 0c260d53526ff2fb8bdf06d531a8b51ca2ef72f8 Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Wed, 19 Sep 2012 20:10:28 +0400 Subject: [PATCH 04/18] Tweak README some more. --- README.rst | 19 ++- Readme.html | 451 ++++++++++++++++++++++++++++------------------------ 2 files changed, 252 insertions(+), 218 deletions(-) diff --git a/README.rst b/README.rst index 526add3ed..589451a9a 100644 --- a/README.rst +++ b/README.rst @@ -1491,8 +1491,8 @@ categories. Press Enter to toggle the selected labor for the selected unit, or Shift+Enter to toggle all labors within the selected category. -Press the +- keys to sort the unit list according to the currently selected -skill/labor, and press the */ keys to sort the unit list by Name, Profession, +Press the ``+-`` keys to sort the unit list according to the currently selected +skill/labor, and press the ``*/`` keys to sort the unit list by Name, Profession, or Happiness (using Tab to select which sort method to use here). With a unit selected, you can press the "v" key to view its properties (and @@ -1500,6 +1500,7 @@ possibly set a custom nickname or profession) or the "c" key to exit Manipulator and zoom to its position within your fortress. The following mouse shortcuts are also available: + * Click on a column header to sort the unit list. Left-click to sort it in one direction (descending for happiness or labors/skills, ascending for name or profession) and right-click to sort it in the opposite direction. @@ -1574,14 +1575,19 @@ Front-end to the siege-engine plugin implemented by the gui/siege-engine script. key and activate after selecting a siege engine in 'q' mode. The main mode displays the current target, selected ammo item type, linked stockpiles and -the allowed operator skill range. The map tile color is changed to reflect if it can be -hit by the selected engine. +the allowed operator skill range. The map tile color is changed to signify if it can be +hit by the selected engine: green for fully reachable, blue for out of range, red for blocked, +yellow for partially blocked. Pressing 'r' changes into the target selection mode, which works by highlighting two points with Enter like all designations. When a target area is set, the engine projectiles are aimed at that area, or units within it, instead of the vanilla four directions. -Pressing 't' switches to stockpile selection. +After setting the target in this way for one engine, you can 'paste' the same area into others +just by pressing 'p' in the main page of this script. The area to paste is kept until you quit +DF, or select another area manually. + +Pressing 't' switches to a mode for selecting a stockpile to take ammo from. Exiting from the siege engine script via ESC reverts the view to the state prior to starting the script. Shift-ESC retains the current viewport, and also exits from the 'q' mode to main @@ -1702,4 +1708,5 @@ produce contaminants on the items instead of improvements. Intended to give some use to all those poisons that can be bought from caravans. -To be really useful this needs patches from bug 808 and ``tweak fix-dimensions``. +To be really useful this needs patches from bug 808, ``tweak fix-dimensions`` +and ``tweak advmode-contained``. diff --git a/Readme.html b/Readme.html index 001e89b1f..4c005b6ff 100644 --- a/Readme.html +++ b/Readme.html @@ -417,140 +417,139 @@ access DF memory and allow for easier development of new tools.

  • fixdiplomats
  • fixmerchants
  • fixveins
    • -
  • fixwagons
    • -
  • flows
    • -
  • getplants
      -
    • Options
      • +
    • flows
      • +
    • getplants
      • -
    • tidlers
      • -
    • twaterlvl
      • -
    • job
      • -
    • job-material
      • -
    • job-duplicate
      • -
    • keybinding
        -
      • Options
        • +
      • tidlers
        • +
      • twaterlvl
        • +
      • job
        • +
      • job-material
        • +
      • job-duplicate
        • +
      • keybinding
        • -
      • liquids
        • -
      • liquids-here
        • -
      • mode
        • -
      • extirpate
          -
        • Options
          • +
        • liquids
          • +
        • liquids-here
          • +
        • mode
          • +
        • extirpate
          • -
        • grow
          • -
        • immolate
          • -
        • probe
          • -
        • prospect
            -
          • Options
            • -
          • Pre-embark estimate
            • -
          • Options
            • +
          • grow
            • +
          • immolate
            • +
          • probe
            • +
          • prospect
            • -
          • regrass
            • -
          • rename
              -
            • Options
              • +
            • regrass
              • +
            • rename
              • -
            • reveal
              • -
            • unreveal
              • -
            • revtoggle
              • -
            • revflood
              • -
            • revforget
              • -
            • lair
                -
              • Options
                • +
              • reveal
                • +
              • unreveal
                • +
              • revtoggle
                • +
              • revflood
                • +
              • revforget
                • +
              • lair
                • -
              • seedwatch
                • -
              • showmood
                • -
              • copystock
                • -
              • ssense / stonesense
                • -
              • tiletypes
                • -
              • tiletypes-commands
                • -
              • tiletypes-here
                • -
              • tiletypes-here-point
                • -
              • tweak
                  -
                • Options
                  • +
                • seedwatch
                  • +
                • showmood
                  • +
                • copystock
                  • +
                • ssense / stonesense
                  • +
                • tiletypes
                  • +
                • tiletypes-commands
                  • +
                • tiletypes-here
                  • +
                • tiletypes-here-point
                  • +
                • tweak
                  • -
                • tubefill
                  • -
                • digv
                  • -
                • digvx
                  • -
                • digl
                  • -
                • diglx
                  • -
                • digexp
                    -
                  • Patterns:
                    • -
                  • Filters:
                    • -
                  • Examples:
                    • +
                  • tubefill
                    • +
                  • digv
                    • +
                  • digvx
                    • +
                  • digl
                    • +
                  • diglx
                    • +
                  • digexp
                    • -
                  • digcircle
                      -
                    • Shape:
                      • -
                    • Action:
                      • -
                    • Designation types:
                      • -
                    • Examples:
                      • +
                    • digcircle
                      • -
                    • weather
                        -
                      • Options:
                        • +
                      • weather
                        • -
                      • workflow
                          -
                        • Usage
                          • -
                        • Function
                          • -
                        • Constraint examples
                          • +
                        • workflow
                          • -
                        • mapexport
                          • -
                        • dwarfexport
                          • -
                        • zone
                            -
                          • Options:
                            • -
                          • Filters:
                            • -
                          • Usage with single units
                            • -
                          • Usage with filters
                            • -
                          • Mass-renaming
                            • -
                          • Cage zones
                            • -
                          • Examples
                            • +
                          • mapexport
                            • +
                          • dwarfexport
                            • +
                          • zone
                            • -
                          • autonestbox
                              -
                            • Options:
                              • +
                            • autonestbox
                              • -
                            • autobutcher
                              • -
                            • In-game interface tools
                                -
                              • Dwarf Manipulator
                                • -
                              • Liquids
                                • -
                              • Mechanisms
                                • -
                              • Power Meter
                                • -
                              • Rename
                                • -
                              • Room List
                                • -
                              • Siege Engine
                                • +
                              • In-game interface tools
                                • -
                              • RAW hacks
                                  -
                                • Steam Engine @@ -754,7 +753,8 @@ You did save your game, right?

                                  • changevein

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

                                  +material. Only affects tiles within the current 16x16 block - for veins and +large clusters, you will need to use this command multiple times.

                                  Example:

                                  @@ -1225,25 +1225,19 @@ and earlier) in case you haven't already modified your raws accordingly.

                                  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

                                  -

                                  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

                                  @@ -1264,15 +1258,15 @@ all valid plant IDs will be listed.

                                  -

                                  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:
                                  @@ -1289,7 +1283,7 @@ the job item.
                                  -

                                  job-material

                                  +

                                  job-material

                                  Alter the material of the selected job.

                                  Invoked as: job-material <inorganic-token>

                                  @@ -1305,7 +1299,7 @@ over the first available choice with the matching material.
                                  -

                                  job-duplicate

                                  +

                                  job-duplicate

                                  Duplicate the selected job in a workshop:
                                    @@ -1316,11 +1310,11 @@ instantly duplicates the job.
                                  -

                                  keybinding

                                  +

                                  keybinding

                                  Manages DFHack keybindings.

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

                                  @@ -1348,7 +1342,7 @@ as a hotkey are always considered applicable.

                                  -

                                  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. Settings will be remembered as long as dfhack runs. Intended for use in combination with the command @@ -1361,13 +1355,13 @@ temperatures (creating heat traps). You've been warned.

                                  -

                                  liquids-here

                                  +

                                  liquids-here

                                  Run the liquid spawner with the current/last settings made in liquids (if no settings in liquids were made it paints a point of 7/7 magma by default).

                                  Intended to be used as keybinding. Requires an active in-game cursor.

                                  -

                                  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.

                                  @@ -1386,11 +1380,11 @@ You just created a returnable mountain home and gained an adventurer.

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

                                  -

                                  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.

                                  @@ -1406,24 +1400,24 @@ a tree/shrub under the cursor. 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.

                                  @@ -1438,14 +1432,14 @@ the visible part of the map is scanned.

                                  -

                                  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

                                  @@ -1457,14 +1451,14 @@ for all tiles of the embark rectangle.

                                  -

                                  regrass

                                  +

                                  regrass

                                  Regrows grass. Not much to it ;)

                                  -

                                  rename

                                  +

                                  rename

                                  Allows renaming various things.

                                  @@ -1493,7 +1487,7 @@ The building must be one of stockpile, workshop, furnace, trap or siege engine.<
                                  -

                                  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 @@ -1502,33 +1496,33 @@ to unpause with hell revealed, use 'reveal demons'.

                                  you move. When you use it this way, you don't need to run 'unreveal'.

                                  -

                                  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.

                                  -

                                  revforget

                                  +

                                  revforget

                                  When you use reveal, it saves information about what was/wasn't visible before revealing everything. Unreveal uses this information to hide things again. This command throws away the information. For example, use in cases where you abandoned with the fort revealed and no longer want the data.

                                  -

                                  lair

                                  +

                                  lair

                                  This command allows you to mark the map as 'monster lair', preventing item scatter on abandon. When invoked as 'lair reset', it does the opposite.

                                  Unlike reveal, this command doesn't save the information about tiles - you won't be able to restore state of real monster lairs using 'lair reset'.

                                  @@ -1542,23 +1536,23 @@ won't be able to restore state of real monster lairs using 'lair reset'.

                                  -

                                  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).

                                  @@ -1571,7 +1565,7 @@ thread: http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository

                                  -

                                  tiletypes

                                  +

                                  tiletypes

                                  Can be used for painting map tiles and is an interactive command, much like liquids.

                                  The tool works with two set of options and a brush. The brush determines which @@ -1632,25 +1626,25 @@ up.

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

                                  -

                                  tiletypes-commands

                                  +

                                  tiletypes-commands

                                  Runs tiletypes commands, separated by ;. This makes it possible to change tiletypes modes from a hotkey.

                                  -

                                  tiletypes-here

                                  +

                                  tiletypes-here

                                  Apply the current tiletypes options at the in-game cursor position, including the brush. Can be used from a hotkey.

                                  -

                                  tiletypes-here-point

                                  +

                                  tiletypes-here-point

                                  Apply the current tiletypes options at the in-game cursor position to a single tile. Can be used from a hotkey.

                                  -

                                  tweak

                                  +

                                  tweak

                                  Contains various tweaks for minor bugs (currently just one).

                                  @@ -1717,22 +1711,22 @@ reagents.
                                  -

                                  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).

                                  -

                                  digv

                                  +

                                  digv

                                  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).

                                  -

                                  digvx

                                  +

                                  digvx

                                  A permanent alias for 'digv x'.

                                  -

                                  digl

                                  +

                                  digl

                                  Designates layer stone for digging. Requires an active in-game cursor placed over a layer stone tile. With the 'x' option, it will traverse z-levels (putting stairs between the same-material tiles). With the 'undo' option it @@ -1740,16 +1734,16 @@ will remove the dig designation instead (if you realize that digging out a 50 z-level deep layer was not such a good idea after all).

                                  -

                                  diglx

                                  +

                                  diglx

                                  A permanent alias for 'digl x'.

                                  -

                                  digexp

                                  +

                                  digexp

                                  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.

                                  @@ -1770,7 +1764,7 @@ z-level deep layer was not such a good idea after all).

                                  -

                                  Filters:

                                  +

                                  Filters:

                                  @@ -1786,7 +1780,7 @@ z-level deep layer was not such a good idea after all).

                                  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:
                                    @@ -1807,11 +1801,11 @@ z-level deep layer was not such a good idea after all).

                                  -

                                  digcircle

                                  +

                                  digcircle

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

                                  @@ -1826,7 +1820,7 @@ It has several types of options.

                                  -

                                  Action:

                                  +

                                  Action:

                                  @@ -1841,7 +1835,7 @@ It has several types of options.

                                  -

                                  Designation types:

                                  +

                                  Designation types:

                                  @@ -1864,7 +1858,7 @@ It has several types of options.

                                  repeats with the last selected parameters.

                                  -

                                  Examples:

                                  +

                                  Examples:

                                  • 'digcircle filled 3' = Dig a filled circle with radius = 3.
                                  • 'digcircle' = Do it again.
                                    • @@ -1872,11 +1866,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'.

                                  @@ -1892,10 +1886,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. @@ -1916,7 +1910,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.

                                  @@ -1927,7 +1921,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
@@ -1965,19 +1959,19 @@ 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.

                                  -

                                  zone

                                  +

                                  zone

                                  Helps a bit with managing activity zones (pens, pastures and pits) and cages.

                                  @@ -2016,7 +2010,7 @@ the cursor are listed.
                                  -

                                  Filters:

                                  +

                                  Filters:

                                  @@ -2073,7 +2067,7 @@ for war/hunt). Negatable.
                                  -

                                  Usage with single units

                                  +

                                  Usage with single units

                                  One convenient way to use the zone tool is to bind the command 'zone assign' to a hotkey, maybe also the command 'zone set'. Place the in-game cursor over a pen/pasture or pit, use 'zone set' to mark it. Then you can select units @@ -2082,7 +2076,7 @@ and use 'zone assign' to assign them to their new home. Allows pitting your own dwarves, by the way.

                                  -

                                  Usage with filters

                                  +

                                  Usage with filters

                                  All filters can be used together with the 'assign' command.

                                  Restrictions: It's not possible to assign units who are inside built cages or chained because in most cases that won't be desirable anyways. @@ -2100,14 +2094,14 @@ are not properly added to your own stocks; slaughtering them should work).

                                  Most filters can be negated (e.g. 'not grazer' -> race is not a grazer).

                                  -

                                  Mass-renaming

                                  +

                                  Mass-renaming

                                  Using the 'nick' command you can set the same nickname for multiple units. If used without 'assign', 'all' or 'count' it will rename all units in the current default target zone. Combined with 'assign', 'all' or 'count' (and further optional filters) it will rename units matching the filter conditions.

                                  -

                                  Cage zones

                                  +

                                  Cage zones

                                  Using the 'tocages' command you can assign units to a set of cages, for example a room next to your butcher shop(s). They will be spread evenly among available cages to optimize hauling to and butchering from them. For this to work you need @@ -2118,7 +2112,7 @@ would make no sense, but can be used together with 'nick' or 'remnick' and all the usual filters.

                                  -

                                  Examples

                                  +

                                  Examples

                                  zone assign all own ALPACA minage 3 maxage 10
                                  Assign all own alpacas who are between 3 and 10 years old to the selected @@ -2144,7 +2138,7 @@ on the current default zone.
                                  -

                                  autonestbox

                                  +

                                  autonestbox

                                  Assigns unpastured female egg-layers to nestbox zones. Requires that you create pen/pasture zones above nestboxes. If the pen is bigger than 1x1 the nestbox must be in the top left corner. Only 1 unit will be assigned per pen, regardless @@ -2155,7 +2149,7 @@ processed since pasturing half-trained wild egglayers could destroy your neat nestbox zones when they revert to wild. When called without options autonestbox will instantly run once.

                                  -

                                  Options:

                                  +

                                  Options:

                                  @@ -2173,7 +2167,7 @@ frames between runs.
                                  -

                                  autobutcher

                                  +

                                  autobutcher

                                  Assigns lifestock for slaughter once it reaches a specific count. Requires that you add the target race(s) to a watch list. Only tame units will be processed.

                                  Named units will be completely ignored (to protect specific animals from @@ -2187,7 +2181,7 @@ Once you have too much kids, the youngest will be butchered first. If you don't set any target count the following default will be used: 1 male kid, 5 female kids, 1 male adult, 5 female adults.

                                  @@ -2240,7 +2234,7 @@ for future entries.
                                  -

                                  Examples:

                                  +

                                  Examples:

                                  You want to keep max 7 kids (4 female, 3 male) and max 3 adults (2 female, 1 male) of the race alpaca. Once the kids grow up the oldest adults will get slaughtered. Excess kids will get slaughtered starting with the youngest @@ -2271,7 +2265,7 @@ autobutcher unwatch ALPACA CAT

                                  -

                                  Note:

                                  +

                                  Note:

                                  Settings and watchlist are stored in the savegame, so that you can have different settings for each world. If you want to copy your watchlist to another savegame you can use the command list_export:

                                  @@ -2285,7 +2279,7 @@ autobutcher.bat
                                  -

                                  autolabor

                                  +

                                  autolabor

                                  Automatically manage dwarf labors.

                                  When enabled, autolabor periodically checks your dwarves and enables or disables labors. It tries to keep as many dwarves as possible busy but @@ -2298,7 +2292,7 @@ while it is enabled.

                                  For detailed usage information, see 'help autolabor'.

                                  -

                                  growcrops

                                  +

                                  growcrops

                                  Instantly grow seeds inside farming plots.

                                  With no argument, this command list the various seed types currently in use in your farming plots. @@ -2310,7 +2304,7 @@ growcrops plump 40

                                  -

                                  removebadthoughts

                                  +

                                  removebadthoughts

                                  This script remove negative thoughts from your dwarves. Very useful against tantrum spirals.

                                  With a selected unit in 'v' mode, will clear this unit's mind, otherwise @@ -2323,7 +2317,7 @@ you unpause.

                                  it removed.

                                  -

                                  slayrace

                                  +

                                  slayrace

                                  Kills any unit of a given race.

                                  With no argument, lists the available races.

                                  With the special argument 'him', targets only the selected creature.

                                  @@ -2349,7 +2343,7 @@ slayrace elve magma
                                  -

                                  magmasource

                                  +

                                  magmasource

                                  Create an infinite magma source on a tile.

                                  This script registers a map tile as a magma source, and every 12 game ticks that tile receives 1 new unit of flowing magma.

                                  @@ -2365,22 +2359,50 @@ To remove all placed sources, call magmasource stop
                                  -

                                  In-game interface tools

                                  +

                                  In-game interface tools

                                  These tools work by displaying dialogs or overlays in the game window, and are mostly implemented by lua scripts.

                                  -

                                  Dwarf Manipulator

                                  -

                                  Implemented by the manipulator plugin. To activate, open the unit screen and press 'l'.

                                  -

                                  This tool implements a Dwarf Therapist-like interface within the game ui.

                                  +

                                  Dwarf Manipulator

                                  +

                                  Implemented by the manipulator plugin. To activate, open the unit screen and +press 'l'.

                                  +

                                  This tool implements a Dwarf Therapist-like interface within the game UI. The +far left column displays the unit's Happiness (color-coded based on its +value), and the right half of the screen displays each dwarf's labor settings +and skill levels (0-9 for Dabbling thru Professional, A-E for Great thru Grand +Master, and U-Z for Legendary thru Legendary+5). Cells with red backgrounds +denote skills not controlled by labors.

                                  +

                                  Use the arrow keys or number pad to move the cursor around, holding Shift to +move 10 tiles at a time.

                                  +

                                  Press the Z-Up (<) and Z-Down (>) keys to move quickly between labor/skill +categories.

                                  +

                                  Press Enter to toggle the selected labor for the selected unit, or Shift+Enter +to toggle all labors within the selected category.

                                  +

                                  Press the +- keys to sort the unit list according to the currently selected +skill/labor, and press the */ keys to sort the unit list by Name, Profession, +or Happiness (using Tab to select which sort method to use here).

                                  +

                                  With a unit selected, you can press the "v" key to view its properties (and +possibly set a custom nickname or profession) or the "c" key to exit +Manipulator and zoom to its position within your fortress.

                                  +

                                  The following mouse shortcuts are also available:

                                  +
                                    +
                                  • Click on a column header to sort the unit list. Left-click to sort it in one +direction (descending for happiness or labors/skills, ascending for name or +profession) and right-click to sort it in the opposite direction.
                                    • +
                                  • Left-click on a labor cell to toggle that labor. Right-click to move the +cursor onto that cell instead of toggling it.
                                    • +
                                  • Left-click on a unit's name or profession to view its properties.
                                    • +
                                  • Right-click on a unit's name or profession to zoom to it.
                                    • +
                                  -

                                  Liquids

                                  +

                                  Liquids

                                  Implemented by the gui/liquids script. To use, bind to a key and activate in the 'k' mode.

                                  While active, use the suggested keys to switch the usual liquids parameters, and Enter to select the target area and apply changes.

                                  -

                                  Mechanisms

                                  +

                                  Mechanisms

                                  Implemented by the gui/mechanims script. To use, bind to a key and activate in the 'q' mode.

                                  Lists mechanisms connected to the building, and their links. Navigating the list centers the view on the relevant linked buildings.

                                  @@ -2389,14 +2411,14 @@ focus on the current one. Shift-Enter has an effect equivalent to pressing Enter re-entering the mechanisms ui.

                                  -

                                  Power Meter

                                  +

                                  Power Meter

                                  Front-end to the power-meter plugin implemented by the gui/power-meter script. Bind to a key and activate after selecting Pressure Plate in the build menu.

                                  The script follows the general look and feel of the regular pressure plate build configuration page, but configures parameters relevant to the modded power meter building.

                                  -

                                  Rename

                                  +

                                  Rename

                                  Backed by the rename plugin, the gui/rename script allows entering the desired name via a simple dialog in the game ui.

                                    @@ -2411,23 +2433,27 @@ via a simple dialog in the game ui.

                                    The building or unit are automatically assumed when in relevant ui state.

                                  -

                                  Room List

                                  +

                                  Room List

                                  Implemented by the gui/room-list script. To use, bind to a key and activate in the 'q' mode, either immediately or after opening the assign owner page.

                                  The script lists other rooms owned by the same owner, or by the unit selected in the assign list, and allows unassigning them.

                                  -

                                  Siege Engine

                                  +

                                  Siege Engine

                                  Front-end to the siege-engine plugin implemented by the gui/siege-engine script. Bind to a key and activate after selecting a siege engine in 'q' mode.

                                  The main mode displays the current target, selected ammo item type, linked stockpiles and -the allowed operator skill range. The map tile color is changed to reflect if it can be -hit by the selected engine.

                                  +the allowed operator skill range. The map tile color is changed to signify if it can be +hit by the selected engine: green for fully reachable, blue for out of range, red for blocked, +yellow for partially blocked.

                                  Pressing 'r' changes into the target selection mode, which works by highlighting two points with Enter like all designations. When a target area is set, the engine projectiles are aimed at that area, or units within it, instead of the vanilla four directions.

                                  -

                                  Pressing 't' switches to stockpile selection.

                                  +

                                  After setting the target in this way for one engine, you can 'paste' the same area into others +just by pressing 'p' in the main page of this script. The area to paste is kept until you quit +DF, or select another area manually.

                                  +

                                  Pressing 't' switches to a mode for selecting a stockpile to take ammo from.

                                  Exiting from the siege engine script via ESC reverts the view to the state prior to starting the script. Shift-ESC retains the current viewport, and also exits from the 'q' mode to main menu.

                                  @@ -2438,14 +2464,14 @@ e.g. like making siegers bring their own, are something only Toady can do.

                                  -

                                  RAW hacks

                                  +

                                  RAW hacks

                                  These plugins detect certain structures in RAWs, and enhance them in various ways.

                                  -

                                  Steam Engine

                                  +

                                  Steam Engine

                                  The steam-engine plugin detects custom workshops with STEAM_ENGINE in their token, and turns them into real steam engines.

                                  -

                                  Rationale

                                  +

                                  Rationale

                                  The vanilla game contains only water wheels and windmills as sources of power, but windmills give relatively little power, and water wheels require flowing water, which must either be a real river and thus immovable and @@ -2456,7 +2482,7 @@ it can be done just by combining existing features of the game engine in a new way with some glue code and a bit of custom logic.

                                  -

                                  Construction

                                  +

                                  Construction

                                  The workshop needs water as its input, which it takes via a passable floor tile below it, like usual magma workshops do. The magma version also needs magma.

                                  @@ -2474,7 +2500,7 @@ This also means that engines cannot be chained without intermediate short axles that can be built later.

                                  -

                                  Operation

                                  +

                                  Operation

                                  In order to operate the engine, queue the Stoke Boiler job (optionally on repeat). A furnace operator will come, possibly bringing a bar of fuel, and perform it. As a result, a "boiling water" item will appear @@ -2499,7 +2525,7 @@ decrease it by further 4%, and also decrease the whole steam use rate by 10%.

                                  -

                                  Explosions

                                  +

                                  Explosions

                                  The engine must be constructed using barrel, pipe and piston from fire-safe, or in the magma version magma-safe metals.

                                  During operation weak parts get gradually worn out, and @@ -2508,7 +2534,7 @@ toppled during operation by a building destroyer, or a tantruming dwarf.

                                  -

                                  Save files

                                  +

                                  Save files

                                  It should be safe to load and view engine-using fortresses from a DF version without DFHack installed, except that in such case the engines won't work. However actually making modifications @@ -2519,11 +2545,12 @@ being generated.

                                  -

                                  Add Spatter

                                  +

                                  Add Spatter

                                  This plugin makes reactions with names starting with SPATTER_ADD_ produce contaminants on the items instead of improvements.

                                  Intended to give some use to all those poisons that can be bought from caravans.

                                  -

                                  To be really useful this needs patches from bug 808 and tweak fix-dimensions.

                                  +

                                  To be really useful this needs patches from bug 808, tweak fix-dimensions +and tweak advmode-contained.

                                  From 1fd0654d635ebf8da74fb581eb8d3f16c98b0444 Mon Sep 17 00:00:00 2001 From: Quietust Date: Wed, 19 Sep 2012 22:55:38 -0500 Subject: [PATCH 05/18] Restore stonesense to the proper revision --- plugins/stonesense | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/stonesense b/plugins/stonesense index 37a823541..2a62ba5ed 160000 --- a/plugins/stonesense +++ b/plugins/stonesense @@ -1 +1 @@ -Subproject commit 37a823541538023b9f3d0d1e8039cf32851de68d +Subproject commit 2a62ba5ed2607f4dbf0473e77502d4e19c19678e From 7ce772ae0ea69ab26009a27d71bd681382ecfac7 Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Thu, 20 Sep 2012 10:41:03 +0400 Subject: [PATCH 06/18] Add an API function that returns the selected building. --- LUA_API.rst | 4 +++ Lua API.html | 3 ++ library/LuaApi.cpp | 1 + library/include/modules/Gui.h | 4 +++ library/modules/Gui.cpp | 58 +++++++++++++++++++++++++++++++++++ 5 files changed, 70 insertions(+) diff --git a/LUA_API.rst b/LUA_API.rst index c5f9a1c58..898ab79c0 100644 --- a/LUA_API.rst +++ b/LUA_API.rst @@ -777,6 +777,10 @@ Gui module last case, the highlighted *contained item* is returned, not the container itself. +* ``dfhack.gui.getSelectedBuilding([silent])`` + + Returns the building selected via *'q'*, *'t'*, *'k'* or *'i'*. + * ``dfhack.gui.showAnnouncement(text,color[,is_bright])`` Adds a regular announcement with given text, color, and brightness. diff --git a/Lua API.html b/Lua API.html index 07f038bc4..97770ff77 100644 --- a/Lua API.html +++ b/Lua API.html @@ -1032,6 +1032,9 @@ a full-screen item view of a container. Note that in the last case, the highlighted contained item is returned, not the container itself.

                                  +

                                • dfhack.gui.getSelectedBuilding([silent])

                                  +

                                  Returns the building selected via 'q', 't', 'k' or 'i'.

                                  +

                                • dfhack.gui.showAnnouncement(text,color[,is_bright])

                                  Adds a regular announcement with given text, color, and brightness. The is_bright boolean actually seems to invert the brightness.

                                  diff --git a/library/LuaApi.cpp b/library/LuaApi.cpp index d73d14cf9..b2d41dc19 100644 --- a/library/LuaApi.cpp +++ b/library/LuaApi.cpp @@ -760,6 +760,7 @@ static const LuaWrapper::FunctionReg dfhack_gui_module[] = { WRAPM(Gui, getSelectedJob), WRAPM(Gui, getSelectedUnit), WRAPM(Gui, getSelectedItem), + WRAPM(Gui, getSelectedBuilding), WRAPM(Gui, showAnnouncement), WRAPM(Gui, showZoomAnnouncement), WRAPM(Gui, showPopupAnnouncement), diff --git a/library/include/modules/Gui.h b/library/include/modules/Gui.h index 97e8bd422..b06408f68 100644 --- a/library/include/modules/Gui.h +++ b/library/include/modules/Gui.h @@ -91,6 +91,10 @@ namespace DFHack DFHACK_EXPORT bool any_item_hotkey(df::viewscreen *top); DFHACK_EXPORT df::item *getSelectedItem(color_ostream &out, bool quiet = false); + // A building is selected via 'q', 't' or 'i' (civzone) + DFHACK_EXPORT bool any_building_hotkey(df::viewscreen *top); + DFHACK_EXPORT df::building *getSelectedBuilding(color_ostream &out, bool quiet = false); + // Show a plain announcement, or a titan-style popup message DFHACK_EXPORT void showAnnouncement(std::string message, int color = 7, bool bright = true); DFHACK_EXPORT void showZoomAnnouncement(df::announcement_type type, df::coord pos, std::string message, int color = 7, bool bright = true); diff --git a/library/modules/Gui.cpp b/library/modules/Gui.cpp index 1662f4467..10a20dc2e 100644 --- a/library/modules/Gui.cpp +++ b/library/modules/Gui.cpp @@ -933,6 +933,64 @@ df::item *Gui::getSelectedItem(color_ostream &out, bool quiet) return item; } +static df::building *getAnyBuilding(df::viewscreen *top) +{ + using namespace ui_sidebar_mode; + using df::global::ui; + using df::global::ui_look_list; + using df::global::ui_look_cursor; + using df::global::world; + using df::global::ui_sidebar_menus; + + if (!Gui::dwarfmode_hotkey(top)) + return NULL; + + switch (ui->main.mode) { + case LookAround: + { + if (!ui_look_list || !ui_look_cursor) + return NULL; + + auto item = vector_get(ui_look_list->items, *ui_look_cursor); + if (item && item->type == df::ui_look_list::T_items::Building) + return item->building; + else + return NULL; + } + case QueryBuilding: + case BuildingItems: + { + return world->selected_building; + } + case Zones: + case ZonesPenInfo: + case ZonesPitInfo: + case ZonesHospitalInfo: + { + if (ui_sidebar_menus) + return ui_sidebar_menus->zone.selected; + return NULL; + } + default: + return NULL; + } +} + +bool Gui::any_building_hotkey(df::viewscreen *top) +{ + return getAnyBuilding(top) != NULL; +} + +df::building *Gui::getSelectedBuilding(color_ostream &out, bool quiet) +{ + df::building *building = getAnyBuilding(Core::getTopViewscreen()); + + if (!building && !quiet) + out.printerr("No building is selected in the UI.\n"); + + return building; +} + // static void doShowAnnouncement( From c39a33722316ee91f7a42abcd76149788dd19196 Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Thu, 20 Sep 2012 11:11:20 +0400 Subject: [PATCH 07/18] Add unit/item/job/building getter hook vmethods to dfhack_viewscreen. --- LUA_API.rst | 8 +++++++ Lua API.html | 10 ++++++++ library/include/modules/Screen.h | 18 ++++++++++++++ library/modules/Gui.cpp | 11 +++++++++ library/modules/Screen.cpp | 41 ++++++++++++++++++++++++++++++++ library/xml | 2 +- plugins/manipulator.cpp | 7 ++++++ 7 files changed, 96 insertions(+), 1 deletion(-) diff --git a/LUA_API.rst b/LUA_API.rst index 898ab79c0..d9b75c480 100644 --- a/LUA_API.rst +++ b/LUA_API.rst @@ -1467,6 +1467,14 @@ Supported callbacks and fields are: If this method is omitted, the screen is dismissed on receival of the ``LEAVESCREEN`` key. +* ``function screen:onGetSelectedUnit()`` +* ``function screen:onGetSelectedItem()`` +* ``function screen:onGetSelectedJob()`` +* ``function screen:onGetSelectedBuilding()`` + + Implement these to provide a return value for the matching + ``dfhack.gui.getSelected...`` function. + Internal API ------------ diff --git a/Lua API.html b/Lua API.html index 97770ff77..0da65b5fb 100644 --- a/Lua API.html +++ b/Lua API.html @@ -1611,6 +1611,16 @@ options; if multiple interpretations exist, the table will contain multiple keys

                                  If this method is omitted, the screen is dismissed on receival of the LEAVESCREEN key.

                                  • +

                                • function screen:onGetSelectedUnit()

                                  +
                                  • +

                                • function screen:onGetSelectedItem()

                                  +
                                  • +

                                • function screen:onGetSelectedJob()

                                  +
                                  • +

                                • function screen:onGetSelectedBuilding()

                                  +

                                  Implement these to provide a return value for the matching +dfhack.gui.getSelected... function.

                                  +
                                diff --git a/library/include/modules/Screen.h b/library/include/modules/Screen.h index 4f47205f2..fdad6c8ad 100644 --- a/library/include/modules/Screen.h +++ b/library/include/modules/Screen.h @@ -33,6 +33,14 @@ distribution. #include "df/graphic.h" #include "df/viewscreen.h" +namespace df +{ + struct job; + struct item; + struct unit; + struct building; +} + /** * \defgroup grp_screen utilities for painting to the screen * @ingroup grp_screen @@ -134,6 +142,7 @@ namespace DFHack virtual ~dfhack_viewscreen(); static bool is_instance(df::viewscreen *screen); + static dfhack_viewscreen *try_cast(df::viewscreen *screen); virtual void logic(); virtual void render(); @@ -146,6 +155,10 @@ namespace DFHack virtual std::string getFocusString() = 0; virtual void onShow() {}; virtual void onDismiss() {}; + virtual df::unit *getSelectedUnit() { return NULL; } + virtual df::item *getSelectedItem() { return NULL; } + virtual df::job *getSelectedJob() { return NULL; } + virtual df::building *getSelectedBuilding() { return NULL; } }; class DFHACK_EXPORT dfhack_lua_viewscreen : public dfhack_viewscreen { @@ -178,5 +191,10 @@ namespace DFHack virtual void onShow(); virtual void onDismiss(); + + virtual df::unit *getSelectedUnit(); + virtual df::item *getSelectedItem(); + virtual df::job *getSelectedJob(); + virtual df::building *getSelectedBuilding(); }; } diff --git a/library/modules/Gui.cpp b/library/modules/Gui.cpp index 10a20dc2e..bc7deedc8 100644 --- a/library/modules/Gui.cpp +++ b/library/modules/Gui.cpp @@ -691,6 +691,8 @@ df::job *Gui::getSelectedJob(color_ostream &out, bool quiet) return job; } + else if (auto dfscreen = dfhack_viewscreen::try_cast(top)) + return dfscreen->getSelectedJob(); else return getSelectedWorkshopJob(out, quiet); } @@ -781,6 +783,9 @@ static df::unit *getAnyUnit(df::viewscreen *top) return NULL; } + if (auto dfscreen = dfhack_viewscreen::try_cast(top)) + return dfscreen->getSelectedUnit(); + if (!Gui::dwarfmode_hotkey(top)) return NULL; @@ -875,6 +880,9 @@ static df::item *getAnyItem(df::viewscreen *top) return NULL; } + if (auto dfscreen = dfhack_viewscreen::try_cast(top)) + return dfscreen->getSelectedItem(); + if (!Gui::dwarfmode_hotkey(top)) return NULL; @@ -942,6 +950,9 @@ static df::building *getAnyBuilding(df::viewscreen *top) using df::global::world; using df::global::ui_sidebar_menus; + if (auto dfscreen = dfhack_viewscreen::try_cast(top)) + return dfscreen->getSelectedBuilding(); + if (!Gui::dwarfmode_hotkey(top)) return NULL; diff --git a/library/modules/Screen.cpp b/library/modules/Screen.cpp index 9f258fe02..8057d17a2 100644 --- a/library/modules/Screen.cpp +++ b/library/modules/Screen.cpp @@ -50,6 +50,10 @@ using namespace DFHack; #include "df/tile_page.h" #include "df/interfacest.h" #include "df/enabler.h" +#include "df/unit.h" +#include "df/item.h" +#include "df/job.h" +#include "df/building.h" using namespace df::enums; using df::global::init; @@ -322,6 +326,11 @@ bool dfhack_viewscreen::is_instance(df::viewscreen *screen) return dfhack_screens.count(screen) != 0; } +dfhack_viewscreen *dfhack_viewscreen::try_cast(df::viewscreen *screen) +{ + return is_instance(screen) ? static_cast(screen) : NULL; +} + void dfhack_viewscreen::check_resize() { auto size = Screen::getWindowSize(); @@ -637,3 +646,35 @@ void dfhack_lua_viewscreen::onDismiss() lua_pushstring(Lua::Core::State, "onDismiss"); safe_call_lua(do_notify, 1, 0); } + +df::unit *dfhack_lua_viewscreen::getSelectedUnit() +{ + Lua::StackUnwinder frame(Lua::Core::State); + lua_pushstring(Lua::Core::State, "onGetSelectedUnit"); + safe_call_lua(do_notify, 1, 1); + return Lua::GetDFObject(Lua::Core::State, -1); +} + +df::item *dfhack_lua_viewscreen::getSelectedItem() +{ + Lua::StackUnwinder frame(Lua::Core::State); + lua_pushstring(Lua::Core::State, "onGetSelectedItem"); + safe_call_lua(do_notify, 1, 1); + return Lua::GetDFObject(Lua::Core::State, -1); +} + +df::job *dfhack_lua_viewscreen::getSelectedJob() +{ + Lua::StackUnwinder frame(Lua::Core::State); + lua_pushstring(Lua::Core::State, "onGetSelectedJob"); + safe_call_lua(do_notify, 1, 1); + return Lua::GetDFObject(Lua::Core::State, -1); +} + +df::building *dfhack_lua_viewscreen::getSelectedBuilding() +{ + Lua::StackUnwinder frame(Lua::Core::State); + lua_pushstring(Lua::Core::State, "onGetSelectedBuilding"); + safe_call_lua(do_notify, 1, 1); + return Lua::GetDFObject(Lua::Core::State, -1); +} diff --git a/library/xml b/library/xml index 8a78bfa21..eb4af94c7 160000 --- a/library/xml +++ b/library/xml @@ -1 +1 @@ -Subproject commit 8a78bfa218817765b0a80431e0cf25435ffb2179 +Subproject commit eb4af94c7e737d99c194381749ac6743e146913e diff --git a/plugins/manipulator.cpp b/plugins/manipulator.cpp index 2b3fc86fc..033ad8b85 100644 --- a/plugins/manipulator.cpp +++ b/plugins/manipulator.cpp @@ -338,6 +338,8 @@ public: std::string getFocusString() { return "unitlabors"; } + df::unit *getSelectedUnit(); + viewscreen_unitlaborsst(vector &src, int cursor_pos); ~viewscreen_unitlaborsst() { }; @@ -986,6 +988,11 @@ void viewscreen_unitlaborsst::render() } } +df::unit *viewscreen_unitlaborsst::getSelectedUnit() +{ + return units[sel_row]->unit; +} + struct unitlist_hook : df::viewscreen_unitlistst { typedef df::viewscreen_unitlistst interpose_base; From 462bedb75708043f3ef9520e8fb84640ebaec945 Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Thu, 20 Sep 2012 11:11:59 +0400 Subject: [PATCH 08/18] Fix the rename plugin and script to use the new getSelectedBuilding API. --- plugins/rename.cpp | 5 +++-- scripts/gui/rename.lua | 10 +++++----- scripts/gui/siege-engine.lua | 4 ++++ 3 files changed, 12 insertions(+), 7 deletions(-) diff --git a/plugins/rename.cpp b/plugins/rename.cpp index 99dc6848a..f9de83bdf 100644 --- a/plugins/rename.cpp +++ b/plugins/rename.cpp @@ -357,10 +357,11 @@ static command_result rename(color_ostream &out, vector ¶meters) if (parameters.size() != 2) return CR_WRONG_USAGE; - if (ui->main.mode != ui_sidebar_mode::QueryBuilding) + df::building *bld = Gui::getSelectedBuilding(out, true); + if (!bld) return CR_WRONG_USAGE; - if (!renameBuilding(world->selected_building, parameters[1])) + if (!renameBuilding(bld, parameters[1])) { out.printerr("This type of building is not supported.\n"); return CR_FAILURE; diff --git a/scripts/gui/rename.lua b/scripts/gui/rename.lua index a457a0bfd..70a09b2fa 100644 --- a/scripts/gui/rename.lua +++ b/scripts/gui/rename.lua @@ -13,10 +13,12 @@ local function verify_mode(expected) end end -if string.match(focus, '^dwarfmode/QueryBuilding/Some') then +local unit = dfhack.gui.getSelectedUnit(true) +local building = dfhack.gui.getSelectedBuilding(true) + +if building and (not unit or mode == 'building') then verify_mode('building') - local building = df.global.world.selected_building if plugin.canRenameBuilding(building) then dlg.showInputPrompt( 'Rename Building', @@ -30,9 +32,7 @@ if string.match(focus, '^dwarfmode/QueryBuilding/Some') then 'Cannot rename this type of building.', COLOR_LIGHTRED ) end -elseif dfhack.gui.getSelectedUnit(true) then - local unit = dfhack.gui.getSelectedUnit(true) - +elseif unit then if mode == 'unit-profession' then dlg.showInputPrompt( 'Rename Unit', diff --git a/scripts/gui/siege-engine.lua b/scripts/gui/siege-engine.lua index c98cb1676..f460bb211 100644 --- a/scripts/gui/siege-engine.lua +++ b/scripts/gui/siege-engine.lua @@ -74,6 +74,10 @@ function SiegeEngine:onDestroy() end end +function SiegeEngine:onGetSelectedBuilding() + return df.global.world.selected_building +end + function SiegeEngine:showCursor(enable) local cursor = guidm.getCursorPos() if cursor and not enable then From 1f7c10252e79415bf56c461cd2eb19a5018433fb Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Thu, 20 Sep 2012 11:48:53 +0400 Subject: [PATCH 09/18] Support renaming activity zones. This one required hooking the dwarfmode render method. --- README.rst | 8 +++++--- Readme.html | 8 +++++--- plugins/rename.cpp | 47 +++++++++++++++++++++++++++++++++++++++++----- 3 files changed, 52 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index 589451a9a..9e3d5d3f9 100644 --- a/README.rst +++ b/README.rst @@ -703,7 +703,8 @@ Options :rename unit-profession "custom profession": Change proffession name of the highlighted unit/creature. :rename building "name": Set a custom name for the selected building. - The building must be one of stockpile, workshop, furnace, trap or siege engine. + The building must be one of stockpile, workshop, furnace, trap, + siege engine or an activity zone. reveal ====== @@ -1549,7 +1550,8 @@ via a simple dialog in the game ui. * ``gui/rename [building]`` in 'q' mode changes the name of a building. - The selected building must be one of stockpile, workshop, furnace, trap or siege engine. + The selected building must be one of stockpile, workshop, furnace, trap, or siege engine. + It is also possible to rename zones from the 'i' menu. * ``gui/rename [unit]`` with a unit selected changes the nickname. @@ -1645,7 +1647,7 @@ is extracted from the workshop raws. machine connection cannot be modified. As a result, the workshop can only immediately connect to machine components built AFTER it. This also means that engines cannot be chained without intermediate -short axles that can be built later. +short axles that can be built later than both of the engines. Operation --------- diff --git a/Readme.html b/Readme.html index 4c005b6ff..7b41dc74b 100644 --- a/Readme.html +++ b/Readme.html @@ -1480,7 +1480,8 @@ highlighted unit/creature. rename building "name":  Set a custom name for the selected building. -The building must be one of stockpile, workshop, furnace, trap or siege engine. +The building must be one of stockpile, workshop, furnace, trap, +siege engine or an activity zone. @@ -2423,7 +2424,8 @@ configuration page, but configures parameters relevant to the modded power meter via a simple dialog in the game ui.

                                • gui/rename [building] in 'q' mode changes the name of a building.

                                  -

                                  The selected building must be one of stockpile, workshop, furnace, trap or siege engine.

                                  +

                                  The selected building must be one of stockpile, workshop, furnace, trap, or siege engine. +It is also possible to rename zones from the 'i' menu.

                                • gui/rename [unit] with a unit selected changes the nickname.

                                  • @@ -2497,7 +2499,7 @@ is extracted from the workshop raws.

                                  machine connection cannot be modified. As a result, the workshop can only immediately connect to machine components built AFTER it. This also means that engines cannot be chained without intermediate -short axles that can be built later.

                                  +short axles that can be built later than both of the engines.

                                Operation

                                diff --git a/plugins/rename.cpp b/plugins/rename.cpp index f9de83bdf..059a4be62 100644 --- a/plugins/rename.cpp +++ b/plugins/rename.cpp @@ -10,9 +10,11 @@ #include "modules/Translation.h" #include "modules/Units.h" #include "modules/World.h" +#include "modules/Screen.h" #include #include "df/ui.h" +#include "df/ui_sidebar_menus.h" #include "df/world.h" #include "df/squad.h" #include "df/unit.h" @@ -27,6 +29,8 @@ #include "df/building_furnacest.h" #include "df/building_trapst.h" #include "df/building_siegeenginest.h" +#include "df/building_civzonest.h" +#include "df/viewscreen_dwarfmodest.h" #include "RemoteServer.h" #include "rename.pb.h" @@ -43,6 +47,7 @@ using namespace df::enums; using namespace dfproto; using df::global::ui; +using df::global::ui_sidebar_menus; using df::global::world; DFhackCExport command_result plugin_onstatechange(color_ostream &out, state_change_event event); @@ -66,8 +71,8 @@ DFhackCExport command_result plugin_init (color_ostream &out, std::vector main.mode == ui_sidebar_mode::Zones && + ui_sidebar_menus && ui_sidebar_menus->zone.selected && + !ui_sidebar_menus->zone.selected->name.empty()) + { + auto dims = Gui::getDwarfmodeViewDims(); + int width = dims.menu_x2 - dims.menu_x1 - 1; + + Screen::Pen pen(' ',COLOR_WHITE); + Screen::fillRect(pen, dims.menu_x1, dims.y1+1, dims.menu_x2, dims.y1+1); + + std::string name; + ui_sidebar_menus->zone.selected->getName(&name); + Screen::paintString(pen, dims.menu_x1+1, dims.y1+1, name.substr(0, width)); + } + } +}; + +IMPLEMENT_VMETHOD_INTERPOSE(dwarf_render_zone_hook, render); + static char getBuildingCode(df::building *bld) { CHECK_NULL_POINTER(bld); @@ -142,6 +174,9 @@ KNOWN_BUILDINGS static bool enable_building_rename(char code, bool enable) { + if (code == 'Z') + INTERPOSE_HOOK(dwarf_render_zone_hook, render).apply(enable); + switch (code) { #define BUILDING(code, cname, tag) \ case code: return INTERPOSE_HOOK(cname##_hook, getName).apply(enable); @@ -154,6 +189,8 @@ KNOWN_BUILDINGS static void disable_building_rename() { + INTERPOSE_HOOK(dwarf_render_zone_hook, render).remove(); + #define BUILDING(code, cname, tag) \ INTERPOSE_HOOK(cname##_hook, getName).remove(); KNOWN_BUILDINGS From 82dc1445cf86160cd3e7d33718b7229c1f591fc6 Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Thu, 20 Sep 2012 11:55:53 +0400 Subject: [PATCH 10/18] Support the Room list in getSelectedBuilding. --- library/modules/Gui.cpp | 4 ++++ library/xml | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/library/modules/Gui.cpp b/library/modules/Gui.cpp index bc7deedc8..eaeef9bf4 100644 --- a/library/modules/Gui.cpp +++ b/library/modules/Gui.cpp @@ -53,6 +53,7 @@ using namespace DFHack; #include "df/viewscreen_dungeon_monsterstatusst.h" #include "df/viewscreen_joblistst.h" #include "df/viewscreen_unitlistst.h" +#include "df/viewscreen_buildinglistst.h" #include "df/viewscreen_itemst.h" #include "df/viewscreen_layer.h" #include "df/viewscreen_layer_workshop_profilest.h" @@ -950,6 +951,9 @@ static df::building *getAnyBuilding(df::viewscreen *top) using df::global::world; using df::global::ui_sidebar_menus; + if (auto screen = strict_virtual_cast(top)) + return vector_get(screen->buildings, screen->cursor); + if (auto dfscreen = dfhack_viewscreen::try_cast(top)) return dfscreen->getSelectedBuilding(); diff --git a/library/xml b/library/xml index eb4af94c7..d52c7181f 160000 --- a/library/xml +++ b/library/xml @@ -1 +1 @@ -Subproject commit eb4af94c7e737d99c194381749ac6743e146913e +Subproject commit d52c7181fb439a5fead143188d17d659d82e7f89 From e2d6a14720e3fcad3d658040434dbcca9a72fa20 Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Thu, 20 Sep 2012 12:27:03 +0400 Subject: [PATCH 11/18] Make manipulator re-read names and professions if change is suspected. Namely, if it either invoked View Unit itself, or was queried (possibly by the rename plugin) via getSelectedUnit. --- README.rst | 4 ++++ Readme.html | 2 ++ plugins/manipulator.cpp | 44 +++++++++++++++++++++++++++++++++++++---- 3 files changed, 46 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 9e3d5d3f9..c6b0509e1 100644 --- a/README.rst +++ b/README.rst @@ -1510,6 +1510,10 @@ The following mouse shortcuts are also available: * Left-click on a unit's name or profession to view its properties. * Right-click on a unit's name or profession to zoom to it. +Pressing ESC normally returns to the unit screen, but Shift-ESC would exit +directly to the main dwarf mode screen. + + Liquids ======= diff --git a/Readme.html b/Readme.html index 7b41dc74b..fcf7dab6a 100644 --- a/Readme.html +++ b/Readme.html @@ -2395,6 +2395,8 @@ cursor onto that cell instead of toggling it.
                              • Left-click on a unit's name or profession to view its properties.
                              • Right-click on a unit's name or profession to zoom to it.
                              +

                              Pressing ESC normally returns to the unit screen, but Shift-ESC would exit +directly to the main dwarf mode screen.

                              Liquids

                              diff --git a/plugins/manipulator.cpp b/plugins/manipulator.cpp index 033ad8b85..a3ec72a47 100644 --- a/plugins/manipulator.cpp +++ b/plugins/manipulator.cpp @@ -331,6 +331,12 @@ class viewscreen_unitlaborsst : public dfhack_viewscreen { public: void feed(set *events); + void logic() { + dfhack_viewscreen::logic(); + if (do_refresh_names) + refreshNames(); + } + void render(); void resize(int w, int h) { calcSize(); } @@ -347,12 +353,14 @@ protected: vector units; altsort_mode altsort; + bool do_refresh_names; int first_row, sel_row, num_rows; int first_column, sel_column; int col_widths[DISP_COLUMN_MAX]; int col_offsets[DISP_COLUMN_MAX]; + void refreshNames(); void calcSize (); }; @@ -377,9 +385,6 @@ viewscreen_unitlaborsst::viewscreen_unitlaborsst(vector &src, int cur if (!ENUM_ATTR(profession, can_assign_labor, unit->profession)) cur->allowEdit = false; - cur->name = Translation::TranslateName(&unit->name, false); - cur->transname = Translation::TranslateName(&unit->name, true); - cur->profession = Units::getProfessionName(unit); cur->color = Units::getProfessionColor(unit); units.push_back(cur); @@ -387,6 +392,8 @@ viewscreen_unitlaborsst::viewscreen_unitlaborsst(vector &src, int cur altsort = ALTSORT_NAME; first_column = sel_column = 0; + refreshNames(); + first_row = 0; sel_row = cursor_pos; calcSize(); @@ -403,6 +410,21 @@ viewscreen_unitlaborsst::viewscreen_unitlaborsst(vector &src, int cur first_row = units.size() - num_rows; } +void viewscreen_unitlaborsst::refreshNames() +{ + do_refresh_names = false; + + for (size_t i = 0; i < units.size(); i++) + { + UnitInfo *cur = units[i]; + df::unit *unit = cur->unit; + + cur->name = Translation::TranslateName(&unit->name, false); + cur->transname = Translation::TranslateName(&unit->name, true); + cur->profession = Units::getProfessionName(unit); + } +} + void viewscreen_unitlaborsst::calcSize() { num_rows = gps->dimy - 10; @@ -476,16 +498,25 @@ void viewscreen_unitlaborsst::calcSize() void viewscreen_unitlaborsst::feed(set *events) { - if (events->count(interface_key::LEAVESCREEN)) + bool leave_all = events->count(interface_key::LEAVESCREEN_ALL); + if (leave_all || events->count(interface_key::LEAVESCREEN)) { events->clear(); Screen::dismiss(this); + if (leave_all) + { + events->insert(interface_key::LEAVESCREEN); + parent->feed(events); + } return; } if (!units.size()) return; + if (do_refresh_names) + refreshNames(); + if (events->count(interface_key::CURSOR_UP) || events->count(interface_key::CURSOR_UPLEFT) || events->count(interface_key::CURSOR_UPRIGHT)) sel_row--; if (events->count(interface_key::CURSOR_UP_FAST) || events->count(interface_key::CURSOR_UPLEFT_FAST) || events->count(interface_key::CURSOR_UPRIGHT_FAST)) @@ -758,6 +789,8 @@ void viewscreen_unitlaborsst::feed(set *events) unitlist->feed(events); if (Screen::isDismissed(unitlist)) Screen::dismiss(this); + else + do_refresh_names = true; break; } } @@ -990,6 +1023,9 @@ void viewscreen_unitlaborsst::render() df::unit *viewscreen_unitlaborsst::getSelectedUnit() { + // This query might be from the rename plugin + do_refresh_names = true; + return units[sel_row]->unit; } From 1403bb126c65053e9d430a5876dd6d2ac50a2361 Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Thu, 20 Sep 2012 15:38:58 +0400 Subject: [PATCH 12/18] README: move keybinding to the start and add a section for scripts. --- README.rst | 131 +++++++++--- Readme.html | 565 +++++++++++++++++++++++++++++----------------------- 2 files changed, 425 insertions(+), 271 deletions(-) diff --git a/README.rst b/README.rst index c6b0509e1..40d7b74e3 100644 --- a/README.rst +++ b/README.rst @@ -1,3 +1,7 @@ +############# +DFHack Readme +############# + ============ Introduction ============ @@ -97,11 +101,49 @@ the issues tracker on github, contact me (peterix@gmail.com) or visit the ============= The init file ============= -If your DF folder contains a file named dfhack.init, its contents will be run +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 +is provided as ``dfhack.init-example`` - you can tweak it and rename to dfhack.init if you want to use this functionality. +Setting keybindings +=================== + +To set keybindings, use the built-in ``keybinding`` command. Like any other +command it can be used at any time from the console, but it is also meaningful +in the DFHack init file. + +Currently it supports any combination of Ctrl/Alt/Shift with F1-F9, or A-Z. + +Possible ways to call the command: + +:keybinding list : List bindings active for the key combination. +:keybinding clear ...: Remove bindings for the specified keys. +:keybinding add "cmdline" "cmdline"...: Add bindings for the specified + key. +:keybinding set "cmdline" "cmdline"...: Clear, and then add bindings for + the specified key. + +The ** parameter above has the following *case-sensitive* syntax:: + + [Ctrl-][Alt-][Shift-]KEY[@context] + +where the *KEY* part can be F1-F9 or A-Z, and [] denote optional parts. + +When multiple commands are bound to the same key combination, DFHack selects +the first applicable one. Later 'add' commands, and earlier entries within one +'add' command have priority. Commands that are not specifically intended for use +as a hotkey are always considered applicable. + +The *context* part in the key specifier above can be used to explicitly restrict +the UI state where the binding would be applicable. If called without parameters, +the ``keybinding`` command among other things prints the current context string. +Only bindings with a *context* tag that either matches the current context fully, +or is a prefix ending at a '/' boundary would be considered for execution, i.e. +for context ``foo/bar/baz``, possible matches are any of ``@foo/bar/baz``, ``@foo/bar``, +``@foo`` or none. + + ======== Commands ======== @@ -576,27 +618,6 @@ 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. -keybinding -========== - -Manages DFHack keybindings. - -Currently it supports any combination of Ctrl/Alt/Shift with F1-F9, or A-Z. - -Options -------- -:keybinding list : List bindings active for the key combination. -:keybinding clear ...: Remove bindings for the specified keys. -:keybinding add "cmdline" "cmdline"...: Add bindings for the specified - key. -:keybinding set "cmdline" "cmdline"...: Clear, and then add bindings for - the specified key. - -When multiple commands are bound to the same key combination, DFHack selects -the first applicable one. Later 'add' commands, and earlier entries within one -'add' command have priority. Commands that are not specifically intended for use -as a hotkey are always considered applicable. - liquids ======= Allows adding magma, water and obsidian to the game. It replaces the normal @@ -1378,6 +1399,70 @@ also tries to have dwarves specialize in specific skills. For detailed usage information, see 'help autolabor'. +======= +Scripts +======= + +Lua or ruby scripts placed in the hack/scripts/ directory are considered for +execution as if they were native DFHack commands. They are listed at the end +of the 'ls' command output. + +Note: scripts in subdirectories of hack/scripts/ can still be called, but will +only be listed by ls if called as 'ls -a'. This is intended as a way to hide +scripts that are obscure, developer-oriented, or should be used as keybindings. + +Some notable scripts: + +quicksave +========= + +If called in dwarf mode, makes DF immediately auto-save the game by setting a flag +normally used in seasonal auto-save. + +setfps +====== + +Run ``setfps `` to set the FPS cap at runtime, in case you want to watch +combat in slow motion or something :) + + +fix/* +===== + +Scripts in this subdirectory fix various bugs and issues, some of them obscure. + +* fix/dead-units + + Removes uninteresting dead units from the unit list. Doesn't seem to give any + noticeable performance gain, but migrants normally stop if the unit list grows + to around 3000 units, and this script reduces it back. + +* fix/population-cap + + Run this after every migrant wave to ensure your population cap is not exceeded. + The issue with the cap is that it is compared to the population number reported + by the last caravan, so once it drops below the cap, migrants continue to come + until that number is updated again. + +* fix/stable-temp + + Instantly sets the temperature of all free-lying items to be in equilibrium with + the environment and stops temperature updates. In order to maintain this efficient + state however, use ``tweak stable-temp`` and ``tweak fast-heat``. + +* fix/item-occupancy + + Diagnoses and fixes issues with nonexistant 'items occupying site', usually + caused by autodump bugs or other hacking mishaps. + + +gui/* +===== + +Scripts that implement dialogs inserted into the main game window are put in this +directory. + + growcrops ========= Instantly grow seeds inside farming plots. diff --git a/Readme.html b/Readme.html index fcf7dab6a..977c4177d 100644 --- a/Readme.html +++ b/Readme.html @@ -4,7 +4,7 @@ - +DFHack Readme -
                              - +
                              +

                              DFHack Readme

                              -

                              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,13 +326,16 @@ 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, versions 0.34.08 - 0.34.11 are supported. If you need DFHack @@ -572,7 +578,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:

                              @@ -594,7 +600,7 @@ remove the other DFHack files
                              • 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 @@ -618,7 +624,7 @@ they are re-created every time it is loaded.

                              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. @@ -627,11 +633,55 @@ the issues tracker on github, contact me ( -

                              The init file

                              -

                              If your DF folder contains a file named dfhack.init, its contents will be run +

                              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 +is provided as dfhack.init-example - you can tweak it and rename to dfhack.init if you want to use this functionality.

                              +
                              +

                              Setting keybindings

                              +

                              To set keybindings, use the built-in keybinding command. Like any other +command it can be used at any time from the console, but it is also meaningful +in the DFHack init file.

                              +

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

                              +

                              Possible ways to call the command:

                              + +++ + + + + + + + + + + + + + +
                              keybinding list <key>:
                               List bindings active for the key combination.
                              keybinding clear <key> <key>...:
                               Remove bindings for the specified keys.
                              keybinding add <key> "cmdline" "cmdline"...:
                               Add bindings for the specified +key.
                              keybinding set <key> "cmdline" "cmdline"...:
                               Clear, and then add bindings for +the specified key.
                              +

                              The <key> parameter above has the following case-sensitive syntax:

                              +
                              +[Ctrl-][Alt-][Shift-]KEY[@context]
+
                              +

                              where the KEY part can be F1-F9 or A-Z, and [] denote optional parts.

                              +

                              When multiple commands are bound to the same key combination, DFHack selects +the first applicable one. Later 'add' commands, and earlier entries within one +'add' command have priority. Commands that are not specifically intended for use +as a hotkey are always considered applicable.

                              +

                              The context part in the key specifier above can be used to explicitly restrict +the UI state where the binding would be applicable. If called without parameters, +the keybinding command among other things prints the current context string. +Only bindings with a context tag that either matches the current context fully, +or is a prefix ending at a '/' boundary would be considered for execution, i.e. +for context foo/bar/baz, possible matches are any of @foo/bar/baz, @foo/bar, +@foo or none.

                              +

                              Commands

                              @@ -1309,40 +1359,8 @@ instantly duplicates the job.
                              -
                              -

                              keybinding

                              -

                              Manages DFHack keybindings.

                              -

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

                              -
                              -

                              Options

                              - --- - - - - - - - - - - - - - -
                              keybinding list <key>:
                               List bindings active for the key combination.
                              keybinding clear <key> <key>...:
                               Remove bindings for the specified keys.
                              keybinding add <key> "cmdline" "cmdline"...:
                               Add bindings for the specified -key.
                              keybinding set <key> "cmdline" "cmdline"...:
                               Clear, and then add bindings for -the specified key.
                              -

                              When multiple commands are bound to the same key combination, DFHack selects -the first applicable one. Later 'add' commands, and earlier entries within one -'add' command have priority. Commands that are not specifically intended for use -as a hotkey are always considered applicable.

                              -
                              -
                              -

                              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. Settings will be remembered as long as dfhack runs. Intended for use in combination with the command @@ -1355,13 +1373,13 @@ temperatures (creating heat traps). You've been warned.

                              -

                              liquids-here

                              +

                              liquids-here

                              Run the liquid spawner with the current/last settings made in liquids (if no settings in liquids were made it paints a point of 7/7 magma by default).

                              Intended to be used as keybinding. Requires an active in-game cursor.

                              -

                              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.

                              @@ -1380,11 +1398,11 @@ You just created a returnable mountain home and gained an adventurer.

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

                              -

                              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.

                              -
                              -

                              Options

                              +
                              +

                              Options

                              @@ -1400,24 +1418,24 @@ a tree/shrub under the cursor. 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.

                              -
                              @@ -1432,14 +1450,14 @@ the visible part of the map is scanned.

                              -

                              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

                              @@ -1451,14 +1469,14 @@ for all tiles of the embark rectangle.

                              -

                              regrass

                              +

                              regrass

                              Regrows grass. Not much to it ;)

                              -

                              rename

                              +

                              rename

                              Allows renaming various things.

                              -
                              @@ -1488,7 +1506,7 @@ siege engine or an activity zone.
                              -

                              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 @@ -1497,33 +1515,33 @@ to unpause with hell revealed, use 'reveal demons'.

                              you move. When you use it this way, you don't need to run 'unreveal'.

                              -

                              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.

                              -

                              revforget

                              +

                              revforget

                              When you use reveal, it saves information about what was/wasn't visible before revealing everything. Unreveal uses this information to hide things again. This command throws away the information. For example, use in cases where you abandoned with the fort revealed and no longer want the data.

                              -

                              lair

                              +

                              lair

                              This command allows you to mark the map as 'monster lair', preventing item scatter on abandon. When invoked as 'lair reset', it does the opposite.

                              Unlike reveal, this command doesn't save the information about tiles - you won't be able to restore state of real monster lairs using 'lair reset'.

                              -
                              @@ -1537,23 +1555,23 @@ won't be able to restore state of real monster lairs using 'lair reset'.

                              -

                              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).

                              @@ -1566,7 +1584,7 @@ thread: http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository

                              -

                              tiletypes

                              +

                              tiletypes

                              Can be used for painting map tiles and is an interactive command, much like liquids.

                              The tool works with two set of options and a brush. The brush determines which @@ -1627,25 +1645,25 @@ up.

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

                              -

                              tiletypes-commands

                              +

                              tiletypes-commands

                              Runs tiletypes commands, separated by ;. This makes it possible to change tiletypes modes from a hotkey.

                              -

                              tiletypes-here

                              +

                              tiletypes-here

                              Apply the current tiletypes options at the in-game cursor position, including the brush. Can be used from a hotkey.

                              -

                              tiletypes-here-point

                              +

                              tiletypes-here-point

                              Apply the current tiletypes options at the in-game cursor position to a single tile. Can be used from a hotkey.

                              -

                              tweak

                              +

                              tweak

                              Contains various tweaks for minor bugs (currently just one).

                              -
                              @@ -1712,22 +1730,22 @@ reagents.
                              -

                              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).

                              -

                              digv

                              +

                              digv

                              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).

                              -

                              digvx

                              +

                              digvx

                              A permanent alias for 'digv x'.

                              -

                              digl

                              +

                              digl

                              Designates layer stone for digging. Requires an active in-game cursor placed over a layer stone tile. With the 'x' option, it will traverse z-levels (putting stairs between the same-material tiles). With the 'undo' option it @@ -1735,16 +1753,16 @@ will remove the dig designation instead (if you realize that digging out a 50 z-level deep layer was not such a good idea after all).

                              -

                              diglx

                              +

                              diglx

                              A permanent alias for 'digl x'.

                              -

                              digexp

                              +

                              digexp

                              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.

                              @@ -1765,7 +1783,7 @@ z-level deep layer was not such a good idea after all).

                              -

                              Filters:

                              +

                              Filters:

                              @@ -1780,8 +1798,8 @@ z-level deep layer was not such a good idea after all).

                              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:
                                @@ -1802,11 +1820,11 @@ z-level deep layer was not such a good idea after all).

                              -

                              digcircle

                              +

                              digcircle

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

                              -

                              Shape:

                              +

                              Shape:

                              @@ -1821,7 +1839,7 @@ It has several types of options.

                              -

                              Action:

                              +

                              Action:

                              @@ -1836,7 +1854,7 @@ It has several types of options.

                              -

                              Designation types:

                              +

                              Designation types:

                              @@ -1858,8 +1876,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.
                                • @@ -1867,11 +1885,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'.

                              -
                              @@ -1887,10 +1905,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. @@ -1911,7 +1929,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.

                              @@ -1922,7 +1940,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
@@ -1960,19 +1978,19 @@ 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.

                              -

                              zone

                              +

                              zone

                              Helps a bit with managing activity zones (pens, pastures and pits) and cages.

                              -
                              @@ -2010,8 +2028,8 @@ the cursor are listed.
                              -
                              -

                              Filters:

                              +
                              +

                              Filters:

                              @@ -2068,7 +2086,7 @@ for war/hunt). Negatable.
                              -

                              Usage with single units

                              +

                              Usage with single units

                              One convenient way to use the zone tool is to bind the command 'zone assign' to a hotkey, maybe also the command 'zone set'. Place the in-game cursor over a pen/pasture or pit, use 'zone set' to mark it. Then you can select units @@ -2077,7 +2095,7 @@ and use 'zone assign' to assign them to their new home. Allows pitting your own dwarves, by the way.

                              -

                              Usage with filters

                              +

                              Usage with filters

                              All filters can be used together with the 'assign' command.

                              Restrictions: It's not possible to assign units who are inside built cages or chained because in most cases that won't be desirable anyways. @@ -2095,14 +2113,14 @@ are not properly added to your own stocks; slaughtering them should work).

                              Most filters can be negated (e.g. 'not grazer' -> race is not a grazer).

                              -

                              Mass-renaming

                              +

                              Mass-renaming

                              Using the 'nick' command you can set the same nickname for multiple units. If used without 'assign', 'all' or 'count' it will rename all units in the current default target zone. Combined with 'assign', 'all' or 'count' (and further optional filters) it will rename units matching the filter conditions.

                              -

                              Cage zones

                              +

                              Cage zones

                              Using the 'tocages' command you can assign units to a set of cages, for example a room next to your butcher shop(s). They will be spread evenly among available cages to optimize hauling to and butchering from them. For this to work you need @@ -2112,8 +2130,8 @@ all cages you want to use. Then use 'zone set' (like with 'assign') and use would make no sense, but can be used together with 'nick' or 'remnick' and all the usual filters.

                              -
                              -

                              Examples

                              +
                              +

                              Examples

                              zone assign all own ALPACA minage 3 maxage 10
                              Assign all own alpacas who are between 3 and 10 years old to the selected @@ -2139,7 +2157,7 @@ on the current default zone.
                              -

                              autonestbox

                              +

                              autonestbox

                              Assigns unpastured female egg-layers to nestbox zones. Requires that you create pen/pasture zones above nestboxes. If the pen is bigger than 1x1 the nestbox must be in the top left corner. Only 1 unit will be assigned per pen, regardless @@ -2149,8 +2167,8 @@ to a 1x1 pasture is not a good idea. Only tame and domesticated own units are processed since pasturing half-trained wild egglayers could destroy your neat nestbox zones when they revert to wild. When called without options autonestbox will instantly run once.

                              -
                              -

                              Options:

                              +
                              +

                              Options:

                              @@ -2168,7 +2186,7 @@ frames between runs.
                              -

                              autobutcher

                              +

                              autobutcher

                              Assigns lifestock for slaughter once it reaches a specific count. Requires that you add the target race(s) to a watch list. Only tame units will be processed.

                              Named units will be completely ignored (to protect specific animals from @@ -2181,8 +2199,8 @@ units or with 'zone nick' to mass-rename units in pastures and cages).

                              Once you have too much kids, the youngest will be butchered first. If you don't set any target count the following default will be used: 1 male kid, 5 female kids, 1 male adult, 5 female adults.

                              -
                              @@ -2234,8 +2252,8 @@ for future entries.
                              -
                              -

                              Examples:

                              +
                              +

                              Examples:

                              You want to keep max 7 kids (4 female, 3 male) and max 3 adults (2 female, 1 male) of the race alpaca. Once the kids grow up the oldest adults will get slaughtered. Excess kids will get slaughtered starting with the youngest @@ -2266,7 +2284,7 @@ autobutcher unwatch ALPACA CAT

                              -

                              Note:

                              +

                              Note:

                              Settings and watchlist are stored in the savegame, so that you can have different settings for each world. If you want to copy your watchlist to another savegame you can use the command list_export:

                              @@ -2280,7 +2298,7 @@ autobutcher.bat
                              -

                              autolabor

                              +

                              autolabor

                              Automatically manage dwarf labors.

                              When enabled, autolabor periodically checks your dwarves and enables or disables labors. It tries to keep as many dwarves as possible busy but @@ -2292,8 +2310,59 @@ while it is enabled.

                              For detailed usage information, see 'help autolabor'.

                              +
                              +
                              +

                              Scripts

                              +

                              Lua or ruby scripts placed in the hack/scripts/ directory are considered for +execution as if they were native DFHack commands. They are listed at the end +of the 'ls' command output.

                              +

                              Note: scripts in subdirectories of hack/scripts/ can still be called, but will +only be listed by ls if called as 'ls -a'. This is intended as a way to hide +scripts that are obscure, developer-oriented, or should be used as keybindings.

                              +

                              Some notable scripts:

                              +
                              +

                              quicksave

                              +

                              If called in dwarf mode, makes DF immediately auto-save the game by setting a flag +normally used in seasonal auto-save.

                              +
                              +
                              +

                              setfps

                              +

                              Run setfps <number> to set the FPS cap at runtime, in case you want to watch +combat in slow motion or something :)

                              +
                              +
                              +

                              fix/*

                              +

                              Scripts in this subdirectory fix various bugs and issues, some of them obscure.

                              +
                                +

                              • fix/dead-units

                                +

                                Removes uninteresting dead units from the unit list. Doesn't seem to give any +noticeable performance gain, but migrants normally stop if the unit list grows +to around 3000 units, and this script reduces it back.

                                +
                                • +

                              • fix/population-cap

                                +

                                Run this after every migrant wave to ensure your population cap is not exceeded. +The issue with the cap is that it is compared to the population number reported +by the last caravan, so once it drops below the cap, migrants continue to come +until that number is updated again.

                                +
                                • +

                              • fix/stable-temp

                                +

                                Instantly sets the temperature of all free-lying items to be in equilibrium with +the environment and stops temperature updates. In order to maintain this efficient +state however, use tweak stable-temp and tweak fast-heat.

                                +
                                • +

                              • fix/item-occupancy

                                +

                                Diagnoses and fixes issues with nonexistant 'items occupying site', usually +caused by autodump bugs or other hacking mishaps.

                                +
                                • +
                              +
                              +
                              +

                              gui/*

                              +

                              Scripts that implement dialogs inserted into the main game window are put in this +directory.

                              +
                              -

                              growcrops

                              +

                              growcrops

                              Instantly grow seeds inside farming plots.

                              With no argument, this command list the various seed types currently in use in your farming plots. @@ -2305,7 +2374,7 @@ growcrops plump 40

                              -

                              removebadthoughts

                              +

                              removebadthoughts

                              This script remove negative thoughts from your dwarves. Very useful against tantrum spirals.

                              With a selected unit in 'v' mode, will clear this unit's mind, otherwise @@ -2318,7 +2387,7 @@ you unpause.

                              it removed.

                              -

                              slayrace

                              +

                              slayrace

                              Kills any unit of a given race.

                              With no argument, lists the available races.

                              With the special argument 'him', targets only the selected creature.

                              @@ -2344,7 +2413,7 @@ slayrace elve magma
                              -

                              magmasource

                              +

                              magmasource

                              Create an infinite magma source on a tile.

                              This script registers a map tile as a magma source, and every 12 game ticks that tile receives 1 new unit of flowing magma.

                              @@ -2360,11 +2429,11 @@ To remove all placed sources, call magmasource stop
                              -

                              In-game interface tools

                              +

                              In-game interface tools

                              These tools work by displaying dialogs or overlays in the game window, and are mostly implemented by lua scripts.

                              -

                              Dwarf Manipulator

                              +

                              Dwarf Manipulator

                              Implemented by the manipulator plugin. To activate, open the unit screen and press 'l'.

                              This tool implements a Dwarf Therapist-like interface within the game UI. The @@ -2398,14 +2467,14 @@ cursor onto that cell instead of toggling it.

                              Pressing ESC normally returns to the unit screen, but Shift-ESC would exit directly to the main dwarf mode screen.

                              -
                              -

                              Liquids

                              +
                              +

                              Liquids

                              Implemented by the gui/liquids script. To use, bind to a key and activate in the 'k' mode.

                              While active, use the suggested keys to switch the usual liquids parameters, and Enter to select the target area and apply changes.

                              -

                              Mechanisms

                              +

                              Mechanisms

                              Implemented by the gui/mechanims script. To use, bind to a key and activate in the 'q' mode.

                              Lists mechanisms connected to the building, and their links. Navigating the list centers the view on the relevant linked buildings.

                              @@ -2414,14 +2483,14 @@ focus on the current one. Shift-Enter has an effect equivalent to pressing Enter re-entering the mechanisms ui.

                              -

                              Power Meter

                              +

                              Power Meter

                              Front-end to the power-meter plugin implemented by the gui/power-meter script. Bind to a key and activate after selecting Pressure Plate in the build menu.

                              The script follows the general look and feel of the regular pressure plate build configuration page, but configures parameters relevant to the modded power meter building.

                              -
                              -

                              Rename

                              +
                              +

                              Rename

                              Backed by the rename plugin, the gui/rename script allows entering the desired name via a simple dialog in the game ui.

                                @@ -2437,14 +2506,14 @@ It is also possible to rename zones from the 'i' menu.

                                The building or unit are automatically assumed when in relevant ui state.

                              -

                              Room List

                              +

                              Room List

                              Implemented by the gui/room-list script. To use, bind to a key and activate in the 'q' mode, either immediately or after opening the assign owner page.

                              The script lists other rooms owned by the same owner, or by the unit selected in the assign list, and allows unassigning them.

                              -

                              Siege Engine

                              +

                              Siege Engine

                              Front-end to the siege-engine plugin implemented by the gui/siege-engine script. Bind to a key and activate after selecting a siege engine in 'q' mode.

                              The main mode displays the current target, selected ammo item type, linked stockpiles and @@ -2468,14 +2537,14 @@ e.g. like making siegers bring their own, are something only Toady can do.

                              -

                              RAW hacks

                              +

                              RAW hacks

                              These plugins detect certain structures in RAWs, and enhance them in various ways.

                              -

                              Steam Engine

                              +

                              Steam Engine

                              The steam-engine plugin detects custom workshops with STEAM_ENGINE in their token, and turns them into real steam engines.

                              -

                              Rationale

                              +

                              Rationale

                              The vanilla game contains only water wheels and windmills as sources of power, but windmills give relatively little power, and water wheels require flowing water, which must either be a real river and thus immovable and @@ -2486,7 +2555,7 @@ it can be done just by combining existing features of the game engine in a new way with some glue code and a bit of custom logic.

                              -

                              Construction

                              +

                              Construction

                              The workshop needs water as its input, which it takes via a passable floor tile below it, like usual magma workshops do. The magma version also needs magma.

                              @@ -2504,7 +2573,7 @@ This also means that engines cannot be chained without intermediate short axles that can be built later than both of the engines.

                              -

                              Operation

                              +

                              Operation

                              In order to operate the engine, queue the Stoke Boiler job (optionally on repeat). A furnace operator will come, possibly bringing a bar of fuel, and perform it. As a result, a "boiling water" item will appear @@ -2529,7 +2598,7 @@ decrease it by further 4%, and also decrease the whole steam use rate by 10%.

                              -

                              Explosions

                              +

                              Explosions

                              The engine must be constructed using barrel, pipe and piston from fire-safe, or in the magma version magma-safe metals.

                              During operation weak parts get gradually worn out, and @@ -2538,7 +2607,7 @@ toppled during operation by a building destroyer, or a tantruming dwarf.

                              -

                              Save files

                              +

                              Save files

                              It should be safe to load and view engine-using fortresses from a DF version without DFHack installed, except that in such case the engines won't work. However actually making modifications @@ -2549,7 +2618,7 @@ being generated.

                              -

                              Add Spatter

                              +

                              Add Spatter

                              This plugin makes reactions with names starting with SPATTER_ADD_ produce contaminants on the items instead of improvements.

                              Intended to give some use to all those poisons that can be bought from caravans.

                              From c5101b2ea4f2685dd306f91840ab471048e52495 Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Fri, 21 Sep 2012 12:19:48 +0400 Subject: [PATCH 13/18] Group commands in the readme document by their general type. There are way too many of them now for a flat list to work. --- README.rst | 1536 ++++++++++++++++++----------------- Readme.html | 2217 +++++++++++++++++++++++++-------------------------- 2 files changed, 1902 insertions(+), 1851 deletions(-) diff --git a/README.rst b/README.rst index 40d7b74e3..b0258bb30 100644 --- a/README.rst +++ b/README.rst @@ -152,33 +152,109 @@ 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. + +Game progress +============= + +die +--- +Instantly kills DF without saving. + +forcepause +---------- +Forces DF to pause. This is useful when your FPS drops below 1 and you lose +control of the game. + + * Activate with 'forcepause 1' + * Deactivate with 'forcepause 0' + +nopause +------- +Disables pausing (both manual and automatic) with the exception of pause forced +by 'reveal hell'. This is nice for digging under rivers. + +fastdwarf +--------- +Makes your minions move at ludicrous speeds. + + * Activate with 'fastdwarf 1' + * Deactivate with 'fastdwarf 0' + + +Game interface +============== + +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. + +tidlers +------- +Toggle between all possible positions where the idlers count can be placed. + +twaterlvl +--------- +Toggle between displaying/not displaying liquid depth as numbers. + +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. + +rename +------ +Allows renaming various things. + +Options: + + :rename squad "name": Rename squad by index to 'name'. + :rename hotkey \"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. + :rename building "name": Set a custom name for the selected building. + The building must be one of stockpile, workshop, furnace, trap, + siege engine or an activity zone. + + +Adventure mode +============== + 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 ------ +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. -:metal-detector [all-types] [non-trader]: Reveal metal armor and weapons in - shops. The options disable the checks - on item type and being in shop. +Usage: + + :list-equipped [all]: List armor and weapons equipped by your companions. + If all is specified, also lists non-metal clothing. + :metal-detector [all-types] [non-trader]: Reveal metal armor and weapons in + shops. The options disable the checks + on item type and being in shop. + + +Map modification +================ changelayer -=========== +----------- Changes material of the geology layer under cursor to the specified inorganic RAW material. Can have impact on all surrounding regions, not only your embark! By default changing stone to soil and vice versa is not allowed. By default @@ -191,18 +267,18 @@ as well, though. Mineral veins and gem clusters will stay on the map. Use tl;dr: You will end up with changing quite big areas in one go, especially if you use it in lower z levels. Use with care. -Options -------- -:all_biomes: Change selected layer for all biomes on your map. +Options: + + :all_biomes: Change selected layer for all biomes on your map. Result may be undesirable since the same layer can AND WILL be on different z-levels for different biomes. Use the tool 'probe' to get an idea how layers and biomes are distributed on your map. -:all_layers: Change all layers on your map (only for the selected biome + :all_layers: Change all layers on your map (only for the selected biome unless 'all_biomes' is added). Candy mountain, anyone? Will make your map quite boring, but tidy. -:force: Allow changing stone to soil and vice versa. !!THIS CAN HAVE + :force: Allow changing stone to soil and vice versa. !!THIS CAN HAVE WEIRD EFFECTS, USE WITH CARE!! Note that soil will not be magically replaced with stone. You will, however, get a stone floor after digging so it @@ -211,16 +287,16 @@ Options You will, however, get a soil floor after digging so it could be helpful for creating farm plots on maps with no soil. -:verbose: Give some details about what is being changed. -:trouble: Give some advice about known problems. + :verbose: Give some details about what is being changed. + :trouble: Give some advice about known problems. Examples: ---------- -``changelayer GRANITE`` + + ``changelayer GRANITE`` Convert layer at cursor position into granite. -``changelayer SILTY_CLAY force`` + ``changelayer SILTY_CLAY force`` Convert layer at cursor position into clay even if it's stone. -``changelayer MARBLE all_biomes all_layers`` + ``changelayer MARBLE all_biomes all_layers`` Convert all layers of all biomes which are not soil into marble. .. note:: @@ -239,18 +315,18 @@ Examples: You did save your game, right? changevein -========== +---------- Changes material of the vein under cursor to the specified inorganic RAW material. Only affects tiles within the current 16x16 block - for veins and large clusters, you will need to use this command multiple times. Example: --------- -``changevein NATIVE_PLATINUM`` + + ``changevein NATIVE_PLATINUM`` Convert vein at cursor position into platinum ore. changeitem -========== +---------- Allows changing item material and base quality. By default the item currently selected in the UI will be changed (you can select items in the 'k' list or inside containers/inventory). By default change is only allowed if materials @@ -261,474 +337,283 @@ in weirdness. To get an idea how the RAW id should look like, check some items with 'info'. Using 'force' might create items which are not touched by crafters/haulers. -Options -------- -:info: Don't change anything, print some info instead. -:here: Change all items at the cursor position. Requires in-game cursor. -:material, m: Change material. Must be followed by valid material RAW id. -:quality, q: Change base quality. Must be followed by number (0-5). -:force: Ignore subtypes, force change to new material. +Options: + + :info: Don't change anything, print some info instead. + :here: Change all items at the cursor position. Requires in-game cursor. + :material, m: Change material. Must be followed by valid material RAW id. + :quality, q: Change base quality. Must be followed by number (0-5). + :force: Ignore subtypes, force change to new material. Examples: ---------- -``changeitem m INORGANIC:GRANITE here`` + + ``changeitem m INORGANIC:GRANITE here`` Change material of all items under the cursor to granite. -``changeitem q 5`` + ``changeitem q 5`` Change currently selected item to masterpiece quality. -cursecheck -========== -Checks a single map tile or the whole map/world for cursed creatures (ghosts, -vampires, necromancers, werebeasts, zombies). +colonies +-------- +Allows listing all the vermin colonies on the map and optionally turning them into honey bee colonies. -With an active in-game cursor only the selected tile will be observed. -Without a cursor the whole map will be checked. +Options: -By default cursed creatures will be only counted in case you just want to find -out if you have any of them running around in your fort. Dead and passive -creatures (ghosts who were put to rest, killed vampires, ...) are ignored. -Undead skeletons, corpses, bodyparts and the like are all thrown into the curse -category "zombie". Anonymous zombies and resurrected body parts will show -as "unnamed creature". + :bees: turn colonies into honey bee colonies + +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). -Options +feature ------- -:detail: Print full name, date of birth, date of curse and some status - info (some vampires might use fake identities in-game, though). -:nick: Set the type of curse as nickname (does not always show up - in-game, some vamps don't like nicknames). -:all: Include dead and passive cursed creatures (can result in a quite - long list after having FUN with necromancers). -:verbose: Print all curse tags (if you really want to know it all). +Enables management of map features. -Examples: ---------- -``cursecheck detail all`` - Give detailed info about all cursed creatures including deceased ones (no - in-game cursor). -``cursecheck nick`` - Give a nickname all living/active cursed creatures on the map(no in-game - cursor). +* Discovering a magma feature (magma pool, volcano, magma sea, or curious + underground structure) permits magma workshops and furnaces to be built. +* Discovering a cavern layer causes plants (trees, shrubs, and grass) from + that cavern to grow within your fortress. -.. note:: +Options: - * If you do a full search (with the option "all") former ghosts will show up - with the cursetype "unknown" because their ghostly flag is not set - anymore. But if you happen to find a living/active creature with cursetype - "unknown" please report that in the dfhack thread on the modding forum or - per irc. This is likely to happen with mods which introduce new types - of curses, for example. + :list: Lists all map features in your current embark by index. + :show X: Marks the selected map feature as discovered. + :hide X: Marks the selected map feature as undiscovered. -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. +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. Settings will be remembered +as long as dfhack runs. Intended for use in combination with the command +liquids-here (which can be bound to a hotkey). -forcepause -========== -Forces DF to pause. This is useful when your FPS drops below 1 and you lose -control of the game. +For more information, refer to the command's internal help. - * Activate with 'forcepause 1' - * Deactivate with 'forcepause 0' +.. note:: -nopause -======= -Disables pausing (both manual and automatic) with the exception of pause forced -by 'reveal hell'. This is nice for digging under rivers. + Spawning and deleting liquids can F up pathing data and + temperatures (creating heat traps). You've been warned. -die -=== -Instantly kills DF without saving. +liquids-here +------------ +Run the liquid spawner with the current/last settings made in liquids (if no +settings in liquids were made it paints a point of 7/7 magma by default). -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. +Intended to be used as keybinding. Requires an active in-game cursor. -Cursor must be placed on a floor tile so the items can be dumped there. -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). +tiletypes +--------- +Can be used for painting map tiles and is an interactive command, much like +liquids. -autodump-destroy-here -===================== -Destroy items marked for dumping under cursor. Identical to autodump -destroy-here, but intended for use as keybinding. +The tool works with two set of options and a brush. The brush determines which +tiles will be processed. First set of options is the filter, which can exclude +some of the tiles from the brush by looking at the tile properties. The second +set of options is the paint - this determines how the selected tiles are +changed. -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. +Both paint and filter can have many different properties including things like +general shape (WALL, FLOOR, etc.), general material (SOIL, STONE, MINERAL, +etc.), state of 'designated', 'hidden' and 'light' flags. -burrow -====== -Miscellaneous burrow control. Allows manipulating burrows and automated burrow -expansion while digging. +The properties of filter and paint can be partially defined. This means that +you can for example do something like this: -Options -------- -:enable feature ...: -:disable feature ...: Enable or Disable features of the plugin. -:clear-unit burrow burrow ...: -:clear-tiles burrow burrow ...: Removes all units or tiles from the burrows. -:set-units target-burrow src-burrow ...: -:add-units target-burrow src-burrow ...: -:remove-units target-burrow src-burrow ...: Adds or removes units in source - burrows to/from the target burrow. Set is equivalent to clear and add. -:set-tiles target-burrow src-burrow ...: -:add-tiles target-burrow src-burrow ...: -:remove-tiles target-burrow src-burrow ...: Adds or removes tiles in source - burrows to/from the target burrow. In place of a source burrow it is - possible to use one of the following keywords: ABOVE_GROUND, - SUBTERRANEAN, INSIDE, OUTSIDE, LIGHT, DARK, HIDDEN, REVEALED - -Features --------- -:auto-grow: When a wall inside a burrow with a name ending in '+' is dug - out, the burrow is extended to newly-revealed adjacent walls. - This final '+' may be omitted in burrow name args of commands above. - Digging 1-wide corridors with the miner inside the burrow is SLOW. +:: -catsplosion -=========== -Makes cats just *multiply*. It is not a good idea to run this more than once or -twice. + filter material STONE + filter shape FORTIFICATION + paint shape FLOOR -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. +This will turn all stone fortifications into floors, preserving the material. -Options -------- -:map: Clean the map tiles. By default, it leaves mud and snow alone. -:units: Clean the creatures. Will also clean hostiles. -:items: Clean all the items. Even a poisoned blade. +Or this: +:: -Extra options for 'map' ------------------------ -:mud: Remove mud in addition to the normal stuff. -:snow: Also remove snow coverings. + filter shape FLOOR + filter material MINERAL + paint shape WALL -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. +Turning mineral vein floors back into walls. -cleanowned -========== -Confiscates items owned by dwarfs. By default, owned food on the floor -and rotten items are confistacted and dumped. +The tool also allows tweaking some tile flags: -Options -------- -:all: confiscate all owned items -:scattered: confiscated and dump all items scattered on the floor -:x: confiscate/dump items with wear level 'x' and more -:X: confiscate/dump items with wear level 'X' and more -:dryrun: a dry run. combine with other options to see what will happen - without it actually happening. +Or this: -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 -======== -Allows listing all the vermin colonies on the map and optionally turning them into honey bee colonies. + paint hidden 1 + paint hidden 0 -Options -------- -:bees: turn colonies into honey bee colonies +This will hide previously revealed tiles (or show hidden with the 0 option). -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). +Any paint or filter option (or the entire paint or filter) can be disabled entirely by using the ANY keyword: -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 + paint hidden ANY + paint shape ANY + filter material any + filter shape any + filter any -Confirmed working DFusion plugins: ----------------------------------- -:simple_embark: allows changing the number of dwarves available on embark. +You can use several different brushes for painting tiles: + * Point. (point) + * Rectangular range. (range) + * A column ranging from current cursor to the first solid tile above. (column) + * DF map block - 16x16 tiles, in a regular grid. (block) -.. note:: - - * Some of the DFusion plugins aren't completely ported yet. This can lead to crashes. - * This is currently working only on Windows. - * The game will be suspended while you're using dfusion. Don't panic when it doen't respond. - -drybuckets -========== -This utility removes water from all buckets in your fortress, allowing them to be safely used for making lye. - -fastdwarf -========= -Makes your minions move at ludicrous speeds. - - * Activate with 'fastdwarf 1' - * Deactivate with 'fastdwarf 0' +Example: -feature -======= -Enables management of map features. +:: -* Discovering a magma feature (magma pool, volcano, magma sea, or curious - underground structure) permits magma workshops and furnaces to be built. -* Discovering a cavern layer causes plants (trees, shrubs, and grass) from - that cavern to grow within your fortress. + range 10 10 1 -Options -------- -:list: Lists all map features in your current embark by index. -:show X: Marks the selected map feature as discovered. -:hide X: Marks the selected map feature as undiscovered. +This will change the brush to a rectangle spanning 10x10 tiles on one z-level. +The range starts at the position of the cursor and goes to the east, south and +up. -filltraffic -=========== -Set traffic designations using flood-fill starting at the cursor. +For more details, see the 'help' command while using this. -Traffic Type Codes: -------------------- -:H: High Traffic -:N: Normal Traffic -:L: Low Traffic -:R: Restricted Traffic +tiletypes-commands +------------------ +Runs tiletypes commands, separated by ;. This makes it possible to change +tiletypes modes from a hotkey. -Other Options: +tiletypes-here -------------- -:X: Fill accross z-levels. -:B: Include buildings and stockpiles. -:P: Include empty space. - -Example: --------- -'filltraffic H' - When used in a room with doors, it will set traffic to HIGH in just that room. - -alltraffic -========== -Set traffic designations for every single tile of the map (useful for resetting traffic designations). +Apply the current tiletypes options at the in-game cursor position, including +the brush. Can be used from a hotkey. -Traffic Type Codes: -------------------- -:H: High Traffic -:N: Normal Traffic -:L: Low Traffic -:R: Restricted Traffic +tiletypes-here-point +-------------------- +Apply the current tiletypes options at the in-game cursor position to a single +tile. Can be used from a hotkey. -Example: +tubefill -------- -'alltraffic N' - Set traffic to 'normal' for all tiles. +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). -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. +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. -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. +Options: -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. + :shrubs: affect all shrubs on the map + :trees: affect all trees on the map + :all: affect every plant! -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. +grow +---- +Makes all saplings present on the map grow into trees (almost) instantly. -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. +immolate +-------- +Very similar to extirpate, but additionally sets the plants on fire. The fires +can and *will* spread ;) -Options +regrass ------- -:-t: Select trees only (exclude shrubs) -:-s: Select shrubs only (exclude trees) -:-c: Clear designations instead of setting them -:-x: Apply selected action to all plants except those specified (invert - selection) - -Specifying both -t and -s will have no effect. If no plant IDs are specified, -all valid plant IDs will be listed. - -tidlers -======= -Toggle between all possible positions where the idlers count can be placed. +Regrows grass. Not much to it ;) -twaterlvl -========= -Toggle between displaying/not displaying liquid depth as numbers. +weather +------- +Prints the current weather map by default. -job -=== -Command for general job query and manipulation. +Also lets you change the current weather to 'clear sky', 'rainy' or 'snowing'. 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 - Replace the exact material - id in the job item. - * item-type - Replace the exact item type id in - the job item. - -job-material -============ -Alter the material of the selected job. - -Invoked as: job-material - -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. - * In 'b' mode, during selection of building components positions the cursor - over the first available choice with the matching material. - -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. - -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. Settings will be remembered -as long as dfhack runs. Intended for use in combination with the command -liquids-here (which can be bound to a hotkey). -For more information, refer to the command's internal help. + :snow: make it snow everywhere. + :rain: make it rain. + :clear: clear the sky. -.. note:: - - Spawning and deleting liquids can F up pathing data and - temperatures (creating heat traps). You've been warned. -liquids-here -============ -Run the liquid spawner with the current/last settings made in liquids (if no -settings in liquids were made it paints a point of 7/7 magma by default). +Map inspection +============== -Intended to be used as keybinding. Requires an active in-game cursor. +cursecheck +---------- +Checks a single map tile or the whole map/world for cursed creatures (ghosts, +vampires, necromancers, werebeasts, zombies). -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. +With an active in-game cursor only the selected tile will be observed. +Without a cursor the whole map will be checked. -.. admonition:: Example +By default cursed creatures will be only counted in case you just want to find +out if you have any of them running around in your fort. Dead and passive +creatures (ghosts who were put to rest, killed vampires, ...) are ignored. +Undead skeletons, corpses, bodyparts and the like are all thrown into the curse +category "zombie". Anonymous zombies and resurrected body parts will show +as "unnamed creature". - You are in fort game mode, managing your fortress and paused. - You switch to the arena game mode, *assume control of a creature* and then - switch to adventure game mode(1). - You just lost a fortress and gained an adventurer. - You could also do this. - You are in fort game mode, managing your fortress and paused at the esc menu. - You switch to the adventure game mode, then use Dfusion to *assume control of a creature* and then - save or retire. - You just created a returnable mountain home and gained an adventurer. +Options: + :detail: Print full name, date of birth, date of curse and some status + info (some vampires might use fake identities in-game, though). + :nick: Set the type of curse as nickname (does not always show up + in-game, some vamps don't like nicknames). + :all: Include dead and passive cursed creatures (can result in a quite + long list after having FUN with necromancers). + :verbose: Print all curse tags (if you really want to know it all). -I take no responsibility of anything that happens as a result of using this tool +Examples: -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. + ``cursecheck detail all`` + Give detailed info about all cursed creatures including deceased ones (no + in-game cursor). + ``cursecheck nick`` + Give a nickname all living/active cursed creatures on the map(no in-game + cursor). -Options -------- -:shrubs: affect all shrubs on the map -:trees: affect all trees on the map -:all: affect every plant! +.. note:: -grow -==== -Makes all saplings present on the map grow into trees (almost) instantly. + * If you do a full search (with the option "all") former ghosts will show up + with the cursetype "unknown" because their ghostly flag is not set + anymore. But if you happen to find a living/active creature with cursetype + "unknown" please report that in the dfhack thread on the modding forum or + per irc. This is likely to happen with mods which introduce new types + of curses, for example. -immolate -======== -Very similar to extirpate, but additionally sets the plants on fire. The fires -can and *will* spread ;) +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. probe -===== +----- Can be used to determine tile properties like temperature. prospect -======== +-------- Prints a big list of all the present minerals and plants. By default, only the visible part of the map is scanned. -Options -------- -: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'. +Options: + + :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 -------- -:all: processes all tiles, even hidden ones. - -regrass -======= -Regrows grass. Not much to it ;) - -rename -====== -Allows renaming various things. +Options: -Options -------- -:rename squad "name": Rename squad by index to 'name'. -:rename hotkey \"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. -:rename building "name": Set a custom name for the selected building. - The building must be one of stockpile, workshop, furnace, trap, - siege engine or an activity zone. + :all: processes all tiles, even hidden ones. 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 @@ -738,167 +623,325 @@ Reveal also works in adventure mode, but any of its effects are negated once you move. When you use it this way, you don't need to run 'unreveal'. unreveal -======== +-------- Reverts the effects of 'reveal'. revtoggle -========= +--------- Switches between 'reveal' and 'unreveal'. revflood -======== +-------- This command will hide the whole map and then reveal all the tiles that have a path to the in-game cursor. revforget -========= +--------- When you use reveal, it saves information about what was/wasn't visible before revealing everything. Unreveal uses this information to hide things again. This command throws away the information. For example, use in cases where you abandoned with the fort revealed and no longer want the data. -lair -==== -This command allows you to mark the map as 'monster lair', preventing item -scatter on abandon. When invoked as 'lair reset', it does the opposite. +showmood +-------- +Shows all items needed for the currently active strange mood. -Unlike reveal, this command doesn't save the information about tiles - you -won't be able to restore state of real monster lairs using 'lair reset'. -Options -------- -:lair: Mark the map as monster lair -:lair reset: Mark the map as ordinary (not lair) +Designations +============ -seedwatch -========= -Tool for turning cooking of seeds and plants on/off depending on how much you -have of them. +burrow +------ +Miscellaneous burrow control. Allows manipulating burrows and automated burrow +expansion while digging. -See 'seedwatch help' for detailed description. +Options: -showmood -======== -Shows all items needed for the currently active strange mood. + **enable feature ...** + Enable features of the plugin. + **disable feature ...** + Disable features of the plugin. + **clear-unit burrow burrow ...** + Remove all units from the burrows. + **clear-tiles burrow burrow ...** + Remove all tiles from the burrows. + **set-units target-burrow src-burrow ...** + Clear target, and adds units from source burrows. + **add-units target-burrow src-burrow ...** + Add units from the source burrows to the target. + **remove-units target-burrow src-burrow ...** + Remove units in source burrows from the target. + **set-tiles target-burrow src-burrow ...** + Clear target and adds tiles from the source burrows. + **add-tiles target-burrow src-burrow ...** + Add tiles from the source burrows to the target. + **remove-tiles target-burrow src-burrow ...** + Remove tiles in source burrows from the target. + + For these three options, in place of a source burrow it is + possible to use one of the following keywords: ABOVE_GROUND, + SUBTERRANEAN, INSIDE, OUTSIDE, LIGHT, DARK, HIDDEN, REVEALED + +Features: + + :auto-grow: When a wall inside a burrow with a name ending in '+' is dug + out, the burrow is extended to newly-revealed adjacent walls. + This final '+' may be omitted in burrow name args of commands above. + Digging 1-wide corridors with the miner inside the burrow is SLOW. -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. +digv +---- +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). -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). +digvx +----- +A permanent alias for 'digv x'. -All the data resides in the 'stonesense' directory. For detailed instructions, -see stonesense/README.txt +digl +---- +Designates layer stone for digging. Requires an active in-game cursor placed +over a layer stone tile. With the 'x' option, it will traverse z-levels +(putting stairs between the same-material tiles). With the 'undo' option it +will remove the dig designation instead (if you realize that digging out a 50 +z-level deep layer was not such a good idea after all). -Compatible with Windows > XP SP3 and most modern Linux distributions. +diglx +----- +A permanent alias for 'digl x'. -Older versions, support and extra graphics can be found in the bay12 forum -thread: http://www.bay12forums.com/smf/index.php?topic=43260.0 +digexp +------ +This command can be used for exploratory mining. -Some additional resources: -http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository +See: http://df.magmawiki.com/index.php/DF2010:Exploratory_mining -tiletypes -========= -Can be used for painting map tiles and is an interactive command, much like -liquids. +There are two variables that can be set: pattern and filter. -The tool works with two set of options and a brush. The brush determines which -tiles will be processed. First set of options is the filter, which can exclude -some of the tiles from the brush by looking at the tile properties. The second -set of options is the paint - this determines how the selected tiles are -changed. +Patterns: -Both paint and filter can have many different properties including things like -general shape (WALL, FLOOR, etc.), general material (SOIL, STONE, MINERAL, -etc.), state of 'designated', 'hidden' and 'light' flags. + :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. -The properties of filter and paint can be partially defined. This means that -you can for example do something like this: +Filters: -:: + :all: designate whole z-level + :hidden: designate only hidden tiles of z-level (default) + :designated: Take current designation and apply pattern to it. - filter material STONE - filter shape FORTIFICATION - paint shape FLOOR +After you have a pattern set, you can use 'expdig' to apply it again. -This will turn all stone fortifications into floors, preserving the material. +Examples: -Or this: -:: + 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 - filter shape FLOOR - filter material MINERAL - paint shape WALL +digcircle +--------- +A command for easy designation of filled and hollow circles. +It has several types of options. -Turning mineral vein floors back into walls. +Shape: -The tool also allows tweaking some tile flags: + :hollow: Set the circle to hollow (default) + :filled: Set the circle to filled + :#: Diameter in tiles (default = 0, does nothing) -Or this: +Action: -:: + :set: Set designation (default) + :unset: Unset current designation + :invert: Invert designations already present - paint hidden 1 - paint hidden 0 +Designation types: -This will hide previously revealed tiles (or show hidden with the 0 option). + :dig: Normal digging designation (default) + :ramp: Ramp digging + :ustair: Staircase up + :dstair: Staircase down + :xstair: Staircase up/down + :chan: Dig channel -Any paint or filter option (or the entire paint or filter) can be disabled entirely by using the ANY keyword: +After you have set the options, the command called with no options +repeats with the last selected parameters. -:: +Examples: - paint hidden ANY - paint shape ANY - filter material any - filter shape any - filter any +* 'digcircle filled 3' = Dig a filled circle with radius = 3. +* 'digcircle' = Do it again. -You can use several different brushes for painting tiles: - * Point. (point) - * Rectangular range. (range) - * A column ranging from current cursor to the first solid tile above. (column) - * DF map block - 16x16 tiles, in a regular grid. (block) + +filltraffic +----------- +Set traffic designations using flood-fill starting at the cursor. + +Traffic Type Codes: + + :H: High Traffic + :N: Normal Traffic + :L: Low Traffic + :R: Restricted Traffic + +Other Options: + + :X: Fill accross z-levels. + :B: Include buildings and stockpiles. + :P: Include empty space. Example: -:: + 'filltraffic H' - When used in a room with doors, it will set traffic to HIGH in just that room. + +alltraffic +---------- +Set traffic designations for every single tile of the map (useful for resetting traffic designations). + +Traffic Type Codes: + + :H: High Traffic + :N: Normal Traffic + :L: Low Traffic + :R: Restricted Traffic + +Example: + + 'alltraffic N' - Set traffic to 'normal' for all tiles. + +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: + + :-t: Select trees only (exclude shrubs) + :-s: Select shrubs only (exclude trees) + :-c: Clear designations instead of setting them + :-x: Apply selected action to all plants except those specified (invert + selection) + +Specifying both -t and -s will have no effect. If no plant IDs are specified, +all valid plant IDs will be listed. + + +Cleanup and garbage disposal +============================ + +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: + + :map: Clean the map tiles. By default, it leaves mud and snow alone. + :units: Clean the creatures. Will also clean hostiles. + :items: Clean all the items. Even a poisoned blade. + +Extra options for 'map': + + :mud: Remove mud in addition to the normal stuff. + :snow: Also remove snow coverings. + +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. + +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: + + :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. + +cleanowned +---------- +Confiscates items owned by dwarfs. By default, owned food on the floor +and rotten items are confistacted and dumped. + +Options: + + :all: confiscate all owned items + :scattered: confiscated and dump all items scattered on the floor + :x: confiscate/dump items with wear level 'x' and more + :X: confiscate/dump items with wear level 'X' and more + :dryrun: a dry run. combine with other options to see what will happen + without it actually happening. + +Example: + + ``cleanowned scattered X`` + This will confiscate rotten and dropped food, garbage on the floors and any + worn items with 'X' damage and above. - range 10 10 1 -This will change the brush to a rectangle spanning 10x10 tiles on one z-level. -The range starts at the position of the cursor and goes to the east, south and -up. -For more details, see the 'help' command while using this. +Bugfixes +======== -tiletypes-commands -================== -Runs tiletypes commands, separated by ;. This makes it possible to change -tiletypes modes from a hotkey. +drybuckets +---------- +This utility removes water from all buckets in your fortress, allowing them to be safely used for making lye. -tiletypes-here -============== -Apply the current tiletypes options at the in-game cursor position, including -the brush. Can be used from a hotkey. +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. -tiletypes-here-point -==================== -Apply the current tiletypes options at the in-game cursor position to a single -tile. Can be used from a hotkey. +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 +-------- +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. tweak -===== +----- Contains various tweaks for minor bugs (currently just one). -Options -------- +Options: + :clear-missing: Remove the missing status from the selected unit. This allows engraving slabs for ghostly, but not yet found, creatures. @@ -944,136 +987,139 @@ Options the contents separately from the container. This forcefully skips child reagents. -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). -digv -==== -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). +Mode switch and reclaim +======================= -digvx -===== -A permanent alias for 'digv x'. +lair +---- +This command allows you to mark the map as 'monster lair', preventing item +scatter on abandon. When invoked as 'lair reset', it does the opposite. -digl -==== -Designates layer stone for digging. Requires an active in-game cursor placed -over a layer stone tile. With the 'x' option, it will traverse z-levels -(putting stairs between the same-material tiles). With the 'undo' option it -will remove the dig designation instead (if you realize that digging out a 50 -z-level deep layer was not such a good idea after all). +Unlike reveal, this command doesn't save the information about tiles - you +won't be able to restore state of real monster lairs using 'lair reset'. -diglx -===== -A permanent alias for 'digl x'. +Options: -digexp -====== -This command can be used for exploratory mining. + :lair: Mark the map as monster lair + :lair reset: Mark the map as ordinary (not lair) -See: http://df.magmawiki.com/index.php/DF2010:Exploratory_mining +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. -There are two variables that can be set: pattern and filter. +.. admonition:: Example -Patterns: ---------- -: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. + You are in fort game mode, managing your fortress and paused. + You switch to the arena game mode, *assume control of a creature* and then + switch to adventure game mode(1). + You just lost a fortress and gained an adventurer. + You could also do this. + You are in fort game mode, managing your fortress and paused at the esc menu. + You switch to the adventure game mode, then use Dfusion to *assume control of a creature* and then + save or retire. + You just created a returnable mountain home and gained an adventurer. -Filters: --------- -:all: designate whole z-level -:hidden: designate only hidden tiles of z-level (default) -:designated: Take current designation and apply pattern to it. -After you have a pattern set, you can use 'expdig' to apply it again. +I take no responsibility of anything that happens as a result of using this tool -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 -========= -A command for easy designation of filled and hollow circles. -It has several types of options. +Visualizer and data export +========================== -Shape: --------- -:hollow: Set the circle to hollow (default) -:filled: Set the circle to filled -:#: Diameter in tiles (default = 0, does nothing) +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). -Action: -------- -:set: Set designation (default) -:unset: Unset current designation -:invert: Invert designations already present +All the data resides in the 'stonesense' directory. For detailed instructions, +see stonesense/README.txt -Designation types: ------------------- -:dig: Normal digging designation (default) -:ramp: Ramp digging -:ustair: Staircase up -:dstair: Staircase down -:xstair: Staircase up/down -:chan: Dig channel +Compatible with Windows > XP SP3 and most modern Linux distributions. -After you have set the options, the command called with no options -repeats with the last selected parameters. +Older versions, support and extra graphics can be found in the bay12 forum +thread: http://www.bay12forums.com/smf/index.php?topic=43260.0 -Examples: +Some additional resources: +http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository + +mapexport --------- -* 'digcircle filled 3' = Dig a filled circle with radius = 3. -* 'digcircle' = Do it again. +Export the current loaded map as a file. This will be eventually usable +with visualizers. -weather -======= -Prints the current weather map by default. +dwarfexport +----------= +Export dwarves to RuneSmith-compatible XML. -Also lets you change the current weather to 'clear sky', 'rainy' or 'snowing'. + +Job management +============== + +job +--- +Command for general job query and manipulation. Options: --------- -:snow: make it snow everywhere. -:rain: make it rain. -:clear: clear the sky. + *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 ** + Replace the exact material id in the job item. + **item-type ** + Replace the exact item type id in the job item. + +job-material +------------ +Alter the material of the selected job. + +Invoked as:: + + job-material + +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. + * In 'b' mode, during selection of building components positions the cursor + over the first available choice with the matching material. + +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. workflow -======== +-------- Manage control of repeat jobs. -Usage ------ -``workflow enable [option...], workflow disable [option...]`` +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`` + ``workflow jobs`` List workflow-controlled jobs (if in a workshop, filtered by it). -``workflow list`` + ``workflow list`` List active constraints, and their job counts. -``workflow count [cnt-gap], workflow amount [cnt-gap]`` + ``workflow count [cnt-gap], workflow amount [cnt-gap]`` Set a constraint. The first form counts each stack as only 1 item. -``workflow unlimit `` + ``workflow unlimit `` 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. @@ -1086,7 +1132,8 @@ the frequency of jobs being toggled. Constraint examples -------------------- +................... + Keep metal bolts within 900-1000, and wood/bone within 150-200. :: @@ -1127,73 +1174,76 @@ Make sure there are always 80-100 units of dimple dye. on the Mill Plants job to MUSHROOM_CUP_DIMPLE using the 'job item-material' command. -mapexport -========= -Export the current loaded map as a file. This will be eventually usable -with visualizers. -dwarfexport -=========== -Export dwarves to RuneSmith-compatible XML. +Fortress activity management +============================ + +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. zone -==== +---- Helps a bit with managing activity zones (pens, pastures and pits) and cages. Options: --------- -:set: Set zone or cage under cursor as default for future assigns. -:assign: Assign unit(s) to the pen or pit marked with the 'set' command. + + :set: Set zone or cage under cursor as default for future assigns. + :assign: Assign unit(s) to the pen or pit marked with the 'set' command. If no filters are set a unit must be selected in the in-game ui. Can also be followed by a valid zone id which will be set instead. -:unassign: Unassign selected creature from it's zone. -:nick: Mass-assign nicknames, must be followed by the name you want + :unassign: Unassign selected creature from it's zone. + :nick: Mass-assign nicknames, must be followed by the name you want to set. -:remnick: Mass-remove nicknames. -:tocages: Assign unit(s) to cages inside a pasture. -:uinfo: Print info about unit(s). If no filters are set a unit must + :remnick: Mass-remove nicknames. + :tocages: Assign unit(s) to cages inside a pasture. + :uinfo: Print info about unit(s). If no filters are set a unit must be selected in the in-game ui. -:zinfo: Print info about zone(s). If no filters are set zones under + :zinfo: Print info about zone(s). If no filters are set zones under the cursor are listed. -:verbose: Print some more info. -:filters: Print list of valid filter options. -:examples: Print some usage examples. -:not: Negates the next filter keyword. + :verbose: Print some more info. + :filters: Print list of valid filter options. + :examples: Print some usage examples. + :not: Negates the next filter keyword. Filters: --------- -:all: Process all units (to be used with additional filters). -:count: Must be followed by a number. Process only n units (to be used - with additional filters). -:unassigned: Not assigned to zone, chain or built cage. -:minage: Minimum age. Must be followed by number. -:maxage: Maximum age. Must be followed by number. -:race: Must be followed by a race RAW ID (e.g. BIRD_TURKEY, ALPACA, - etc). Negatable. -:caged: In a built cage. Negatable. -:own: From own civilization. Negatable. -:merchant: Is a merchant / belongs to a merchant. Should only be used for - pitting, not for stealing animals (slaughter should work). -:war: Trained war creature. Negatable. -:hunting: Trained hunting creature. Negatable. -:tamed: Creature is tame. Negatable. -:trained: Creature is trained. Finds war/hunting creatures as well as - creatures who have a training level greater than 'domesticated'. - If you want to specifically search for war/hunting creatures use - 'war' or 'hunting' Negatable. -:trainablewar: Creature can be trained for war (and is not already trained for - war/hunt). Negatable. -:trainablehunt: Creature can be trained for hunting (and is not already trained - for war/hunt). Negatable. -:male: Creature is male. Negatable. -:female: Creature is female. Negatable. -:egglayer: Race lays eggs. Negatable. -:grazer: Race is a grazer. Negatable. -:milkable: Race is milkable. Negatable. + + :all: Process all units (to be used with additional filters). + :count: Must be followed by a number. Process only n units (to be used + with additional filters). + :unassigned: Not assigned to zone, chain or built cage. + :minage: Minimum age. Must be followed by number. + :maxage: Maximum age. Must be followed by number. + :race: Must be followed by a race RAW ID (e.g. BIRD_TURKEY, ALPACA, + etc). Negatable. + :caged: In a built cage. Negatable. + :own: From own civilization. Negatable. + :merchant: Is a merchant / belongs to a merchant. Should only be used for + pitting, not for stealing animals (slaughter should work). + :war: Trained war creature. Negatable. + :hunting: Trained hunting creature. Negatable. + :tamed: Creature is tame. Negatable. + :trained: Creature is trained. Finds war/hunting creatures as well as + creatures who have a training level greater than 'domesticated'. + If you want to specifically search for war/hunting creatures use + 'war' or 'hunting' Negatable. + :trainablewar: Creature can be trained for war (and is not already trained for + war/hunt). Negatable. + :trainablehunt: Creature can be trained for hunting (and is not already trained + for war/hunt). Negatable. + :male: Creature is male. Negatable. + :female: Creature is female. Negatable. + :egglayer: Race lays eggs. Negatable. + :grazer: Race is a grazer. Negatable. + :milkable: Race is milkable. Negatable. Usage with single units ------------------------ +....................... + One convenient way to use the zone tool is to bind the command 'zone assign' to a hotkey, maybe also the command 'zone set'. Place the in-game cursor over a pen/pasture or pit, use 'zone set' to mark it. Then you can select units @@ -1202,7 +1252,8 @@ and use 'zone assign' to assign them to their new home. Allows pitting your own dwarves, by the way. Usage with filters ------------------- +.................. + All filters can be used together with the 'assign' command. Restrictions: It's not possible to assign units who are inside built cages @@ -1223,14 +1274,16 @@ are not properly added to your own stocks; slaughtering them should work). Most filters can be negated (e.g. 'not grazer' -> race is not a grazer). Mass-renaming -------------- +............. + Using the 'nick' command you can set the same nickname for multiple units. If used without 'assign', 'all' or 'count' it will rename all units in the current default target zone. Combined with 'assign', 'all' or 'count' (and further optional filters) it will rename units matching the filter conditions. Cage zones ----------- +.......... + Using the 'tocages' command you can assign units to a set of cages, for example a room next to your butcher shop(s). They will be spread evenly among available cages to optimize hauling to and butchering from them. For this to work you need @@ -1241,7 +1294,8 @@ would make no sense, but can be used together with 'nick' or 'remnick' and all the usual filters. Examples --------- +........ + ``zone assign all own ALPACA minage 3 maxage 10`` Assign all own alpacas who are between 3 and 10 years old to the selected pasture. @@ -1264,7 +1318,7 @@ Examples on the current default zone. autonestbox -=========== +----------- Assigns unpastured female egg-layers to nestbox zones. Requires that you create pen/pasture zones above nestboxes. If the pen is bigger than 1x1 the nestbox must be in the top left corner. Only 1 unit will be assigned per pen, regardless @@ -1276,15 +1330,15 @@ nestbox zones when they revert to wild. When called without options autonestbox will instantly run once. Options: --------- -:start: Start running every X frames (df simulation ticks). - Default: X=6000, which would be every 60 seconds at 100fps. -:stop: Stop running automatically. -:sleep: Must be followed by number X. Changes the timer to sleep X - frames between runs. + + :start: Start running every X frames (df simulation ticks). + Default: X=6000, which would be every 60 seconds at 100fps. + :stop: Stop running automatically. + :sleep: Must be followed by number X. Changes the timer to sleep X + frames between runs. autobutcher -=========== +----------- Assigns lifestock for slaughter once it reaches a specific count. Requires that you add the target race(s) to a watch list. Only tame units will be processed. @@ -1303,41 +1357,41 @@ If you don't set any target count the following default will be used: 1 male kid, 5 female kids, 1 male adult, 5 female adults. Options: --------- -:start: Start running every X frames (df simulation ticks). - Default: X=6000, which would be every 60 seconds at 100fps. -:stop: Stop running automatically. -:sleep: Must be followed by number X. Changes the timer to sleep - X frames between runs. -:watch R: Start watching a race. R can be a valid race RAW id (ALPACA, - BIRD_TURKEY, etc) or a list of ids seperated by spaces or - the keyword 'all' which affects all races on your current - watchlist. -:unwatch R: Stop watching race(s). The current target settings will be - remembered. R can be a list of ids or the keyword 'all'. -:forget R: Stop watching race(s) and forget it's/their target settings. - R can be a list of ids or the keyword 'all'. -:autowatch: Automatically adds all new races (animals you buy from merchants, - tame yourself or get from migrants) to the watch list using - default target count. -:noautowatch: Stop auto-adding new races to the watchlist. -:list: Print the current status and watchlist. -:list_export: Print status and watchlist in a format which can be used - to import them to another savegame (see notes). -:target fk mk fa ma R: Set target count for specified race(s). - fk = number of female kids, - mk = number of male kids, - fa = number of female adults, - ma = number of female adults. - R can be a list of ids or the keyword 'all' or 'new'. - R = 'all': change target count for all races on watchlist - and set the new default for the future. R = 'new': don't touch - current settings on the watchlist, only set the new default - for future entries. -:example: Print some usage examples. + + :start: Start running every X frames (df simulation ticks). + Default: X=6000, which would be every 60 seconds at 100fps. + :stop: Stop running automatically. + :sleep: Must be followed by number X. Changes the timer to sleep + X frames between runs. + :watch R: Start watching a race. R can be a valid race RAW id (ALPACA, + BIRD_TURKEY, etc) or a list of ids seperated by spaces or + the keyword 'all' which affects all races on your current + watchlist. + :unwatch R: Stop watching race(s). The current target settings will be + remembered. R can be a list of ids or the keyword 'all'. + :forget R: Stop watching race(s) and forget it's/their target settings. + R can be a list of ids or the keyword 'all'. + :autowatch: Automatically adds all new races (animals you buy from merchants, + tame yourself or get from migrants) to the watch list using + default target count. + :noautowatch: Stop auto-adding new races to the watchlist. + :list: Print the current status and watchlist. + :list_export: Print status and watchlist in a format which can be used + to import them to another savegame (see notes). + :target fk mk fa ma R: Set target count for specified race(s). + fk = number of female kids, + mk = number of male kids, + fa = number of female adults, + ma = number of female adults. + R can be a list of ids or the keyword 'all' or 'new'. + R = 'all': change target count for all races on watchlist + and set the new default for the future. R = 'new': don't touch + current settings on the watchlist, only set the new default + for future entries. + :example: Print some usage examples. Examples: ---------- + You want to keep max 7 kids (4 female, 3 male) and max 3 adults (2 female, 1 male) of the race alpaca. Once the kids grow up the oldest adults will get slaughtered. Excess kids will get slaughtered starting with the youngest @@ -1369,8 +1423,8 @@ add some new races with 'watch'. If you simply want to stop it completely use autobutcher unwatch ALPACA CAT -Note: ------ +**Note:** + Settings and watchlist are stored in the savegame, so that you can have different settings for each world. If you want to copy your watchlist to another savegame you can use the command list_export: @@ -1384,7 +1438,7 @@ another savegame you can use the command list_export: autolabor -========= +--------- Automatically manage dwarf labors. When enabled, autolabor periodically checks your dwarves and enables or @@ -1398,6 +1452,30 @@ also tries to have dwarves specialize in specific skills. For detailed usage information, see 'help autolabor'. +Other +===== + +catsplosion +----------- +Makes cats just *multiply*. It is not a good idea to run this more than once or +twice. + +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 + +Confirmed working DFusion plugins: + +:simple_embark: allows changing the number of dwarves available on embark. + +.. note:: + + * Some of the DFusion plugins aren't completely ported yet. This can lead to crashes. + * This is currently working only on Windows. + * The game will be suspended while you're using dfusion. Don't panic when it doen't respond. + ======= Scripts @@ -1413,19 +1491,6 @@ scripts that are obscure, developer-oriented, or should be used as keybindings. Some notable scripts: -quicksave -========= - -If called in dwarf mode, makes DF immediately auto-save the game by setting a flag -normally used in seasonal auto-save. - -setfps -====== - -Run ``setfps `` to set the FPS cap at runtime, in case you want to watch -combat in slow motion or something :) - - fix/* ===== @@ -1462,6 +1527,17 @@ gui/* Scripts that implement dialogs inserted into the main game window are put in this directory. +quicksave +========= + +If called in dwarf mode, makes DF immediately auto-save the game by setting a flag +normally used in seasonal auto-save. + +setfps +====== + +Run ``setfps `` to set the FPS cap at runtime, in case you want to watch +combat in slow motion or something :) growcrops ========= @@ -1684,10 +1760,12 @@ 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. -**DISCLAIMER**: Siege engines are a very interesting feature, but currently nearly useless -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. +.. admonition:: DISCLAIMER + + Siege engines are a very interesting feature, but currently nearly useless + 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. ========= @@ -1723,20 +1801,24 @@ The workshop needs water as its input, which it takes via a passable floor tile below it, like usual magma workshops do. The magma version also needs magma. -**ISSUE**: Since this building is a machine, and machine collapse -code cannot be modified, it would collapse over true open space. -As a loophole, down stair provides support to machines, while -being passable, so use them. +.. admonition:: ISSUE + + Since this building is a machine, and machine collapse + code cannot be modified, it would collapse over true open space. + As a loophole, down stair provides support to machines, while + being passable, so use them. After constructing the building itself, machines can be connected to the edge tiles that look like gear boxes. Their exact position is extracted from the workshop raws. -**ISSUE**: Like with collapse above, part of the code involved in -machine connection cannot be modified. As a result, the workshop -can only immediately connect to machine components built AFTER it. -This also means that engines cannot be chained without intermediate -short axles that can be built later than both of the engines. +.. admonition:: ISSUE + + Like with collapse above, part of the code involved in + machine connection cannot be modified. As a result, the workshop + can only immediately connect to machine components built AFTER it. + This also means that engines cannot be chained without intermediate + short axles that can be built later than both of the engines. Operation --------- diff --git a/Readme.html b/Readme.html index 977c4177d..be6856fb6 100644 --- a/Readme.html +++ b/Readme.html @@ -318,7 +318,7 @@ ul.auto-toc {

                              DFHack Readme

                              -

                              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,250 +326,192 @@ 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, versions 0.34.08 - 0.34.11 are supported. If you need DFHack @@ -578,7 +520,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:

                              @@ -600,7 +542,7 @@ remove the other DFHack files 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 @@ -624,7 +566,7 @@ they are re-created every time it is loaded.

                              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. @@ -633,13 +575,13 @@ the issues tracker on github, contact me ( -

                              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.

                              -

                              Setting keybindings

                              +

                              Setting keybindings

                              To set keybindings, use the built-in keybinding command. Like any other command it can be used at any time from the console, but it is also meaningful in the DFHack init file.

                              @@ -684,17 +626,107 @@ for context foo/bar/baz, possible matches are
                              -

                              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.

                              +
                              +

                              Game progress

                              +
                              +

                              die

                              +

                              Instantly kills DF without saving.

                              +
                              +
                              +

                              forcepause

                              +

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

                              +
                              +
                                +
                              • Activate with 'forcepause 1'
                                • +
                              • Deactivate with 'forcepause 0'
                                • +
                              +
                              +
                              +
                              +

                              nopause

                              +

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

                              +
                              +
                              +

                              fastdwarf

                              +

                              Makes your minions move at ludicrous speeds.

                              +
                              +
                                +
                              • Activate with 'fastdwarf 1'
                                • +
                              • Deactivate with 'fastdwarf 0'
                                • +
                              +
                              +
                              +
                              +
                              +

                              Game interface

                              +
                              +

                              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.

                              +
                              +
                              +

                              tidlers

                              +

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

                              +
                              +
                              +

                              twaterlvl

                              +

                              Toggle between displaying/not displaying liquid depth as numbers.

                              +
                              +
                              +

                              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.

                              +
                              +
                              +

                              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.
                              rename building "name":
                               Set a custom name for the selected building. +The building must be one of stockpile, workshop, furnace, trap, +siege engine or an activity zone.
                              +
                              +
                              +
                              +
                              +

                              Adventure mode

                              -

                              adv-bodyswap

                              +

                              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

                              +

                              Usage:

                              • When viewing unit details, body-swaps into that unit.
                                • @@ -702,12 +734,11 @@ properly.

                              -
                              -

                              advtools

                              +

                              advtools

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

                              -
                              -

                              Usage

                              +

                              Usage:

                              +
                              @@ -723,10 +754,13 @@ on item type and being in shop.
                              +
                              +
                              +

                              Map modification

                              -

                              changelayer

                              +

                              changelayer

                              Changes material of the geology layer under cursor to the specified inorganic RAW material. Can have impact on all surrounding regions, not only your embark! By default changing stone to soil and vice versa is not allowed. By default @@ -737,8 +771,8 @@ as well, though. Mineral veins and gem clusters will stay on the map. Use 'changevein' for them.

                              tl;dr: You will end up with changing quite big areas in one go, especially if you use it in lower z levels. Use with care.

                              -
                              -

                              Options

                              +

                              Options:

                              +
                              @@ -770,9 +804,9 @@ soil.
                              -
                              -
                              -

                              Examples:

                              + +

                              Examples:

                              +
                              changelayer GRANITE
                              Convert layer at cursor position into granite.
                              @@ -781,6 +815,7 @@ soil.
                              changelayer MARBLE all_biomes all_layers
                              Convert all layers of all biomes which are not soil into marble.
                              +

                              Note

                                @@ -799,22 +834,21 @@ You did save your game, right?
                              -
                              -

                              changevein

                              +

                              changevein

                              Changes material of the vein under cursor to the specified inorganic RAW material. Only affects tiles within the current 16x16 block - for veins and large clusters, you will need to use this command multiple times.

                              -
                              -

                              Example:

                              +

                              Example:

                              +
                              changevein NATIVE_PLATINUM
                              Convert vein at cursor position into platinum ore.
                              -
                              +
                              -

                              changeitem

                              +

                              changeitem

                              Allows changing item material and base quality. By default the item currently selected in the UI will be changed (you can select items in the 'k' list or inside containers/inventory). By default change is only allowed if materials @@ -824,8 +858,8 @@ with 'force'. Note that some attributes will not be touched, possibly resulting in weirdness. To get an idea how the RAW id should look like, check some items with 'info'. Using 'force' might create items which are not touched by crafters/haulers.

                              -
                              -

                              Options

                              +

                              Options:

                              +
                              @@ -842,749 +876,83 @@ crafters/haulers.

                              -
                              -
                              -

                              Examples:

                              + +

                              Examples:

                              +
                              changeitem m INORGANIC:GRANITE here
                              Change material of all items under the cursor to granite.
                              changeitem q 5
                              Change currently selected item to masterpiece quality.
                              +
                              -
                              -
                              -

                              cursecheck

                              -

                              Checks a single map tile or the whole map/world for cursed creatures (ghosts, -vampires, necromancers, werebeasts, zombies).

                              -

                              With an active in-game cursor only the selected tile will be observed. -Without a cursor the whole map will be checked.

                              -

                              By default cursed creatures will be only counted in case you just want to find -out if you have any of them running around in your fort. Dead and passive -creatures (ghosts who were put to rest, killed vampires, ...) are ignored. -Undead skeletons, corpses, bodyparts and the like are all thrown into the curse -category "zombie". Anonymous zombies and resurrected body parts will show -as "unnamed creature".

                              -
                              -

                              Options

                              +
                              +

                              colonies

                              +

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

                              +

                              Options:

                              +
                              - - - - - - - +
                              detail:Print full name, date of birth, date of curse and some status -info (some vampires might use fake identities in-game, though).
                              nick:Set the type of curse as nickname (does not always show up -in-game, some vamps don't like nicknames).
                              all:Include dead and passive cursed creatures (can result in a quite -long list after having FUN with necromancers).
                              verbose:Print all curse tags (if you really want to know it all).
                              bees:turn colonies into honey bee colonies
                              +
                              -
                              -

                              Examples:

                              -
                              -
                              cursecheck detail all
                              -
                              Give detailed info about all cursed creatures including deceased ones (no -in-game cursor).
                              -
                              cursecheck nick
                              -
                              Give a nickname all living/active cursed creatures on the map(no in-game -cursor).
                              -
                              -
                              -

                              Note

                              -
                                -
                              • If you do a full search (with the option "all") former ghosts will show up -with the cursetype "unknown" because their ghostly flag is not set -anymore. But if you happen to find a living/active creature with cursetype -"unknown" please report that in the dfhack thread on the modding forum or -per irc. This is likely to happen with mods which introduce new types -of curses, for example.
                                • -
                              -
                              -
                              -
                              -
                              -

                              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.

                              +
                              +

                              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).

                              -
                              -

                              forcepause

                              -

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

                              -
                              +
                              +

                              feature

                              +

                              Enables management of map features.

                                -
                              • Activate with 'forcepause 1'
                                • -
                              • Deactivate with 'forcepause 0'
                                • +
                              • Discovering a magma feature (magma pool, volcano, magma sea, or curious +underground structure) permits magma workshops and furnaces to be built.
                                • +
                              • Discovering a cavern layer causes plants (trees, shrubs, and grass) from +that cavern to grow within your fortress.
                              -
                              -
                              -
                              -

                              nopause

                              -

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

                              -
                              -
                              -

                              die

                              -

                              Instantly kills DF without saving.

                              -
                              -
                              -

                              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.
                              list:Lists all map features in your current embark by index.
                              hidden:Only process hidden items.
                              show X:Marks the selected map feature as discovered.
                              forbidden:Only process forbidden items (default: only unforbidden).
                              hide X:Marks the selected map feature as undiscovered.
                              +
                              +
                              +

                              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. Settings will be remembered +as long as dfhack runs. Intended for use in combination with the command +liquids-here (which can be bound to a hotkey).

                              +

                              For more information, refer to the command's internal help.

                              +
                              +

                              Note

                              +

                              Spawning and deleting liquids can F up pathing data and +temperatures (creating heat traps). You've been warned.

                              -
                              -

                              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.

                              -
                              -

                              burrow

                              -

                              Miscellaneous burrow control. Allows manipulating burrows and automated burrow -expansion while digging.

                              -
                              -

                              Options

                              - --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                              enable feature ...:
                               
                              disable feature ...:
                               Enable or Disable features of the plugin.
                              clear-unit burrow burrow ...:
                               
                              clear-tiles burrow burrow ...:
                               Removes all units or tiles from the burrows.
                              set-units target-burrow src-burrow ...:
                               
                              add-units target-burrow src-burrow ...:
                               
                              remove-units target-burrow src-burrow ...:
                               Adds or removes units in source -burrows to/from the target burrow. Set is equivalent to clear and add.
                              set-tiles target-burrow src-burrow ...:
                               
                              add-tiles target-burrow src-burrow ...:
                               
                              remove-tiles target-burrow src-burrow ...:
                               Adds or removes tiles in source -burrows to/from the target burrow. In place of a source burrow it is -possible to use one of the following keywords: ABOVE_GROUND, -SUBTERRANEAN, INSIDE, OUTSIDE, LIGHT, DARK, HIDDEN, REVEALED
                              -
                              -
                              -

                              Features

                              - --- - - - -
                              auto-grow:When a wall inside a burrow with a name ending in '+' is dug -out, the burrow is extended to newly-revealed adjacent walls. -This final '+' may be omitted in burrow name args of commands above. -Digging 1-wide corridors with the miner inside the burrow is SLOW.
                              -
                              -
                              -
                              -

                              catsplosion

                              -

                              Makes cats just multiply. It is not a good idea to run this more than once or -twice.

                              -
                              -
                              -

                              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

                              - --- - - - - - - - -
                              map:Clean the map tiles. By default, it leaves mud and snow alone.
                              units:Clean the creatures. Will also clean hostiles.
                              items:Clean all the items. Even a poisoned blade.
                              -
                              -
                              -

                              Extra options for 'map'

                              - --- - - - - - -
                              mud:Remove mud in addition to the normal stuff.
                              snow:Also remove snow coverings.
                              -
                              -
                              -
                              -

                              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

                              -

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

                              -
                              -

                              Options

                              - --- - - - - - - - - - - - -
                              all:confiscate all owned items
                              scattered:confiscated and dump all items scattered on the floor
                              x:confiscate/dump items with wear level 'x' and more
                              X:confiscate/dump items with wear level 'X' and more
                              dryrun:a dry run. combine with other options to see what will happen -without it actually happening.
                              -
                              -
                              -

                              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

                              -

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

                              -
                              -

                              Options

                              - --- - - - -
                              bees:turn colonies into honey bee colonies
                              -
                              -
                              -
                              -

                              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).

                              -
                              -
                              -

                              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

                              -
                              -

                              Confirmed working DFusion plugins:

                              - --- - - - -
                              simple_embark:allows changing the number of dwarves available on embark.
                              -
                              -

                              Note

                              -
                                -
                              • Some of the DFusion plugins aren't completely ported yet. This can lead to crashes.
                                • -
                              • This is currently working only on Windows.
                                • -
                              • The game will be suspended while you're using dfusion. Don't panic when it doen't respond.
                                • -
                              -
                              -
                              -
                              -
                              -

                              drybuckets

                              -

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

                              -
                              -
                              -

                              fastdwarf

                              -

                              Makes your minions move at ludicrous speeds.

                              -
                              -
                                -
                              • Activate with 'fastdwarf 1'
                                • -
                              • Deactivate with 'fastdwarf 0'
                                • -
                              -
                              -
                              -
                              -

                              feature

                              -

                              Enables management of map features.

                              -
                                -
                              • Discovering a magma feature (magma pool, volcano, magma sea, or curious -underground structure) permits magma workshops and furnaces to be built.
                                • -
                              • Discovering a cavern layer causes plants (trees, shrubs, and grass) from -that cavern to grow within your fortress.
                                • -
                              -
                              -

                              Options

                              - --- - - - - - - - -
                              list:Lists all map features in your current embark by index.
                              show X:Marks the selected map feature as discovered.
                              hide X:Marks the selected map feature as undiscovered.
                              -
                              -
                              -
                              -

                              filltraffic

                              -

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

                              -
                              -

                              Traffic Type Codes:

                              - --- - - - - - - - - - -
                              H:High Traffic
                              N:Normal Traffic
                              L:Low Traffic
                              R:Restricted Traffic
                              -
                              -
                              -

                              Other Options:

                              - --- - - - - - - - -
                              X:Fill accross z-levels.
                              B:Include buildings and stockpiles.
                              P:Include empty space.
                              -
                              -
                              -

                              Example:

                              -

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

                              -
                              -
                              -
                              -

                              alltraffic

                              -

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

                              -
                              -

                              Traffic Type Codes:

                              - --- - - - - - - - - - -
                              H:High Traffic
                              N:Normal Traffic
                              L:Low Traffic
                              R:Restricted Traffic
                              -
                              -
                              -

                              Example:

                              -

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

                              -
                              -
                              -
                              -

                              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

                              -

                              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

                              -

                              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.

                              -
                              -
                              -

                              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

                              -

                              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

                              - --- - - - - - - - - - -
                              -t:Select trees only (exclude shrubs)
                              -s:Select shrubs only (exclude trees)
                              -c:Clear designations instead of setting them
                              -x:Apply selected action to all plants except those specified (invert -selection)
                              -

                              Specifying both -t and -s will have no effect. If no plant IDs are specified, -all valid plant IDs will be listed.

                              -
                              -
                              -
                              -

                              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.
                                • -
                              • In 'b' mode, during selection of building components positions the cursor -over the first available choice with the matching material.
                                • -
                              -
                              -
                              -
                              -
                              -

                              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.
                                • -
                              -
                              -
                              -
                              -
                              -

                              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. Settings will be remembered -as long as dfhack runs. Intended for use in combination with the command -liquids-here (which can be bound to a hotkey).

                              -

                              For more information, refer to the command's internal help.

                              -
                              -

                              Note

                              -

                              Spawning and deleting liquids can F up pathing data and -temperatures (creating heat traps). You've been warned.

                              -
                              -
                              -
                              -

                              liquids-here

                              -

                              Run the liquid spawner with the current/last settings made in liquids (if no -settings in liquids were made it paints a point of 7/7 magma by default).

                              -

                              Intended to be used as keybinding. Requires an active in-game cursor.

                              -
                              -
                              -

                              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.

                              -
                              -

                              Example

                              -

                              You are in fort game mode, managing your fortress and paused. -You switch to the arena game mode, assume control of a creature and then -switch to adventure game mode(1). -You just lost a fortress and gained an adventurer. -You could also do this. -You are in fort game mode, managing your fortress and paused at the esc menu. -You switch to the adventure game mode, then use Dfusion to assume control of a creature and then -save or retire. -You just created a returnable mountain home and gained an adventurer.

                              -
                              -

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

                              -
                              -
                              -

                              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.

                              -
                              -

                              Options

                              - --- - - - - - - - -
                              shrubs:affect all shrubs on the map
                              trees:affect all trees on the map
                              all:affect every plant!
                              -
                              -
                              -
                              -

                              grow

                              -

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

                              -
                              -
                              -

                              immolate

                              -

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

                              -
                              -
                              -

                              probe

                              -

                              Can be used to determine tile properties like temperature.

                              -
                              -
                              -

                              prospect

                              -

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

                              -
                              -

                              Options

                              - --- - - - - - - - -
                              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

                              - --- - - - -
                              all:processes all tiles, even hidden ones.
                              -
                              -
                              -
                              -

                              regrass

                              -

                              Regrows grass. Not much to it ;)

                              -
                              -
                              -

                              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.
                              rename building "name":
                               Set a custom name for the selected building. -The building must be one of stockpile, workshop, furnace, trap, -siege engine or an activity zone.
                              -
                              -
                              -
                              -

                              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'.

                              -

                              Reveal also works in adventure mode, but any of its effects are negated once -you move. When you use it this way, you don't need to run 'unreveal'.

                              -
                              -
                              -

                              unreveal

                              -

                              Reverts the effects of 'reveal'.

                              -
                              -
                              -

                              revtoggle

                              -

                              Switches between 'reveal' and 'unreveal'.

                              -
                              -
                              -

                              revflood

                              -

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

                              -
                              -
                              -

                              revforget

                              -

                              When you use reveal, it saves information about what was/wasn't visible before -revealing everything. Unreveal uses this information to hide things again. -This command throws away the information. For example, use in cases where -you abandoned with the fort revealed and no longer want the data.

                              -
                              -
                              -

                              lair

                              -

                              This command allows you to mark the map as 'monster lair', preventing item -scatter on abandon. When invoked as 'lair reset', it does the opposite.

                              -

                              Unlike reveal, this command doesn't save the information about tiles - you -won't be able to restore state of real monster lairs using 'lair reset'.

                              -
                              -

                              Options

                              - --- - - - - - -
                              lair:Mark the map as monster lair
                              lair reset:Mark the map as ordinary (not lair)
                              -
                              -
                              -
                              -

                              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 all items needed for the currently active strange mood.

                              -
                              -
                              -

                              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

                              -

                              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.

                              -

                              Older versions, support and extra graphics can be found in the bay12 forum -thread: http://www.bay12forums.com/smf/index.php?topic=43260.0

                              -

                              Some additional resources: -http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository

                              +
                              +

                              liquids-here

                              +

                              Run the liquid spawner with the current/last settings made in liquids (if no +settings in liquids were made it paints a point of 7/7 magma by default).

                              +

                              Intended to be used as keybinding. Requires an active in-game cursor.

                              -

                              tiletypes

                              +

                              tiletypes

                              Can be used for painting map tiles and is an interactive command, much like liquids.

                              The tool works with two set of options and a brush. The brush determines which @@ -1645,107 +1013,280 @@ up.

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

                              -

                              tiletypes-commands

                              +

                              tiletypes-commands

                              Runs tiletypes commands, separated by ;. This makes it possible to change tiletypes modes from a hotkey.

                              -

                              tiletypes-here

                              +

                              tiletypes-here

                              Apply the current tiletypes options at the in-game cursor position, including the brush. Can be used from a hotkey.

                              -

                              tiletypes-here-point

                              +

                              tiletypes-here-point

                              Apply the current tiletypes options at the in-game cursor position to a single tile. Can be used from a hotkey.

                              -
                              -

                              tweak

                              -

                              Contains various tweaks for minor bugs (currently just one).

                              -
                              -

                              Options

                              +
                              +

                              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).

                              +
                              +
                              +

                              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.

                              +

                              Options:

                              +
                              - + - + - + - + +
                              clear-missing:Remove the missing status from the selected unit. -This allows engraving slabs for ghostly, but not yet -found, creatures.
                              shrubs:affect all shrubs on the map
                              clear-ghostly:Remove the ghostly status from the selected unit and mark -it as dead. This allows getting rid of bugged ghosts -which do not show up in the engraving slab menu at all, -even after using clear-missing. It works, but is -potentially very dangerous - so use with care. Probably -(almost certainly) it does not have the same effects like -a proper burial. You've been warned.
                              trees:affect all trees on the map
                              fixmigrant:Remove the resident/merchant flag from the selected unit. -Intended to fix bugged migrants/traders who stay at the -map edge and don't enter your fort. Only works for -dwarves (or generally the player's race in modded games). -Do NOT abuse this for 'real' caravan merchants (if you -really want to kidnap them, use 'tweak makeown' instead, -otherwise they will have their clothes set to forbidden etc).
                              all:affect every plant!
                              makeown:Force selected unit to become a member of your fort. -Can be abused to grab caravan merchants and escorts, even if -they don't belong to the player's race. Foreign sentients -(humans, elves) can be put to work, but you can't assign rooms -to them and they don't show up in DwarfTherapist because the -game treats them like pets. Grabbing draft animals from -a caravan can result in weirdness (animals go insane or berserk -and are not flagged as tame), but you are allowed to mark them -for slaughter. Grabbing wagons results in some funny spam, then -they are scuttled.
                              +
                              +
                              +
                              +

                              grow

                              +

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

                              +
                              +
                              +

                              immolate

                              +

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

                              +
                              +
                              +

                              regrass

                              +

                              Regrows grass. Not much to it ;)

                              +
                              +
                              +

                              weather

                              +

                              Prints the current weather map by default.

                              +

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

                              +

                              Options:

                              +
                              + +++ + - + - + - - + +
                              snow:make it snow everywhere.
                              stable-cursor:Saves the exact cursor position between t/q/k/d/etc menus of dwarfmode.
                              rain:make it rain.
                              patrol-duty:Makes Train orders not count as patrol duty to stop unhappy thoughts. -Does NOT fix the problem when soldiers go off-duty (i.e. civilian).
                              clear:clear the sky.
                              readable-build-plate:
                               Fixes rendering of creature weight limits in pressure plate build menu.
                              +
                              +
                              +
                              +
                              +

                              Map inspection

                              +
                              +

                              cursecheck

                              +

                              Checks a single map tile or the whole map/world for cursed creatures (ghosts, +vampires, necromancers, werebeasts, zombies).

                              +

                              With an active in-game cursor only the selected tile will be observed. +Without a cursor the whole map will be checked.

                              +

                              By default cursed creatures will be only counted in case you just want to find +out if you have any of them running around in your fort. Dead and passive +creatures (ghosts who were put to rest, killed vampires, ...) are ignored. +Undead skeletons, corpses, bodyparts and the like are all thrown into the curse +category "zombie". Anonymous zombies and resurrected body parts will show +as "unnamed creature".

                              +

                              Options:

                              +
                              + +++ + - + - + - + - - + +
                              detail:Print full name, date of birth, date of curse and some status +info (some vampires might use fake identities in-game, though).
                              stable-temp:Fixes performance bug 6012 by squashing jitter in temperature updates. -In very item-heavy forts with big stockpiles this can improve FPS by 50-100%
                              nick:Set the type of curse as nickname (does not always show up +in-game, some vamps don't like nicknames).
                              fast-heat:Further improves temperature update performance by ensuring that 1 degree -of item temperature is crossed in no more than specified number of frames -when updating from the environment temperature. This reduces the time it -takes for stable-temp to stop updates again when equilibrium is disturbed.
                              all:Include dead and passive cursed creatures (can result in a quite +long list after having FUN with necromancers).
                              fix-dimensions:Fixes subtracting small amount of thread/cloth/liquid from a stack -by splitting the stack and subtracting from the remaining single item. -This is a necessary addition to the binary patch in bug 808.
                              verbose:Print all curse tags (if you really want to know it all).
                              advmode-contained:
                               Works around bug 6202, i.e. custom reactions with container inputs -in advmode. The issue is that the screen tries to force you to select -the contents separately from the container. This forcefully skips child -reagents.
                              +
                              +

                              Examples:

                              +
                              +
                              +
                              cursecheck detail all
                              +
                              Give detailed info about all cursed creatures including deceased ones (no +in-game cursor).
                              +
                              cursecheck nick
                              +
                              Give a nickname all living/active cursed creatures on the map(no in-game +cursor).
                              +
                              +
                              +
                              +

                              Note

                              +
                                +
                              • If you do a full search (with the option "all") former ghosts will show up +with the cursetype "unknown" because their ghostly flag is not set +anymore. But if you happen to find a living/active creature with cursetype +"unknown" please report that in the dfhack thread on the modding forum or +per irc. This is likely to happen with mods which introduce new types +of curses, for example.
                                • +
                              +
                              +
                              +
                              +

                              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.

                              +
                              +
                              +

                              probe

                              +

                              Can be used to determine tile properties like temperature.

                              +
                              +
                              +

                              prospect

                              +

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

                              +

                              Options:

                              +
                              + +++ + + + + + + + +
                              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:

                              +
                              + +++ + + + +
                              all:processes all tiles, even hidden ones.
                              +
                              +
                              +
                              +
                              +

                              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'.

                              +

                              Reveal also works in adventure mode, but any of its effects are negated once +you move. When you use it this way, you don't need to run 'unreveal'.

                              +
                              +
                              +

                              unreveal

                              +

                              Reverts the effects of 'reveal'.

                              +
                              +
                              +

                              revtoggle

                              +

                              Switches between 'reveal' and 'unreveal'.

                              +
                              +
                              +

                              revflood

                              +

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

                              +
                              +
                              +

                              revforget

                              +

                              When you use reveal, it saves information about what was/wasn't visible before +revealing everything. Unreveal uses this information to hide things again. +This command throws away the information. For example, use in cases where +you abandoned with the fort revealed and no longer want the data.

                              +
                              +
                              +

                              showmood

                              +

                              Shows all items needed for the currently active strange mood.

                              +
                              +
                              +
                              +

                              Designations

                              +
                              +

                              burrow

                              +

                              Miscellaneous burrow control. Allows manipulating burrows and automated burrow +expansion while digging.

                              +

                              Options:

                              +
                              +
                              +
                              enable feature ...
                              +
                              Enable features of the plugin.
                              +
                              disable feature ...
                              +
                              Disable features of the plugin.
                              +
                              clear-unit burrow burrow ...
                              +
                              Remove all units from the burrows.
                              +
                              clear-tiles burrow burrow ...
                              +
                              Remove all tiles from the burrows.
                              +
                              set-units target-burrow src-burrow ...
                              +
                              Clear target, and adds units from source burrows.
                              +
                              add-units target-burrow src-burrow ...
                              +
                              Add units from the source burrows to the target.
                              +
                              remove-units target-burrow src-burrow ...
                              +
                              Remove units in source burrows from the target.
                              +
                              set-tiles target-burrow src-burrow ...
                              +
                              Clear target and adds tiles from the source burrows.
                              +
                              add-tiles target-burrow src-burrow ...
                              +
                              Add tiles from the source burrows to the target.
                              +
                              remove-tiles target-burrow src-burrow ...
                              +

                              Remove tiles in source burrows from the target.

                              +

                              For these three options, in place of a source burrow it is +possible to use one of the following keywords: ABOVE_GROUND, +SUBTERRANEAN, INSIDE, OUTSIDE, LIGHT, DARK, HIDDEN, REVEALED

                              +
                              +
                              +
                              +

                              Features:

                              +
                              + +++ +
                              auto-grow:When a wall inside a burrow with a name ending in '+' is dug +out, the burrow is extended to newly-revealed adjacent walls. +This final '+' may be omitted in burrow name args of commands above. +Digging 1-wide corridors with the miner inside the burrow is SLOW.
                              -
                              -
                              -
                              -

                              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).

                              +
                              -

                              digv

                              +

                              digv

                              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).

                              -

                              digvx

                              +

                              digvx

                              A permanent alias for 'digv x'.

                              -

                              digl

                              +

                              digl

                              Designates layer stone for digging. Requires an active in-game cursor placed over a layer stone tile. With the 'x' option, it will traverse z-levels (putting stairs between the same-material tiles). With the 'undo' option it @@ -1753,16 +1294,16 @@ will remove the dig designation instead (if you realize that digging out a 50 z-level deep layer was not such a good idea after all).

                              -

                              diglx

                              +

                              diglx

                              A permanent alias for 'digl x'.

                              -

                              digexp

                              +

                              digexp

                              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:

                              +
                              @@ -1781,9 +1322,9 @@ z-level deep layer was not such a good idea after all).

                              -
                              -
                              -

                              Filters:

                              + +

                              Filters:

                              +
                              @@ -1796,10 +1337,10 @@ z-level deep layer was not such a good idea after all).

                              +

                              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:
                                @@ -1817,14 +1358,14 @@ z-level deep layer was not such a good idea after all).

                              -
                              +
                              -

                              digcircle

                              +

                              digcircle

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

                              -
                              -

                              Shape:

                              +

                              Shape:

                              +
                              @@ -1837,78 +1378,470 @@ It has several types of options.

                              +
                              +

                              Action:

                              +
                              + +++ + + + + + + + +
                              set:Set designation (default)
                              unset:Unset current designation
                              invert:Invert designations already present
                              +
                              +

                              Designation types:

                              +
                              + +++ + + + + + + + + + + + + + +
                              dig:Normal digging designation (default)
                              ramp:Ramp digging
                              ustair:Staircase up
                              dstair:Staircase down
                              xstair:Staircase up/down
                              chan:Dig channel
                              +
                              +

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

                              +

                              Examples:

                              +
                                +
                              • 'digcircle filled 3' = Dig a filled circle with radius = 3.
                                • +
                              • 'digcircle' = Do it again.
                                • +
                              +
                              +
                              +

                              filltraffic

                              +

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

                              +

                              Traffic Type Codes:

                              +
                              + +++ + + + + + + + + + +
                              H:High Traffic
                              N:Normal Traffic
                              L:Low Traffic
                              R:Restricted Traffic
                              +
                              +

                              Other Options:

                              +
                              + +++ + + + + + + + +
                              X:Fill accross z-levels.
                              B:Include buildings and stockpiles.
                              P:Include empty space.
                              +
                              +

                              Example:

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

                              alltraffic

                              +

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

                              +

                              Traffic Type Codes:

                              +
                              + +++ + + + + + + + + + +
                              H:High Traffic
                              N:Normal Traffic
                              L:Low Traffic
                              R:Restricted Traffic
                              +
                              +

                              Example:

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

                              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:

                              +
                              + +++ + + + + + + + + + +
                              -t:Select trees only (exclude shrubs)
                              -s:Select shrubs only (exclude trees)
                              -c:Clear designations instead of setting them
                              -x:Apply selected action to all plants except those specified (invert +selection)
                              +
                              +

                              Specifying both -t and -s will have no effect. If no plant IDs are specified, +all valid plant IDs will be listed.

                              +
                              +
                              +
                              +

                              Cleanup and garbage disposal

                              +
                              +

                              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:

                              +
                              + +++ + + + + + + + +
                              map:Clean the map tiles. By default, it leaves mud and snow alone.
                              units:Clean the creatures. Will also clean hostiles.
                              items:Clean all the items. Even a poisoned blade.
                              +
                              +

                              Extra options for 'map':

                              +
                              + +++ + + + + + +
                              mud:Remove mud in addition to the normal stuff.
                              snow:Also remove snow coverings.
                              +
                              +
                              +
                              +

                              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.

                              +
                              +
                              +

                              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:

                              +
                              + +++ + + + + + + + + + + + +
                              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.

                              +
                              +
                              +

                              cleanowned

                              +

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

                              +

                              Options:

                              +
                              + +++ + + + + + + + + + + + +
                              all:confiscate all owned items
                              scattered:confiscated and dump all items scattered on the floor
                              x:confiscate/dump items with wear level 'x' and more
                              X:confiscate/dump items with wear level 'X' and more
                              dryrun:a dry run. combine with other options to see what will happen +without it actually happening.
                              +
                              +

                              Example:

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

                              Bugfixes

                              +
                              +

                              drybuckets

                              +

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

                              +
                              +
                              +

                              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

                              +

                              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

                              +

                              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.

                              -
                              -

                              Action:

                              +
                              +

                              tweak

                              +

                              Contains various tweaks for minor bugs (currently just one).

                              +

                              Options:

                              - + - + - + - -
                              set:Set designation (default)
                              clear-missing:Remove the missing status from the selected unit. +This allows engraving slabs for ghostly, but not yet +found, creatures.
                              unset:Unset current designation
                              clear-ghostly:Remove the ghostly status from the selected unit and mark +it as dead. This allows getting rid of bugged ghosts +which do not show up in the engraving slab menu at all, +even after using clear-missing. It works, but is +potentially very dangerous - so use with care. Probably +(almost certainly) it does not have the same effects like +a proper burial. You've been warned.
                              invert:Invert designations already present
                              fixmigrant:Remove the resident/merchant flag from the selected unit. +Intended to fix bugged migrants/traders who stay at the +map edge and don't enter your fort. Only works for +dwarves (or generally the player's race in modded games). +Do NOT abuse this for 'real' caravan merchants (if you +really want to kidnap them, use 'tweak makeown' instead, +otherwise they will have their clothes set to forbidden etc).
                              -
                              -
                              -

                              Designation types:

                              - --- - + - + - + - + + - + - + + + + + +
                              dig:Normal digging designation (default)
                              makeown:Force selected unit to become a member of your fort. +Can be abused to grab caravan merchants and escorts, even if +they don't belong to the player's race. Foreign sentients +(humans, elves) can be put to work, but you can't assign rooms +to them and they don't show up in DwarfTherapist because the +game treats them like pets. Grabbing draft animals from +a caravan can result in weirdness (animals go insane or berserk +and are not flagged as tame), but you are allowed to mark them +for slaughter. Grabbing wagons results in some funny spam, then +they are scuttled.
                              ramp:Ramp digging
                              stable-cursor:Saves the exact cursor position between t/q/k/d/etc menus of dwarfmode.
                              ustair:Staircase up
                              patrol-duty:Makes Train orders not count as patrol duty to stop unhappy thoughts. +Does NOT fix the problem when soldiers go off-duty (i.e. civilian).
                              dstair:Staircase down
                              readable-build-plate:
                               Fixes rendering of creature weight limits in pressure plate build menu.
                              xstair:Staircase up/down
                              stable-temp:Fixes performance bug 6012 by squashing jitter in temperature updates. +In very item-heavy forts with big stockpiles this can improve FPS by 50-100%
                              chan:Dig channel
                              fast-heat:Further improves temperature update performance by ensuring that 1 degree +of item temperature is crossed in no more than specified number of frames +when updating from the environment temperature. This reduces the time it +takes for stable-temp to stop updates again when equilibrium is disturbed.
                              fix-dimensions:Fixes subtracting small amount of thread/cloth/liquid from a stack +by splitting the stack and subtracting from the remaining single item. +This is a necessary addition to the binary patch in bug 808.
                              advmode-contained:
                               Works around bug 6202, i.e. custom reactions with container inputs +in advmode. The issue is that the screen tries to force you to select +the contents separately from the container. This forcefully skips child +reagents.
                              -

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

                              -
                              -

                              Examples:

                              -
                                -
                              • 'digcircle filled 3' = Dig a filled circle with radius = 3.
                                • -
                              • 'digcircle' = Do it again.
                                • -
                              -
                              -
                              -

                              weather

                              -

                              Prints the current weather map by default.

                              -

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

                              -
                              -

                              Options:

                              +
                              +

                              Mode switch and reclaim

                              +
                              +

                              lair

                              +

                              This command allows you to mark the map as 'monster lair', preventing item +scatter on abandon. When invoked as 'lair reset', it does the opposite.

                              +

                              Unlike reveal, this command doesn't save the information about tiles - you +won't be able to restore state of real monster lairs using 'lair reset'.

                              +

                              Options:

                              +
                              - - - + - +
                              snow:make it snow everywhere.
                              rain:make it rain.
                              lair:Mark the map as monster lair
                              clear:clear the sky.
                              lair reset:Mark the map as ordinary (not lair)
                              +
                              +
                              +
                              +

                              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.

                              +
                              +

                              Example

                              +

                              You are in fort game mode, managing your fortress and paused. +You switch to the arena game mode, assume control of a creature and then +switch to adventure game mode(1). +You just lost a fortress and gained an adventurer. +You could also do this. +You are in fort game mode, managing your fortress and paused at the esc menu. +You switch to the adventure game mode, then use Dfusion to assume control of a creature and then +save or retire. +You just created a returnable mountain home and gained an adventurer.

                              +
                              +

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

                              +
                              +
                              +
                              +

                              Visualizer and data export

                              +
                              +

                              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.

                              +

                              Older versions, support and extra graphics can be found in the bay12 forum +thread: http://www.bay12forums.com/smf/index.php?topic=43260.0

                              +

                              Some additional resources: +http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository

                              +
                              +
                              +

                              mapexport

                              +

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

                              +

                              dwarfexport +----------= +Export dwarves to RuneSmith-compatible XML.

                              +
                              +
                              +
                              +

                              Job management

                              +
                              +

                              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.
                                • +
                              • In 'b' mode, during selection of building components positions the cursor +over the first available choice with the matching material.
                                • +
                              +
                              +
                              +

                              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.
                                • +
                              +
                              +
                              -

                              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. @@ -1927,9 +1860,9 @@ Otherwise, enables or disables any of the following options:

                              workflow unlimit <constraint-spec>
                              Delete a constraint.
                              -
                              +
                              -

                              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.

                              @@ -1940,7 +1873,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
@@ -1977,20 +1910,20 @@ command.
                              -
                              -

                              mapexport

                              -

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

                              -
                              -

                              dwarfexport

                              -

                              Export dwarves to RuneSmith-compatible XML.

                              +
                              +

                              Fortress activity management

                              +
                              +

                              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.

                              -

                              zone

                              +

                              zone

                              Helps a bit with managing activity zones (pens, pastures and pits) and cages.

                              -
                              -

                              Options:

                              +

                              Options:

                              +
                              @@ -2027,9 +1960,9 @@ the cursor are listed.
                              -
                              -
                              -

                              Filters:

                              + +

                              Filters:

                              +
                              @@ -2084,9 +2017,9 @@ for war/hunt). Negatable.
                              -
                              +
                              -

                              Usage with single units

                              +

                              Usage with single units

                              One convenient way to use the zone tool is to bind the command 'zone assign' to a hotkey, maybe also the command 'zone set'. Place the in-game cursor over a pen/pasture or pit, use 'zone set' to mark it. Then you can select units @@ -2095,7 +2028,7 @@ and use 'zone assign' to assign them to their new home. Allows pitting your own dwarves, by the way.

                              -

                              Usage with filters

                              +

                              Usage with filters

                              All filters can be used together with the 'assign' command.

                              Restrictions: It's not possible to assign units who are inside built cages or chained because in most cases that won't be desirable anyways. @@ -2113,14 +2046,14 @@ are not properly added to your own stocks; slaughtering them should work).

                              Most filters can be negated (e.g. 'not grazer' -> race is not a grazer).

                              -

                              Mass-renaming

                              +

                              Mass-renaming

                              Using the 'nick' command you can set the same nickname for multiple units. If used without 'assign', 'all' or 'count' it will rename all units in the current default target zone. Combined with 'assign', 'all' or 'count' (and further optional filters) it will rename units matching the filter conditions.

                              -

                              Cage zones

                              +

                              Cage zones

                              Using the 'tocages' command you can assign units to a set of cages, for example a room next to your butcher shop(s). They will be spread evenly among available cages to optimize hauling to and butchering from them. For this to work you need @@ -2130,8 +2063,8 @@ all cages you want to use. Then use 'zone set' (like with 'assign') and use would make no sense, but can be used together with 'nick' or 'remnick' and all the usual filters.

                              -
                              -

                              Examples

                              +
                              +

                              Examples

                              zone assign all own ALPACA minage 3 maxage 10
                              Assign all own alpacas who are between 3 and 10 years old to the selected @@ -2157,7 +2090,7 @@ on the current default zone.
                              -

                              autonestbox

                              +

                              autonestbox

                              Assigns unpastured female egg-layers to nestbox zones. Requires that you create pen/pasture zones above nestboxes. If the pen is bigger than 1x1 the nestbox must be in the top left corner. Only 1 unit will be assigned per pen, regardless @@ -2167,8 +2100,8 @@ to a 1x1 pasture is not a good idea. Only tame and domesticated own units are processed since pasturing half-trained wild egglayers could destroy your neat nestbox zones when they revert to wild. When called without options autonestbox will instantly run once.

                              -
                              -

                              Options:

                              +

                              Options:

                              +
                              @@ -2183,10 +2116,10 @@ frames between runs.
                              -
                              +
                              -

                              autobutcher

                              +

                              autobutcher

                              Assigns lifestock for slaughter once it reaches a specific count. Requires that you add the target race(s) to a watch list. Only tame units will be processed.

                              Named units will be completely ignored (to protect specific animals from @@ -2199,8 +2132,8 @@ units or with 'zone nick' to mass-rename units in pastures and cages).

                              Once you have too much kids, the youngest will be butchered first. If you don't set any target count the following default will be used: 1 male kid, 5 female kids, 1 male adult, 5 female adults.

                              -
                              -

                              Options:

                              +

                              Options:

                              +
                              @@ -2251,9 +2184,8 @@ for future entries.
                              -
                              -
                              -

                              Examples:

                              + +

                              Examples:

                              You want to keep max 7 kids (4 female, 3 male) and max 3 adults (2 female, 1 male) of the race alpaca. Once the kids grow up the oldest adults will get slaughtered. Excess kids will get slaughtered starting with the youngest @@ -2282,9 +2214,7 @@ add some new races with 'watch'. If you simply want to stop it completely use 

                               autobutcher unwatch ALPACA CAT
                              -
                              -
                              -

                              Note:

                              +

                              Note:

                              Settings and watchlist are stored in the savegame, so that you can have different settings for each world. If you want to copy your watchlist to another savegame you can use the command list_export:

                              @@ -2296,9 +2226,8 @@ Load the savegame where you want to copy the settings to, run the batch file (fr autobutcher.bat
                              -
                              -

                              autolabor

                              +

                              autolabor

                              Automatically manage dwarf labors.

                              When enabled, autolabor periodically checks your dwarves and enables or disables labors. It tries to keep as many dwarves as possible busy but @@ -2311,8 +2240,39 @@ while it is enabled.

                              For detailed usage information, see 'help autolabor'.

                              +
                              +

                              Other

                              +
                              +

                              catsplosion

                              +

                              Makes cats just multiply. It is not a good idea to run this more than once or +twice.

                              +
                              +
                              +

                              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

                              +

                              Confirmed working DFusion plugins:

                              + +++ + + + +
                              simple_embark:allows changing the number of dwarves available on embark.
                              +
                              +

                              Note

                              +
                                +
                              • Some of the DFusion plugins aren't completely ported yet. This can lead to crashes.
                                • +
                              • This is currently working only on Windows.
                                • +
                              • The game will be suspended while you're using dfusion. Don't panic when it doen't respond.
                                • +
                              +
                              +
                              +
                              +
                              -

                              Scripts

                              +

                              Scripts

                              Lua or ruby scripts placed in the hack/scripts/ directory are considered for execution as if they were native DFHack commands. They are listed at the end of the 'ls' command output.

                              @@ -2320,18 +2280,8 @@ of the 'ls' command output.

                              only be listed by ls if called as 'ls -a'. This is intended as a way to hide scripts that are obscure, developer-oriented, or should be used as keybindings.

                              Some notable scripts:

                              -
                              -

                              quicksave

                              -

                              If called in dwarf mode, makes DF immediately auto-save the game by setting a flag -normally used in seasonal auto-save.

                              -
                              -
                              -

                              setfps

                              -

                              Run setfps <number> to set the FPS cap at runtime, in case you want to watch -combat in slow motion or something :)

                              -
                              -

                              fix/*

                              +

                              fix/*

                              Scripts in this subdirectory fix various bugs and issues, some of them obscure.

                              • fix/dead-units

                                @@ -2357,12 +2307,22 @@ caused by autodump bugs or other hacking mishaps.

                              -

                              gui/*

                              +

                              gui/*

                              Scripts that implement dialogs inserted into the main game window are put in this directory.

                              +
                              +

                              quicksave

                              +

                              If called in dwarf mode, makes DF immediately auto-save the game by setting a flag +normally used in seasonal auto-save.

                              +
                              +
                              +

                              setfps

                              +

                              Run setfps <number> to set the FPS cap at runtime, in case you want to watch +combat in slow motion or something :)

                              +
                              -

                              growcrops

                              +

                              growcrops

                              Instantly grow seeds inside farming plots.

                              With no argument, this command list the various seed types currently in use in your farming plots. @@ -2374,7 +2334,7 @@ growcrops plump 40

                              -

                              removebadthoughts

                              +

                              removebadthoughts

                              This script remove negative thoughts from your dwarves. Very useful against tantrum spirals.

                              With a selected unit in 'v' mode, will clear this unit's mind, otherwise @@ -2387,7 +2347,7 @@ you unpause.

                              it removed.

                              -

                              slayrace

                              +

                              slayrace

                              Kills any unit of a given race.

                              With no argument, lists the available races.

                              With the special argument 'him', targets only the selected creature.

                              @@ -2413,7 +2373,7 @@ slayrace elve magma
                              -

                              magmasource

                              +

                              magmasource

                              Create an infinite magma source on a tile.

                              This script registers a map tile as a magma source, and every 12 game ticks that tile receives 1 new unit of flowing magma.

                              @@ -2429,11 +2389,11 @@ To remove all placed sources, call magmasource stop
                              -

                              In-game interface tools

                              +

                              In-game interface tools

                              These tools work by displaying dialogs or overlays in the game window, and are mostly implemented by lua scripts.

                              -

                              Dwarf Manipulator

                              +

                              Dwarf Manipulator

                              Implemented by the manipulator plugin. To activate, open the unit screen and press 'l'.

                              This tool implements a Dwarf Therapist-like interface within the game UI. The @@ -2467,14 +2427,14 @@ cursor onto that cell instead of toggling it.

                              Pressing ESC normally returns to the unit screen, but Shift-ESC would exit directly to the main dwarf mode screen.

                              -
                              -

                              Liquids

                              +
                              +

                              Liquids

                              Implemented by the gui/liquids script. To use, bind to a key and activate in the 'k' mode.

                              While active, use the suggested keys to switch the usual liquids parameters, and Enter to select the target area and apply changes.

                              -

                              Mechanisms

                              +

                              Mechanisms

                              Implemented by the gui/mechanims script. To use, bind to a key and activate in the 'q' mode.

                              Lists mechanisms connected to the building, and their links. Navigating the list centers the view on the relevant linked buildings.

                              @@ -2483,14 +2443,14 @@ focus on the current one. Shift-Enter has an effect equivalent to pressing Enter re-entering the mechanisms ui.

                              -

                              Power Meter

                              +

                              Power Meter

                              Front-end to the power-meter plugin implemented by the gui/power-meter script. Bind to a key and activate after selecting Pressure Plate in the build menu.

                              The script follows the general look and feel of the regular pressure plate build configuration page, but configures parameters relevant to the modded power meter building.

                              -
                              -

                              Rename

                              +
                              +

                              Rename

                              Backed by the rename plugin, the gui/rename script allows entering the desired name via a simple dialog in the game ui.

                                @@ -2506,14 +2466,14 @@ It is also possible to rename zones from the 'i' menu.

                                The building or unit are automatically assumed when in relevant ui state.

                              -

                              Room List

                              +

                              Room List

                              Implemented by the gui/room-list script. To use, bind to a key and activate in the 'q' mode, either immediately or after opening the assign owner page.

                              The script lists other rooms owned by the same owner, or by the unit selected in the assign list, and allows unassigning them.

                              -

                              Siege Engine

                              +

                              Siege Engine

                              Front-end to the siege-engine plugin implemented by the gui/siege-engine script. Bind to a key and activate after selecting a siege engine in 'q' mode.

                              The main mode displays the current target, selected ammo item type, linked stockpiles and @@ -2530,21 +2490,24 @@ DF, or select another area manually.

                              Exiting from the siege engine script via ESC reverts the view to the state prior to starting the script. Shift-ESC retains the current viewport, and also exits from the 'q' mode to main menu.

                              -

                              DISCLAIMER: Siege engines are a very interesting feature, but currently nearly useless +

                              +

                              DISCLAIMER

                              +

                              Siege engines are a very interesting feature, but currently nearly useless 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.

                              +
                              -

                              RAW hacks

                              +

                              RAW hacks

                              These plugins detect certain structures in RAWs, and enhance them in various ways.

                              -

                              Steam Engine

                              +

                              Steam Engine

                              The steam-engine plugin detects custom workshops with STEAM_ENGINE in their token, and turns them into real steam engines.

                              -

                              Rationale

                              +

                              Rationale

                              The vanilla game contains only water wheels and windmills as sources of power, but windmills give relatively little power, and water wheels require flowing water, which must either be a real river and thus immovable and @@ -2555,25 +2518,31 @@ it can be done just by combining existing features of the game engine in a new way with some glue code and a bit of custom logic.

                              -

                              Construction

                              +

                              Construction

                              The workshop needs water as its input, which it takes via a passable floor tile below it, like usual magma workshops do. The magma version also needs magma.

                              -

                              ISSUE: Since this building is a machine, and machine collapse +

                              +

                              ISSUE

                              +

                              Since this building is a machine, and machine collapse code cannot be modified, it would collapse over true open space. As a loophole, down stair provides support to machines, while being passable, so use them.

                              +

                              After constructing the building itself, machines can be connected to the edge tiles that look like gear boxes. Their exact position is extracted from the workshop raws.

                              -

                              ISSUE: Like with collapse above, part of the code involved in +

                              +

                              ISSUE

                              +

                              Like with collapse above, part of the code involved in machine connection cannot be modified. As a result, the workshop can only immediately connect to machine components built AFTER it. This also means that engines cannot be chained without intermediate short axles that can be built later than both of the engines.

                              +
                              -

                              Operation

                              +

                              Operation

                              In order to operate the engine, queue the Stoke Boiler job (optionally on repeat). A furnace operator will come, possibly bringing a bar of fuel, and perform it. As a result, a "boiling water" item will appear @@ -2598,7 +2567,7 @@ decrease it by further 4%, and also decrease the whole steam use rate by 10%.

                              -

                              Explosions

                              +

                              Explosions

                              The engine must be constructed using barrel, pipe and piston from fire-safe, or in the magma version magma-safe metals.

                              During operation weak parts get gradually worn out, and @@ -2607,7 +2576,7 @@ toppled during operation by a building destroyer, or a tantruming dwarf.

                              -

                              Save files

                              +

                              Save files

                              It should be safe to load and view engine-using fortresses from a DF version without DFHack installed, except that in such case the engines won't work. However actually making modifications @@ -2618,7 +2587,7 @@ being generated.

                              -

                              Add Spatter

                              +

                              Add Spatter

                              This plugin makes reactions with names starting with SPATTER_ADD_ produce contaminants on the items instead of improvements.

                              Intended to give some use to all those poisons that can be bought from caravans.

                              From 7a06c949c7d3404dc78f7a5d3c561eb2d3023e2f Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Fri, 21 Sep 2012 15:21:04 +0400 Subject: [PATCH 14/18] Document the lua class module. --- LUA_API.rst | 80 ++++++++++++++++++++++++++++++++++++++++++++++ Lua API.html | 89 +++++++++++++++++++++++++++++++++++++++++++++++----- 2 files changed, 161 insertions(+), 8 deletions(-) diff --git a/LUA_API.rst b/LUA_API.rst index d9b75c480..b098aa054 100644 --- a/LUA_API.rst +++ b/LUA_API.rst @@ -1831,6 +1831,86 @@ function: argument specifies the indentation step size in spaces. For the other arguments see the original documentation link above. +class +===== + +Implements a trivial single-inheritance class system. + +* ``Foo = defclass(Foo[, ParentClass])`` + + Defines or updates class Foo. The ``Foo = defclass(Foo)`` syntax + is needed so that when the module or script is reloaded, the + class identity will be preserved through the preservation of + global variable values. + + The ``defclass`` function is defined as a stub in the global + namespace, and using it will auto-load the class module. + +* ``Class.super`` + + This class field is set by defclass to the parent class, and + allows a readable ``Class.super.method(self, ...)`` syntax for + calling superclass methods. + +* ``Class.ATTRS { foo = xxx, bar = yyy }`` + + Declares certain instance fields to be attributes, i.e. auto-initialized + from fields in the table used as the constructor argument. If omitted, + they are initialized with the default values specified in this declaration. + + If the default value should be *nil*, use ``ATTRS { foo = DEFAULT_NIL }``. + +* ``new_obj = Class{ foo = arg, bar = arg, ... }`` + + Calling the class as a function creates and initializes a new instance. + Initialization happens in this order: + + 1. An empty instance table is created, and its metatable set. + 2. The ``preinit`` method is called via ``invoke_before`` (see below) + with the table used as argument to the class. This method is intended + for validating and tweaking that argument table. + 3. Declared ATTRS are initialized from the argument table or their default values. + 4. The ``init`` method is called via ``invoke_after`` with the argument table. + This is the main constructor method. + 5. The ``postinit`` method is called via ``invoke_after`` with the argument table. + Place code that should be called after the object is fully constructed here. + +Predefined instance methods: + +* ``instance:assign{ foo = xxx }`` + + Assigns all values in the input table to the matching instance fields. + +* ``instance:callback(method_name, [args...])`` + + Returns a closure that invokes the specified method of the class, + properly passing in self, and optionally a number of initial arguments too. + The arguments given to the closure are appended to these. + +* ``instance:invoke_before(method_name, args...)`` + + Navigates the inheritance chain of the instance starting from the most specific + class, and invokes the specified method with the arguments if it is defined in + that specific class. Equivalent to the following definition in every class:: + + function Class:invoke_before(method, ...) + if rawget(Class, method) then + rawget(Class, method)(self, ...) + end + Class.super.invoke_before(method, ...) + end + +* ``instance:invoke_after(method_name, args...)`` + + Like invoke_before, only the method is called after the recursive call to super, + i.e. invocations happen in the parent to child order. + + These two methods are inspired by the Common Lisp before and after methods, and + are intended for implementing similar protocols for certain things. The class + library itself uses them for constructors. + +To avoid confusion, these methods cannot be redefined. + ======= Plugins diff --git a/Lua API.html b/Lua API.html index 0da65b5fb..f30bb6ec5 100644 --- a/Lua API.html +++ b/Lua API.html @@ -366,14 +366,15 @@ ul.auto-toc {
                            • Global environment
                            • utils
                            • dumper
                              • +
                            • class
                            • -
                          • Plugins

                            The current version of DFHack has extensive support for @@ -1930,16 +1931,88 @@ the other arguments see the original documentation link above.

                          +
                          +

                          class

                          +

                          Implements a trivial single-inheritance class system.

                          +
                            +

                          • Foo = defclass(Foo[, ParentClass])

                            +

                            Defines or updates class Foo. The Foo = defclass(Foo) syntax +is needed so that when the module or script is reloaded, the +class identity will be preserved through the preservation of +global variable values.

                            +

                            The defclass function is defined as a stub in the global +namespace, and using it will auto-load the class module.

                            +
                            • +

                          • Class.super

                            +

                            This class field is set by defclass to the parent class, and +allows a readable Class.super.method(self, ...) syntax for +calling superclass methods.

                            +
                            • +

                          • Class.ATTRS { foo = xxx, bar = yyy }

                            +

                            Declares certain instance fields to be attributes, i.e. auto-initialized +from fields in the table used as the constructor argument. If omitted, +they are initialized with the default values specified in this declaration.

                            +

                            If the default value should be nil, use ATTRS { foo = DEFAULT_NIL }.

                            +
                            • +

                          • new_obj = Class{ foo = arg, bar = arg, ... }

                            +

                            Calling the class as a function creates and initializes a new instance. +Initialization happens in this order:

                            +
                              +
                            1. An empty instance table is created, and its metatable set.
                              2. +
                            2. The preinit method is called via invoke_before (see below) +with the table used as argument to the class. This method is intended +for validating and tweaking that argument table.
                              3. +
                            3. Declared ATTRS are initialized from the argument table or their default values.
                              4. +
                            4. The init method is called via invoke_after with the argument table. +This is the main constructor method.
                              5. +
                            5. The postinit method is called via invoke_after with the argument table. +Place code that should be called after the object is fully constructed here.
                              6. +
                            +
                            • +
                          +

                          Predefined instance methods:

                          +
                            +

                          • instance:assign{ foo = xxx }

                            +

                            Assigns all values in the input table to the matching instance fields.

                            +
                            • +

                          • instance:callback(method_name, [args...])

                            +

                            Returns a closure that invokes the specified method of the class, +properly passing in self, and optionally a number of initial arguments too. +The arguments given to the closure are appended to these.

                            +
                            • +

                          • instance:invoke_before(method_name, args...)

                            +

                            Navigates the inheritance chain of the instance starting from the most specific +class, and invokes the specified method with the arguments if it is defined in +that specific class. Equivalent to the following definition in every class:

                            +
                            +function Class:invoke_before(method, ...)
+  if rawget(Class, method) then
+    rawget(Class, method)(self, ...)
+  end
+  Class.super.invoke_before(method, ...)
+end
+
                            +
                            • +

                          • instance:invoke_after(method_name, args...)

                            +

                            Like invoke_before, only the method is called after the recursive call to super, +i.e. invocations happen in the parent to child order.

                            +

                            These two methods are inspired by the Common Lisp before and after methods, and +are intended for implementing similar protocols for certain things. The class +library itself uses them for constructors.

                            +
                            • +
                          +

                          To avoid confusion, these methods cannot be redefined.

                          +
                          -

                          Plugins

                          +

                          Plugins

                          DFHack plugins may export native functions and events to lua contexts. They are automatically imported by mkmodule('plugins.<name>'); this means that a lua module file is still necessary for require to read.

                          The following plugins have lua support.

                          -

                          burrows

                          +

                          burrows

                          Implements extended burrow manipulations.

                          Events:

                            @@ -1977,13 +2050,13 @@ set is the same as used by the command line.

                            The lua module file also re-exports functions from dfhack.burrows.

                          -

                          sort

                          +

                          sort

                          Does not export any native functions as of now. Instead, it calls lua code to perform the actual ordering of list items.

                          -

                          Scripts

                          +

                          Scripts

                          Any files with the .lua extension placed into hack/scripts/* are automatically used by the DFHack core as commands. The matching command name consists of the name of the file sans From f7e414e397e2f3ee70805a6bbe68a40551e05f2a Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Fri, 21 Sep 2012 19:00:18 +0400 Subject: [PATCH 15/18] Add a devel script to inject raw definitions into an existing world. --- scripts/devel/inject-raws.lua | 178 ++++++++++++++++++++++++++++++++++ 1 file changed, 178 insertions(+) create mode 100644 scripts/devel/inject-raws.lua diff --git a/scripts/devel/inject-raws.lua b/scripts/devel/inject-raws.lua new file mode 100644 index 000000000..a4ebeec1d --- /dev/null +++ b/scripts/devel/inject-raws.lua @@ -0,0 +1,178 @@ +-- Injects new reaction, item and building defs into the world. + +-- The savegame contains a list of the relevant definition tokens in +-- the right order, but all details are read from raws every time. +-- This allows just adding stub definitions, and simply saving and +-- reloading the game. + +local utils = require 'utils' + +local raws = df.global.world.raws + +print[[ +WARNING: THIS SCRIPT CAN PERMANENLY DAMAGE YOUR SAVE. + +This script attempts to inject new raw objects into your +world. If the injected references do not match the actual +edited raws, your save will refuse to load, or load but crash. +]] + +if not utils.prompt_yes_no('Did you make a backup?') then + qerror('Not backed up.') +end + +df.global.pause_state = true + +local changed = false + +function inject_reaction(name) + for _,v in ipairs(raws.reactions) do + if v.code == name then + print('Reaction '..name..' already exists.') + return + end + end + + print('Injecting reaction '..name) + changed = true + + raws.reactions:insert('#', { + new = true, + code = name, + name = 'Dummy reaction '..name, + index = #raws.reactions, + }) +end + +local building_types = { + workshop = { df.building_def_workshopst, raws.buildings.workshops }, + furnace = { df.building_def_furnacest, raws.buildings.furnaces }, +} + +function inject_building(btype, name) + for _,v in ipairs(raws.buildings.all) do + if v.code == name then + print('Building '..name..' already exists.') + return + end + end + + print('Injecting building '..name) + changed = true + + local typeinfo = building_types[btype] + + local id = raws.buildings.next_id + raws.buildings.next_id = id+1 + + raws.buildings.all:insert('#', { + new = typeinfo[1], + code = name, + name = 'Dummy '..btype..' '..name, + id = id, + }) + + typeinfo[2]:insert('#', raws.buildings.all[#raws.buildings.all-1]) +end + +local itemdefs = raws.itemdefs +local item_types = { + weapon = { df.itemdef_weaponst, itemdefs.weapons, 'weapon_type' }, + trainweapon = { df.itemdef_weaponst, itemdefs.weapons, 'training_weapon_type' }, + pick = { df.itemdef_weaponst, itemdefs.weapons, 'digger_type' }, + trapcomp = { df.itemdef_trapcompst, itemdefs.trapcomps, 'trapcomp_type' }, + toy = { df.itemdef_toyst, itemdefs.toys, 'toy_type' }, + tool = { df.itemdef_toolst, itemdefs.tools, 'tool_type' }, + instrument = { df.itemdef_instrumentst, itemdefs.instruments, 'instrument_type' }, + armor = { df.itemdef_armorst, itemdefs.armor, 'armor_type' }, + ammo = { df.itemdef_ammost, itemdefs.ammo, 'ammo_type' }, + siegeammo = { df.itemdef_siegeammost, itemdefs.siege_ammo, 'siegeammo_type' }, + gloves = { df.itemdef_glovest, itemdefs.gloves, 'gloves_type' }, + shoes = { df.itemdef_shoest, itemdefs.shoes, 'shoes_type' }, + shield = { df.itemdef_shieldst, itemdefs.shields, 'shield_type' }, + helm = { df.itemdef_helmst, itemdefs.helms, 'helm_type' }, + pants = { df.itemdef_pantsst, itemdefs.pants, 'pants_type' }, + food = { df.itemdef_foodst, itemdefs.food }, +} + +function add_to_civ(entity, bvec, id) + for _,v in ipairs(entity.resources[bvec]) do + if v == id then + return + end + end + + entity.resources[bvec]:insert('#', id) +end + +function add_to_dwarf_civs(btype, id) + local typeinfo = item_types[btype] + if not typeinfo[3] then + print('Not adding to civs.') + end + + for _,entity in ipairs(df.global.world.entities.all) do + if entity.race == df.global.ui.race_id then + add_to_civ(entity, typeinfo[3], id) + end + end +end + +function inject_item(btype, name) + for _,v in ipairs(itemdefs.all) do + if v.id == name then + print('Itemdef '..name..' already exists.') + return + end + end + + print('Injecting item '..name) + changed = true + + local typeinfo = item_types[btype] + local vec = typeinfo[2] + local id = #vec + + vec:insert('#', { + new = typeinfo[1], + id = name, + subtype = id, + name = name, + name_plural = name, + }) + + itemdefs.all:insert('#', vec[id]) + + add_to_dwarf_civs(btype, id) +end + +local args = {...} +local mode = nil +local ops = {} + +for _,kv in ipairs(args) do + if mode and string.match(kv, '^[%u_]+$') then + table.insert(ops, curry(mode, kv)) + elseif kv == 'reaction' then + mode = inject_reaction + elseif building_types[kv] then + mode = curry(inject_building, kv) + elseif item_types[kv] then + mode = curry(inject_item, kv) + else + qerror('Invalid option: '..kv) + end +end + +if #ops > 0 then + print('') + for _,v in ipairs(ops) do + v() + end +end + +if changed then + print('\nNow without unpausing save and reload the game to re-read raws.') +else + print('\nNo changes made.') +end From 038d62367eea44ba625989b8cd4c1380ba544607 Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Sat, 22 Sep 2012 13:14:06 +0400 Subject: [PATCH 16/18] Implement explicit hook priority in vmethod interpose. This resolves a getName order conflict between power-meter and rename. --- library/VTableInterpose.cpp | 40 ++++++++++++++++++++++++++----- library/include/VTableInterpose.h | 19 ++++++++++----- plugins/rename.cpp | 2 +- 3 files changed, 48 insertions(+), 13 deletions(-) diff --git a/library/VTableInterpose.cpp b/library/VTableInterpose.cpp index 046425653..48ae6109c 100644 --- a/library/VTableInterpose.cpp +++ b/library/VTableInterpose.cpp @@ -247,8 +247,9 @@ void VMethodInterposeLinkBase::set_chain(void *chain) addr_to_method_pointer_(chain_mptr, chain); } -VMethodInterposeLinkBase::VMethodInterposeLinkBase(virtual_identity *host, int vmethod_idx, void *interpose_method, void *chain_mptr) - : host(host), vmethod_idx(vmethod_idx), interpose_method(interpose_method), chain_mptr(chain_mptr), +VMethodInterposeLinkBase::VMethodInterposeLinkBase(virtual_identity *host, int vmethod_idx, void *interpose_method, void *chain_mptr, int priority) + : host(host), vmethod_idx(vmethod_idx), interpose_method(interpose_method), + chain_mptr(chain_mptr), priority(priority), applied(false), saved_chain(NULL), next(NULL), prev(NULL) { if (vmethod_idx < 0 || interpose_method == NULL) @@ -349,15 +350,26 @@ bool VMethodInterposeLinkBase::apply(bool enable) return false; // Retrieve the current vtable entry - void *old_ptr = host->get_vmethod_ptr(vmethod_idx); VMethodInterposeLinkBase *old_link = host->interpose_list[vmethod_idx]; + VMethodInterposeLinkBase *next_link = NULL; + while (old_link && old_link->host == host && old_link->priority > priority) + { + next_link = old_link; + old_link = old_link->prev; + } + + void *old_ptr = next_link ? next_link->saved_chain : host->get_vmethod_ptr(vmethod_idx); assert(old_ptr != NULL && (!old_link || old_link->interpose_method == old_ptr)); // Apply the new method ptr set_chain(old_ptr); - if (!host->set_vmethod_ptr(vmethod_idx, interpose_method)) + if (next_link) + { + next_link->set_chain(interpose_method); + } + else if (!host->set_vmethod_ptr(vmethod_idx, interpose_method)) { set_chain(NULL); return false; @@ -365,8 +377,13 @@ bool VMethodInterposeLinkBase::apply(bool enable) // Push the current link into the home host applied = true; - host->interpose_list[vmethod_idx] = this; prev = old_link; + next = next_link; + + if (next_link) + next_link->prev = this; + else + host->interpose_list[vmethod_idx] = this; child_hosts.clear(); child_next.clear(); @@ -374,13 +391,22 @@ bool VMethodInterposeLinkBase::apply(bool enable) if (old_link && old_link->host == host) { // If the old link is home, just push into the plain chain - assert(old_link->next == NULL); + assert(old_link->next == next_link); old_link->next = this; // Child links belong to the topmost local entry child_hosts.swap(old_link->child_hosts); child_next.swap(old_link->child_next); } + else if (next_link) + { + if (old_link) + { + assert(old_link->child_next.count(next_link)); + old_link->child_next.erase(next_link); + old_link->child_next.insert(this); + } + } else { // If creating a new local chain, find children with same vmethod @@ -401,6 +427,8 @@ bool VMethodInterposeLinkBase::apply(bool enable) } } + assert (!next_link || (child_next.empty() && child_hosts.empty())); + // Chain subclass hooks for (auto it = child_next.begin(); it != child_next.end(); ++it) { diff --git a/library/include/VTableInterpose.h b/library/include/VTableInterpose.h index 7ba6b67aa..aeb407a8c 100644 --- a/library/include/VTableInterpose.h +++ b/library/include/VTableInterpose.h @@ -87,7 +87,8 @@ namespace DFHack with code defined by DFHack, while retaining ability to call the original code. The API can be safely used from plugins, and multiple hooks for the same vmethod are - automatically chained in undefined order. + automatically chained (subclass before superclass; at same + level highest priority called first; undefined order otherwise). Usage: @@ -105,6 +106,8 @@ namespace DFHack }; IMPLEMENT_VMETHOD_INTERPOSE(my_hack, foo); + or + IMPLEMENT_VMETHOD_INTERPOSE_PRIO(my_hack, foo, priority); void init() { if (!INTERPOSE_HOOK(my_hack, foo).apply()) @@ -121,9 +124,11 @@ namespace DFHack static DFHack::VMethodInterposeLink interpose_##name; \ rtype interpose_fn_##name args -#define IMPLEMENT_VMETHOD_INTERPOSE(class,name) \ +#define IMPLEMENT_VMETHOD_INTERPOSE_PRIO(class,name,priority) \ DFHack::VMethodInterposeLink \ - class::interpose_##name(&class::interpose_base::name, &class::interpose_fn_##name); + class::interpose_##name(&class::interpose_base::name, &class::interpose_fn_##name, priority); + +#define IMPLEMENT_VMETHOD_INTERPOSE(class,name) IMPLEMENT_VMETHOD_INTERPOSE_PRIO(class,name,0) #define INTERPOSE_NEXT(name) (this->*interpose_##name.chain) #define INTERPOSE_HOOK(class, name) (class::interpose_##name) @@ -140,6 +145,7 @@ namespace DFHack int vmethod_idx; void *interpose_method; // Pointer to the code of the interposing method void *chain_mptr; // Pointer to the chain field below + int priority; bool applied; void *saved_chain; // Previous pointer to the code @@ -155,7 +161,7 @@ namespace DFHack VMethodInterposeLinkBase *get_first_interpose(virtual_identity *id); void find_child_hosts(virtual_identity *cur, void *vmptr); public: - VMethodInterposeLinkBase(virtual_identity *host, int vmethod_idx, void *interpose_method, void *chain_mptr); + VMethodInterposeLinkBase(virtual_identity *host, int vmethod_idx, void *interpose_method, void *chain_mptr, int priority); ~VMethodInterposeLinkBase(); bool is_applied() { return applied; } @@ -171,12 +177,13 @@ namespace DFHack operator Ptr () { return chain; } template - VMethodInterposeLink(Ptr target, Ptr2 src) + VMethodInterposeLink(Ptr target, Ptr2 src, int priority) : VMethodInterposeLinkBase( &Base::_identity, vmethod_pointer_to_idx(target), method_pointer_to_addr(src), - &chain + &chain, + priority ) { src = target; /* check compatibility */ } }; diff --git a/plugins/rename.cpp b/plugins/rename.cpp index 059a4be62..ecebbb90c 100644 --- a/plugins/rename.cpp +++ b/plugins/rename.cpp @@ -130,7 +130,7 @@ DFhackCExport command_result plugin_shutdown ( color_ostream &out ) INTERPOSE_NEXT(getName)(buf); \ } \ }; \ - IMPLEMENT_VMETHOD_INTERPOSE(cname##_hook, getName); + IMPLEMENT_VMETHOD_INTERPOSE_PRIO(cname##_hook, getName, 100); KNOWN_BUILDINGS #undef BUILDING From 6f67a71e00fb319cd257f89f61af368958488664 Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Sat, 22 Sep 2012 14:52:08 +0400 Subject: [PATCH 17/18] Search for cur_season and cur_season_tick in devel/find-offsets. --- library/LuaTools.cpp | 4 +- scripts/devel/find-offsets.lua | 96 ++++++++++++++++++++++++++++++++++ 2 files changed, 99 insertions(+), 1 deletion(-) diff --git a/library/LuaTools.cpp b/library/LuaTools.cpp index a283d215c..8fce0076f 100644 --- a/library/LuaTools.cpp +++ b/library/LuaTools.cpp @@ -1814,7 +1814,9 @@ void DFHack::Lua::Core::onUpdate(color_ostream &out) lua_rawgetp(State, LUA_REGISTRYINDEX, &DFHACK_TIMEOUTS_TOKEN); run_timers(out, State, frame_timers, frame[1], ++frame_idx); - run_timers(out, State, tick_timers, frame[1], world->frame_counter); + + if (world) + run_timers(out, State, tick_timers, frame[1], world->frame_counter); } void DFHack::Lua::Core::Init(color_ostream &out) diff --git a/scripts/devel/find-offsets.lua b/scripts/devel/find-offsets.lua index 6fc127351..07a058474 100644 --- a/scripts/devel/find-offsets.lua +++ b/scripts/devel/find-offsets.lua @@ -803,6 +803,19 @@ end -- cur_year_tick -- +function stop_autosave() + if is_known 'd_init' then + local f = df.global.d_init.flags4 + if f.AUTOSAVE_SEASONAL or f.AUTOSAVE_YEARLY then + f.AUTOSAVE_SEASONAL = false + f.AUTOSAVE_YEARLY = false + print('Disabled seasonal and yearly autosave.') + end + else + dfhack.printerr('Could not disable autosave!') + end +end + local function find_cur_year_tick() local zone if os_type == 'windows' then @@ -815,6 +828,8 @@ local function find_cur_year_tick() return end + stop_autosave() + local addr = zone:find_counter([[ Searching for cur_year_tick. Please exit to main dwarfmode menu, then do as instructed below:]], @@ -824,6 +839,79 @@ menu, then do as instructed below:]], ms.found_offset('cur_year_tick', addr) end +-- +-- cur_season_tick +-- + +function step_n_frames(cnt) + local world = df.global.world + local ctick = world.frame_counter + local more = '' + while world.frame_counter-ctick < cnt do + print(" Please step the game "..(cnt-world.frame_counter+ctick)..more.." frames.") + more = ' more' + if not utils.prompt_yes_no(' Done?', true) then + return nil + end + end + return world.frame_counter-ctick +end + +local function find_cur_season_tick() + if not (is_known 'cur_year_tick') then + dfhack.printerr('Cannot search for cur_season_tick - prerequisites missing.') + return + end + + stop_autosave() + + local addr = searcher:find_interactive([[ +Searching for cur_season_tick. Please exit to main dwarfmode +menu, then do as instructed below:]], + 'int32_t', + function(ccursor) + if ccursor > 0 then + if not step_n_frames(10) then + return false + end + end + return true, math.floor(((df.global.cur_year_tick+10)%100800)/10) + end + ) + ms.found_offset('cur_season_tick', addr) +end + +-- +-- cur_season +-- + +local function find_cur_season() + if not (is_known 'cur_year_tick' and is_known 'cur_season_tick') then + dfhack.printerr('Cannot search for cur_season - prerequisites missing.') + return + end + + stop_autosave() + + local addr = searcher:find_interactive([[ +Searching for cur_season. Please exit to main dwarfmode +menu, then do as instructed below:]], + 'int8_t', + function(ccursor) + if ccursor > 0 then + local cst = df.global.cur_season_tick + df.global.cur_season_tick = 10079 + df.global.cur_year_tick = df.global.cur_year_tick + (10079-cst)*10 + if not step_n_frames(10) then + return false + end + end + return true, math.floor((df.global.cur_year_tick+10)/100800)%4 + end + ) + ms.found_offset('cur_season', addr) +end + -- -- process_jobs -- @@ -839,6 +927,8 @@ end local function find_process_jobs() local zone = get_process_zone() or searcher + stop_autosave() + local addr = zone:find_menu_cursor([[ Searching for process_jobs. Please do as instructed below:]], 'int8_t', @@ -856,6 +946,8 @@ end local function find_process_dig() local zone = get_process_zone() or searcher + stop_autosave() + local addr = zone:find_menu_cursor([[ Searching for process_dig. Please do as instructed below:]], 'int8_t', @@ -879,6 +971,8 @@ local function find_pause_state() end zone = zone or searcher + stop_autosave() + local addr = zone:find_menu_cursor([[ Searching for pause_state. Please do as instructed below:]], 'int8_t', @@ -930,6 +1024,8 @@ print('\nUnpausing globals:\n') exec_finder(find_cur_year, 'cur_year') exec_finder(find_cur_year_tick, 'cur_year_tick') +exec_finder(find_cur_season_tick, 'cur_season_tick') +exec_finder(find_cur_season, 'cur_season') exec_finder(find_process_jobs, 'process_jobs') exec_finder(find_process_dig, 'process_dig') exec_finder(find_pause_state, 'pause_state') From 825d21c91a24f7f95bf05ad10b54845054a36411 Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Sat, 22 Sep 2012 21:00:13 +0400 Subject: [PATCH 18/18] Add a script to wake up units and stop breaks & parties. --- NEWS | 1 + README.rst | 8 ++++ scripts/siren.lua | 109 ++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 118 insertions(+) create mode 100644 scripts/siren.lua diff --git a/NEWS b/NEWS index 22f64d7d6..d46c47e62 100644 --- a/NEWS +++ b/NEWS @@ -30,6 +30,7 @@ DFHack v0.34.11-r2 (UNRELEASED) New scripts: - fixnaked: removes thoughts about nakedness. - setfps: set FPS cap at runtime, in case you want slow motion or speed-up. + - siren: wakes up units, stops breaks and parties - but causes bad thoughts. - fix/population-cap: run after every migrant wave to prevent exceeding the cap. - fix/stable-temp: counts items with temperature updates; does instant one-shot stable-temp. New GUI scripts: diff --git a/README.rst b/README.rst index b0258bb30..97eb61a8f 100644 --- a/README.rst +++ b/README.rst @@ -1539,6 +1539,14 @@ setfps Run ``setfps `` to set the FPS cap at runtime, in case you want to watch combat in slow motion or something :) +siren +===== + +Wakes up sleeping units, cancels breaks and stops parties either everywhere, +or in the burrows given as arguments. In return, adds bad thoughts about +noise and tiredness. Also, the units with interrupted breaks will go on +break again a lot sooner. + growcrops ========= Instantly grow seeds inside farming plots. diff --git a/scripts/siren.lua b/scripts/siren.lua new file mode 100644 index 000000000..5371e3d7b --- /dev/null +++ b/scripts/siren.lua @@ -0,0 +1,109 @@ +-- Wakes up the sleeping, breaks up parties and stops breaks. + +local utils = require 'utils' + +local args = {...} +local burrows = {} +local bnames = {} + +if not dfhack.isMapLoaded() then + qerror('Map is not loaded.') +end + +for _,v in ipairs(args) do + local b = dfhack.burrows.findByName(v) + if not b then + qerror('Unknown burrow: '..v) + end + table.insert(bnames, v) + table.insert(burrows, b) +end + +function is_in_burrows(pos) + if #burrows == 0 then + return true + end + for _,v in ipairs(burrows) do + if dfhack.burrows.isAssignedTile(v, pos) then + return true + end + end +end + +function add_thought(unit, code) + for _,v in ipairs(unit.status.recent_events) do + if v.type == code then + v.age = 0 + return + end + end + + unit.status.recent_events:insert('#', { new = true, type = code }) +end + +function wake_unit(unit) + local job = unit.job.current_job + if not job or job.job_type ~= df.job_type.Sleep then + return + end + + if job.completion_timer > 0 then + unit.counters.unconscious = 0 + add_thought(unit, df.unit_thought_type.SleepNoiseWake) + elseif job.completion_timer < 0 then + add_thought(unit, df.unit_thought_type.Tired) + end + + job.pos:assign(unit.pos) + + job.completion_timer = 0 + + unit.path.dest:assign(unit.pos) + unit.path.path.x:resize(0) + unit.path.path.y:resize(0) + unit.path.path.z:resize(0) + + unit.counters.job_counter = 0 +end + +function stop_break(unit) + local counter = dfhack.units.getMiscTrait(unit, df.misc_trait_type.OnBreak) + if counter then + counter.id = df.misc_trait_type.TimeSinceBreak + counter.value = 100800 - 30*1200 + add_thought(unit, df.unit_thought_type.Tired) + end +end + +-- Stop rest +for _,v in ipairs(df.global.world.units.active) do + local x,y,z = dfhack.units.getPosition(v) + if x and not dfhack.units.isDead(v) and is_in_burrows(xyz2pos(x,y,z)) then + wake_unit(v) + stop_break(v) + end +end + +-- Stop parties +for _,v in ipairs(df.global.ui.parties) do + local pos = utils.getBuildingCenter(v.location) + if is_in_burrows(pos) then + v.timer = 0 + for _, u in ipairs(v.units) do + add_thought(unit, df.unit_thought_type.Tired) + end + end +end + +local place = 'the halls and tunnels' +if #bnames > 0 then + if #bnames == 1 then + place = bnames[1] + else + place = table.concat(bnames,', ',1,#bnames-1)..' and '..bnames[#bnames] + end +end +dfhack.gui.showAnnouncement( + 'A loud siren sounds throughout '..place..', waking the sleeping and startling the awake.', + COLOR_BROWN, true +)