-
-
- fix/* -
- gui/* -
- binpatch -
- quicksave -
- setfps -
- siren -
- growcrops -
- removebadthoughts -
- exterminate -
- source -
- masspit -
- digfort -
- invasion-now -
- digmat -
- superdwarf -
- drainaquifer -
- deathcause -
- lua -
- embark -
- lever -
- stripcaged -
- undump-buildings -
- create-items -
- locate-ore -
- soundsense-season -
- multicmd -
- dfstatus +
- Scripts -
- In-game interface tools
-
-
- Dwarf Manipulator -
- Search -
- AutoMaterial -
- gui/liquids -
- gui/mechanisms -
- gui/rename -
- gui/room-list -
- gui/choose-weapons -
- gui/clone-uniform -
- gui/guide-path -
- gui/workshop-job -
- gui/workflow -
- gui/assign-rack -
- gui/advfort -
- gui/companion-order -
- gui/gm-editor -
- gui/mod-manager +
- In-game interface tools -
- Behavior Mods
-
-
- Siege Engine
-
-
- Rationale -
- Configuration UI +
- Behavior Mods
@@ -2232,7 +2234,10 @@ With this tweak, items made from cloth and leather will gain a level of wear eve
adamantine-cloth-wear: Prevents adamantine clothing from wearing out while being worn (bug 6481).
+Prevents adamantine clothing from wearing out while being worn (bug 6481).
+confirm-embark: Adds a prompt before embarking (on the "prepare carefully" screen).
++embark-tools
+A collection of embark-related tools.
+Usage:
++embark-tools enable/disable tool [tool]... +
+Tools:
+-
+
- anywhere: Allows embarking anywhere (including sites, mountain-only biomes, and oceans). Use with caution. +
- nano: An implementation of nano embark - allows resizing below 2x2 when enabled. +
- sand: Displays an indicator when sand is present in the currently-selected area, similar to the default clay/stone indicators. +
- sticky: Maintains the selected local area while navigating the world map +
+petcapRemover
+This plugin allows you to remove or raise the pet population cap. In vanilla DF, pets will not reproduce unless the population is below 50 and the number of children of that species is below a certain percentage. This plugin allows removing the second restriction and removing or raising the first. Pets still require PET or PET_EXOTIC tags in order to reproduce. Type help petcapRemover for exact usage. In order to make population more stable and avoid sudden population booms as you go below the raised population cap, this plugin counts pregnancies toward the new population cap. It can still go over, but only in the case of multiple births.
+-
+
- petcapRemover +
- cause pregnancies now and schedule the next check +
- petcapRemover every n +
- set how often in ticks the plugin checks for possible pregnancies +
- petcapRemover cap n +
- set the new cap to n. if n = 0, no cap +
- petcapRemover pregtime n +
- sets the pregnancy duration to n ticks. natural pregnancies are 300000 ticks for the current race and 200000 for everyone else +
-misery
+misery
When enabled, every new negative dwarven thought will be multiplied by a factor (2 by default).
Usage:
@@ -2980,7 +3014,7 @@ twice.
-strangemood
+strangemood
Creates a strange mood job the same way the game itself normally does it.
Options:
@@ -3004,13 +3038,13 @@ Valid values are "miner", "carpenter", "engraver",
Known limitations: if the selected unit is currently performing a job, the mood will not be started.
-log-region
+log-region
When enabled in dfhack.init, each time a fort is loaded identifying information will be written to the gamelog. Assists in parsing the file if you switch between forts, and adds information for story-building.
-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.
@@ -3019,7 +3053,7 @@ 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:
-fix/*
+fix/*
Scripts in this subdirectory fix various bugs and issues, some of them obscure.
fix/dead-units
@@ -3056,12 +3090,12 @@ hopefully avoid jamming it again, and unsuspends them.
-gui/*
+gui/*
Scripts that implement dialogs inserted into the main game window are put in this directory.
-binpatch
+binpatch
Checks, applies or removes binary patches directly in memory at runtime:
binpatch check/apply/remove <patchname> @@ -3071,17 +3105,17 @@ script uses hack/patches/<df-v the version appropriate for the currently loaded executable.-quicksave
+quicksave
If called in dwarf mode, makes DF immediately auto-save the game by setting a flag normally used in seasonal auto-save.
-setfps
+setfps
Run setfps <number> to set the FPS cap at runtime, in case you want to watch combat in slow motion or something :)
-siren
+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, tiredness and lack of protection. Also, the units with interrupted @@ -3089,7 +3123,7 @@ breaks will go on break again a lot sooner. The script is intended for emergencies, e.g. when a siege appears, and all your military is partying.
-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. @@ -3101,7 +3135,7 @@ growcrops plump 40
-removebadthoughts
+removebadthoughts
This script remove negative thoughts from your dwarves. Very useful against tantrum spirals.
The script can target a single creature, when used with the him argument, @@ -3115,7 +3149,7 @@ but in the short term your dwarves will get much more joyful.
quickly after you unpause.-exterminate
+exterminate
Kills any unit of a given race.
With no argument, lists the available races and count eligible targets.
With the special argument him, targets only the selected creature.
@@ -3147,7 +3181,7 @@ exterminate elve magma-source
+source
Create an infinite magma or water source or drain on a tile.
This script registers a map tile as a liquid source, and every 12 game ticks that tile receives or remove 1 new unit of flow based on the configuration.
@@ -3169,14 +3203,14 @@ source add water 0 - water drain-masspit
+masspit
Designate all creatures in cages on top of a pit/pond activity zone for pitting. Works best with an animal stockpile on top of the zone.
Works with a zone number as argument (eg Activity Zone #6 -> masspit 6) or with the game cursor on top of the area.
-digfort
+digfort
A script to designate an area for digging according to a plan in csv format.
This script, inspired from quickfort, can designate an area for digging. Your plan should be stored in a .csv file like this:
@@ -3198,7 +3232,7 @@ as an offset for the pattern: instead of starting at the cursor, it will start Dwarf Fortress.exe is found).-invasion-now
+invasion-now
Triggers an invasion, or several in the near future.
invasion-now civName trigger an invasion from the civilization with the id civName, starting in about ten ticks
invasion-now civName start trigger an invasion from civName in a number of ticks between 10*start and 11*start-1 (inclusive)
@@ -3206,7 +3240,7 @@ Dwarf Fortress.exe is found).Probably fails if the start time of a triggered invasion is later than the start of the next year.
-digmat
+digmat
Designates a tile for digging. Monitors the tile, and when it is dug out, add surrounding discovered tiles of the same material for digging. Similar to 'digv', but less cheaty. Works for stone layers, soil layers, veins, etc.
@@ -3215,7 +3249,7 @@ same designation for future digging (eg dig up/downstairs). When digging stairs, also designate tiles on z-1 and z+1 when they are discovered.-superdwarf
+superdwarf
Similar to fastdwarf, per-creature.
To make any creature superfast, target it ingame using 'v' and:
@@ -3225,17 +3259,17 @@ superdwarf add
This plugin also shortens the 'sleeping' and 'on break' periods of targets.
-deathcause
+deathcause
Focus a body part ingame, and this script will display the cause of death of the creature. Also works when selecting units from the 'u'nitlist viewscreen.
-lua
+lua
There are the following ways to invoke this command:
lua (without any parameters)
@@ -3254,11 +3288,11 @@ directory. If the filename is not supplied, it loads "dfhack.lua".
-lever
+lever
Allow manipulation of in-game levers from the dfhack console.
Can list levers, including state and links, with:
@@ -3272,7 +3306,7 @@ lever pull 42 --now
-stripcaged
+stripcaged
For dumping items inside cages. Will mark selected items for dumping, then a dwarf may come and actually dump it. See also autodump.
With the items argument, only dumps items laying in the cage, excluding @@ -3290,11 +3324,11 @@ stripcaged weapons 25321 34228
-create-items
+create-items
Spawn arbitrary items under the cursor.
The first argument gives the item category, the second gives the material, and the optionnal third gives the number of items to create (defaults to 20).
@@ -3316,7 +3350,7 @@ create-items bar adamantine-locate-ore
+locate-ore
Scan the map for metal ores.
Finds and designate for digging one tile of a specific metal ore. Only works for native metal ores, does not handle reaction stuff (eg STEEL).
@@ -3329,7 +3363,7 @@ locate-ore iron-soundsense-season
+soundsense-season
It is a well known issue that Soundsense cannot detect the correct current season when a savegame is loaded and has to play random season music until a season switch occurs.
@@ -3338,7 +3372,7 @@ to gamelog.txt on every map load to fix this. For best results call the script from dfhack.init.-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.
@@ -3368,18 +3402,20 @@ guideline because it arguably just fixes small usability bugs in the game UI.-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 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).
+value), Name, Profession/Squad, 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 teal backgrounds denote skills not controlled by labors, e.g. military and social skills.
+Press t to toggle between Profession and Squad view.
+
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 @@ -3388,7 +3424,7 @@ in the list. Backspace seeks to the top left corner.
Press Enter to toggle the selected labor for the selected unit, or Shift+Enter to toggle all labors within the selected category.
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, +skill/labor, and press the */ keys to sort the unit list by Name, Profession/Squad, Happiness, or Arrival order (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 @@ -3396,18 +3432,18 @@ 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. +direction (descending for happiness or labors/skills, ascending for name, +profession or squad) 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. +
- Left-click on a unit's name, profession or squad to view its properties. +
- Right-click on a unit's name, profession or squad to zoom to it.
Pressing ESC normally returns to the unit screen, but Shift-ESC would exit directly to the main dwarf mode screen.
-Search
+Search
Implemented by the 'search' plugin.
The search plugin adds search to the Stocks, Animals, Trading, Stockpile, Noble (assignment candidates), Military (position candidates), Burrows @@ -3438,7 +3474,7 @@ only fat or tallow by forbidding fats, then searching for fat/tallow, and using Permit Fats again while the list is filtered.
-AutoMaterial
+AutoMaterial
Implemented by the 'automaterial' plugin.
This makes building constructions (walls, floors, fortifications, etc) a little bit easier by saving you from having to trawl through long lists of materials each time @@ -3466,7 +3502,7 @@ materials, it returns you back to this screen. If you use this along with severa enabled materials, you should be able to place complex constructions more conveniently.
-gui/liquids
+gui/liquids
To use, bind to a key (the example config uses Alt-L) and activate in the 'k' mode.
This script is a gui front-end to the liquids plugin and works similar to it, @@ -3486,7 +3522,7 @@ rivers power water wheels even when full and technically not flowing.
After setting up the desired operations using the described keys, use Enter to apply them.
-gui/mechanisms
+gui/mechanisms
To use, bind to a key (the example config uses Ctrl-M) and activate in the 'q' mode.
Lists mechanisms connected to the building, and their links. Navigating the list centers @@ -3496,7 +3532,7 @@ focus on the current one. Shift-Enter has an effect equivalent to pressing Enter re-entering the mechanisms ui.
-gui/rename
+gui/rename
Backed by the rename plugin, this script allows entering the desired name via a simple dialog in the game ui.
-
@@ -3519,7 +3555,7 @@ their species string.
unit profession change to Ctrl-Shift-T.
-gui/room-list
+gui/room-list
To use, bind to a key (the example config uses Alt-R) and activate in the 'q' mode, either immediately or after opening the assign owner page.
@@ -3527,7 +3563,7 @@ either immediately or after opening the assign owner page.
list, and allows unassigning them.
-gui/choose-weapons
+gui/choose-weapons
Bind to a key (the example config uses Ctrl-W), and activate in the Equip->View/Customize page of the military screen.
Depending on the cursor location, it rewrites all 'individual choice weapon' entries @@ -3538,14 +3574,14 @@ only that entry, and does it even if it is not 'individual choice'.
and may lead to inappropriate weapons being selected.-gui/clone-uniform
+gui/clone-uniform
Bind to a key (the example config uses Ctrl-C), and activate in the Uniforms page of the military screen with the cursor in the leftmost list.
When invoked, the script duplicates the currently selected uniform template, and selects the newly created copy.
-gui/guide-path
+gui/guide-path
Bind to a key (the example config uses Alt-P), and activate in the Hauling menu with the cursor over a Guide order.
@@ -3553,7 +3589,7 @@ the cursor over a Guide order.
computes it when the order is executed for the first time.
-gui/workshop-job
+gui/workshop-job
Bind to a key (the example config uses Alt-A), and activate with a job selected in a workshop in the 'q' mode.
@@ -3589,7 +3625,7 @@ and then try to change the input item type, now it won't let you select plan
you have to unset the material first.
-gui/workflow
+gui/workflow
Bind to a key (the example config uses Alt-W), and activate with a job selected in a workshop in the 'q' mode.
@@ -3636,7 +3672,7 @@ the current stock value. The bright green dashed line is the target
limit (maximum) and the dark green line is that minus the gap (minimum).
-gui/assign-rack
+gui/assign-rack
Bind to a key (the example config uses P), and activate when viewing a weapon rack in the 'q' mode.
@@ -3660,7 +3696,7 @@ the intended user. In order to aid in the choice, it shows the number
of currently assigned racks for every valid squad.
-gui/advfort
+gui/advfort
This script allows to perform jobs in adventure mode. For more complete help press '?' while script is running. It's most confortable to use this as a keybinding. (e.g. keybinding set Ctrl-T gui/advfort). Possible arguments:
@@ -3679,7 +3715,7 @@ implies -a-gui/companion-order
+gui/companion-order
A script to issue orders for companions. Select companions with lower case chars, issue orders with upper case. Must be in look or talk mode to issue command on tile.
@@ -3695,7 +3731,7 @@ case. Must be in look or talk mode to issue command on tile.
-gui/gm-editor
+gui/gm-editor
There are three ways to open this editor:
- using gui/gm-editor command/keybinding - opens editor on what is selected @@ -3710,14 +3746,14 @@ the same as version above. in-game help.
-gui/mod-manager
+gui/mod-manager
A way to simply install and remove small mods. It looks for specially formatted mods in df subfolder 'mods'. Mods are not included, for example mods see: github mini mod repository
-Behavior Mods
+Behavior Mods
These plugins, when activated via configuration UI or by detecting certain structures in RAWs, modify the game engine behavior concerning the target objects to add features not otherwise present.
@@ -3728,20 +3764,20 @@ technical challenge, and do not represent any long-term plans to produce more similar modifications of the game.-Siege Engine
+Siege Engine
The siege-engine plugin enables siege engines to be linked to stockpiles, and aimed at an arbitrary rectangular area across Z levels, instead of the original four directions. Also, catapults can be ordered to load arbitrary objects, not just stones.
-Rationale
+Rationale
Siege engines are a very interesting feature, but sadly almost useless in the current state because they haven't been updated since 2D and can only aim in four directions. This is an attempt to bring them more up to date until Toady has time to work on it. Actual improvements, e.g. like making siegers bring their own, are something only Toady can do.
-Configuration UI
+Configuration UI
The configuration front-end to the plugin is implemented by the gui/siege-engine script. Bind it to a key (the example config uses Alt-A) and activate after selecting a siege engine in 'q' mode.
@@ -3764,7 +3800,7 @@ menu.-Power Meter
+Power Meter
The power-meter plugin implements a modified pressure plate that detects power being supplied to gear boxes built in the four adjacent N/S/W/E tiles.
The configuration front-end is implemented by the gui/power-meter script. Bind it to a @@ -3775,11 +3811,11 @@ in the build menu.
configuration page, but configures parameters relevant to the modded power meter building.-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 @@ -3790,7 +3826,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.
@@ -3814,7 +3850,7 @@ 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 @@ -3845,7 +3881,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 @@ -3854,7 +3890,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 @@ -3865,7 +3901,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. The produced contaminants are immune to being washed away by water or destroyed by diff --git a/Readme.rst b/Readme.rst index 99a852cd6..fde2b5c04 100644 --- a/Readme.rst +++ b/Readme.rst @@ -1397,6 +1397,8 @@ Subcommands that persist until disabled or DF quit: :adamantine-cloth-wear: Prevents adamantine clothing from wearing out while being worn (bug 6481). +:confirm-embark: Adds a prompt before embarking (on the "prepare carefully" screen). + fix-armory ---------- @@ -2053,6 +2055,35 @@ See the bay12 thread for details: http://www.bay12forums.com/smf/index.php?topic * Some of the DFusion plugins aren't completely ported yet. This can lead to crashes. * The game will be suspended while you're using dfusion. Don't panic when it doesn't respond. +embark-tools +------------ +A collection of embark-related tools. + +Usage:: + + embark-tools enable/disable tool [tool]... + +Tools: + +* ``anywhere``: Allows embarking anywhere (including sites, mountain-only biomes, and oceans). Use with caution. +* ``nano``: An implementation of nano embark - allows resizing below 2x2 when enabled. +* ``sand``: Displays an indicator when sand is present in the currently-selected area, similar to the default clay/stone indicators. +* ``sticky``: Maintains the selected local area while navigating the world map + +petcapRemover +------------- + +This plugin allows you to remove or raise the pet population cap. In vanilla DF, pets will not reproduce unless the population is below 50 and the number of children of that species is below a certain percentage. This plugin allows removing the second restriction and removing or raising the first. Pets still require PET or PET_EXOTIC tags in order to reproduce. Type help petcapRemover for exact usage. In order to make population more stable and avoid sudden population booms as you go below the raised population cap, this plugin counts pregnancies toward the new population cap. It can still go over, but only in the case of multiple births. + +`petcapRemover` + cause pregnancies now and schedule the next check +`petcapRemover every n` + set how often in ticks the plugin checks for possible pregnancies +`petcapRemover cap n` + set the new cap to n. if n = 0, no cap +`petcapRemover pregtime n` + sets the pregnancy duration to n ticks. natural pregnancies are 300000 ticks for the current race and 200000 for everyone else + misery ------ When enabled, every new negative dwarven thought will be multiplied by a factor (2 by default). @@ -2523,15 +2554,19 @@ 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). +value), Name, Profession/Squad, 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 teal backgrounds denote skills not controlled by labors, e.g. military and social skills. .. image:: images/manipulator2.png +Press ``t`` to toggle between Profession and Squad view. + +.. image:: images/manipulator3.png + Use the arrow keys or number pad to move the cursor around, holding Shift to move 10 tiles at a time. @@ -2543,7 +2578,7 @@ 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, +skill/labor, and press the ``*/`` keys to sort the unit list by Name, Profession/Squad, Happiness, or Arrival order (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 @@ -2553,12 +2588,12 @@ 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. + direction (descending for happiness or labors/skills, ascending for name, + profession or squad) 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. +* Left-click on a unit's name, profession or squad to view its properties. +* Right-click on a unit's name, profession or squad to zoom to it. Pressing ESC normally returns to the unit screen, but Shift-ESC would exit directly to the main dwarf mode screen. diff --git a/images/manipulator.png b/images/manipulator.png index 1f452549f..59e7226a6 100644 Binary files a/images/manipulator.png and b/images/manipulator.png differ diff --git a/images/manipulator2.png b/images/manipulator2.png index 38c6c3cfb..e415200a6 100644 Binary files a/images/manipulator2.png and b/images/manipulator2.png differ diff --git a/images/manipulator3.png b/images/manipulator3.png new file mode 100644 index 000000000..0ee952306 Binary files /dev/null and b/images/manipulator3.png differ diff --git a/library/CMakeLists.txt b/library/CMakeLists.txt index 578ce9264..4121ff9e3 100644 --- a/library/CMakeLists.txt +++ b/library/CMakeLists.txt @@ -127,6 +127,7 @@ include/modules/Vermin.h include/modules/World.h include/modules/Graphic.h include/modules/Once.h +include/modules/Filesystem.h ) SET( MODULE_SOURCES @@ -152,6 +153,7 @@ modules/World.cpp modules/Graphic.cpp modules/Windows.cpp modules/Once.cpp +modules/Filesystem.cpp ) IF(WIN32) diff --git a/library/LuaApi.cpp b/library/LuaApi.cpp index 3a374445f..e830189c5 100644 --- a/library/LuaApi.cpp +++ b/library/LuaApi.cpp @@ -52,6 +52,7 @@ distribution. #include "modules/Buildings.h" #include "modules/Constructions.h" #include "modules/Random.h" +#include "modules/Filesystem.h" #include "LuaWrapper.h" #include "LuaTools.h" @@ -1923,6 +1924,20 @@ static const luaL_Reg dfhack_screen_funcs[] = { { NULL, NULL } }; +/***** Filesystem module *****/ + +static const LuaWrapper::FunctionReg dfhack_filesystem_module[] = { + WRAPM(Filesystem, getcwd), + WRAPM(Filesystem, chdir), + WRAPM(Filesystem, mkdir), + WRAPM(Filesystem, rmdir), + WRAPM(Filesystem, exists), + WRAPM(Filesystem, isfile), + WRAPM(Filesystem, isdir), + {NULL, NULL} +}; + + /***** Internal module *****/ static void *checkaddr(lua_State *L, int idx, bool allow_null = false) @@ -2227,6 +2242,64 @@ static int internal_getDir(lua_State *L) } return 1; } + +static int internal_runCommand(lua_State *L) +{ + buffered_color_ostream out; + command_result res; + if (lua_gettop(L) == 0) + { + lua_pushstring(L, ""); + } + int type_1 = lua_type(L, 1); + if (type_1 == LUA_TTABLE) + { + std::string command = ""; + std::vector
+#include +#include +#include +#include +#include + +#ifdef _WIN32 +#include +#include +#include +#include +#ifdef __BORLANDC__ + #include +#else + #include +#endif +#include +#else +#include +#include +#include +#include +#include +#endif + +#define LFS_VERSION "1.6.2" +#define LFS_LIBNAME "lfs" + +#if LUA_VERSION_NUM < 502 +# define luaL_newlib(L,l) (lua_newtable(L), luaL_register(L,NULL,l)) +#endif + +/* Define 'strerror' for systems that do not implement it */ +#ifdef NO_STRERROR +#define strerror(_) "System unable to describe the error" +#endif + +/* Define 'getcwd' for systems that do not implement it */ +#ifdef NO_GETCWD +#define getcwd(p,s) NULL +#define getcwd_error "Function 'getcwd' not provided by system" +#else +#define getcwd_error strerror(errno) + #ifdef _WIN32 + /* MAX_PATH seems to be 260. Seems kind of small. Is there a better one? */ + #define LFS_MAXPATHLEN MAX_PATH + #else + /* For MAXPATHLEN: */ + #include + #define LFS_MAXPATHLEN MAXPATHLEN + #endif +#endif + +typedef struct dir_data { + int closed; +#ifdef _WIN32 + intptr_t hFile; + char pattern[MAX_PATH+1]; +#else + DIR *dir; +#endif +} dir_data; + +#ifdef _WIN32 + #ifdef __BORLANDC__ + #define lfs_setmode(L,file,m) ((void)L, setmode(_fileno(file), m)) + #define STAT_STRUCT struct stati64 + #else + #define lfs_setmode(L,file,m) ((void)L, _setmode(_fileno(file), m)) + #define STAT_STRUCT struct _stati64 + #endif +#define STAT_FUNC _stati64 +#define LSTAT_FUNC STAT_FUNC +#else +#define _O_TEXT 0 +#define _O_BINARY 0 +#define lfs_setmode(L,file,m) ((void)L, (void)file, (void)m, 0) +#define STAT_STRUCT struct stat +#define STAT_FUNC stat +#define LSTAT_FUNC lstat +#endif + +#ifdef _WIN32 + #ifndef S_ISDIR + #define S_ISDIR(mode) (mode&_S_IFDIR) + #endif + #ifndef S_ISREG + #define S_ISREG(mode) (mode&_S_IFREG) + #endif + #ifndef S_ISLNK + #define S_ISLNK(mode) (0) + #endif + #ifndef S_ISSOCK + #define S_ISSOCK(mode) (0) + #endif + #ifndef S_ISFIFO + #define S_ISFIFO(mode) (0) + #endif + #ifndef S_ISCHR + #define S_ISCHR(mode) (mode&_S_IFCHR) + #endif + #ifndef S_ISBLK + #define S_ISBLK(mode) (0) + #endif +#endif + +enum _filetype { + FILETYPE_NONE = -2, + FILETYPE_UNKNOWN = -1, + FILETYPE_FILE = 1, + FILETYPE_DIRECTORY, + FILETYPE_LINK, + FILETYPE_SOCKET, + FILETYPE_NAMEDPIPE, + FILETYPE_CHAR_DEVICE, + FILETYPE_BLOCK_DEVICE +}; + +namespace DFHack { + namespace Filesystem { + DFHACK_EXPORT bool chdir (std::string path); + DFHACK_EXPORT std::string getcwd (); + DFHACK_EXPORT bool mkdir (std::string path); + DFHACK_EXPORT bool rmdir (std::string path); + DFHACK_EXPORT bool stat (std::string path, STAT_STRUCT &info); + DFHACK_EXPORT bool exists (std::string path); + DFHACK_EXPORT _filetype filetype (std::string path); + DFHACK_EXPORT bool isfile (std::string path); + DFHACK_EXPORT bool isdir (std::string path); + } +} diff --git a/library/include/modules/Units.h b/library/include/modules/Units.h index b51183d6b..5380d82aa 100644 --- a/library/include/modules/Units.h +++ b/library/include/modules/Units.h @@ -256,6 +256,8 @@ DFHACK_EXPORT std::string getCasteProfessionName(int race, int caste, df::profes DFHACK_EXPORT int8_t getProfessionColor(df::unit *unit, bool ignore_noble = false); DFHACK_EXPORT int8_t getCasteProfessionColor(int race, int caste, df::profession pid); + +DFHACK_EXPORT std::string getSquadName(df::unit *unit); } } #endif diff --git a/library/lua/dfhack.lua b/library/lua/dfhack.lua index 77c62311a..3cc98e882 100644 --- a/library/lua/dfhack.lua +++ b/library/lua/dfhack.lua @@ -10,6 +10,14 @@ local dfhack = dfhack local base_env = dfhack.BASE_G local _ENV = base_env +CR_LINK_FAILURE = -3 +CR_NEEDS_CONSOLE = -2 +CR_NOT_IMPLEMENTED = -1 +CR_OK = 0 +CR_FAILURE = 1 +CR_WRONG_USAGE = 2 +CR_NOT_FOUND = 3 + -- Console color constants COLOR_RESET = -1 @@ -256,7 +264,8 @@ function dfhack.interpreter(prompt,hfile,env) print("Shortcuts:\n".. " '= foo' => '_1,_2,... = foo'\n".. " '! foo' => 'print(foo)'\n".. - "Both save the first result as '_'.") + " '~ foo' => 'printall(foo)'\n".. + "All of these save the first result as '_'.") print_banner = false end @@ -357,6 +366,31 @@ function dfhack.run_script(name,...) return f(...) end +function dfhack.run_command(...) + args = {...} + if type(args[1]) == 'table' then + command = args[1] + elseif #args > 1 and type(args[2]) == 'table' then + -- {args[1]} + args[2] + command = args[2] + table.insert(command, 1, args[1]) + elseif #args == 1 and type(args[1]) == 'string' then + command = args[1] + elseif #args > 1 and type(args[1]) == 'string' then + command = args + else + error('Invalid arguments') + end + result = internal.runCommand(command) + output = "" + for i, f in pairs(result) do + if type(f) == 'table' then + output = output .. f[2] + end + end + return output, result.status +end + -- Per-save init file function dfhack.getSavePath() diff --git a/library/modules/Filesystem.cpp b/library/modules/Filesystem.cpp new file mode 100644 index 000000000..be1668bcc --- /dev/null +++ b/library/modules/Filesystem.cpp @@ -0,0 +1,145 @@ +/* +https://github.com/peterix/dfhack +Copyright (c) 2009-2012 Petr Mrázek (peterix@gmail.com) + +This software is provided 'as-is', without any express or implied +warranty. In no event will the authors be held liable for any +damages arising from the use of this software. + +Permission is granted to anyone to use this software for any +purpose, including commercial applications, and to alter it and +redistribute it freely, subject to the following restrictions: + +1. The origin of this software must not be misrepresented; you must +not claim that you wrote the original software. If you use this +software in a product, an acknowledgment in the product documentation +would be appreciated but is not required. + +2. Altered source versions must be plainly marked as such, and +must not be misrepresented as being the original software. + +3. This notice may not be removed or altered from any source +distribution. +*/ +/* Based on luafilesystem +Copyright © 2003-2014 Kepler Project. + +Permission is hereby granted, free of charge, to any person +obtaining a copy of this software and associated documentation +files (the "Software"), to deal in the Software without +restriction, including without limitation the rights to use, copy, +modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS +BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN +ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +*/ + +#include + +#include "modules/Filesystem.h" + +bool DFHack::Filesystem::chdir (std::string path) +{ + return !(bool)::chdir(path.c_str()); +} + +std::string DFHack::Filesystem::getcwd () +{ + char *path; + char buf[LFS_MAXPATHLEN]; + std::string result = ""; +#ifdef _WIN32 + if ((path = ::_getcwd(buf, LFS_MAXPATHLEN)) != NULL) +#else + if ((path = ::getcwd(buf, LFS_MAXPATHLEN)) != NULL) +#endif + result = buf; + return result; +} + +bool DFHack::Filesystem::mkdir (std::string path) +{ + int fail; +#ifdef _WIN32 + fail = ::_mkdir(path.c_str()); +#else + fail = ::mkdir(path.c_str(), S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | + S_IWGRP | S_IXGRP | S_IROTH | S_IXOTH); +#endif + return !(bool)fail; +} + +bool DFHack::Filesystem::rmdir (std::string path) +{ + int fail; +#ifdef _WIN32 + fail = ::_rmdir(path.c_str()); +#else + fail = ::rmdir(path.c_str()); +#endif + return !(bool)fail; +} + +#ifdef _WIN32 +_filetype mode2type (unsigned short mode) { +#else +_filetype mode2type (mode_t mode) { +#endif + if (S_ISREG(mode)) + return FILETYPE_FILE; + else if (S_ISDIR(mode)) + return FILETYPE_DIRECTORY; + else if (S_ISLNK(mode)) + return FILETYPE_LINK; + else if (S_ISSOCK(mode)) + return FILETYPE_SOCKET; + else if (S_ISFIFO(mode)) + return FILETYPE_NAMEDPIPE; + else if (S_ISCHR(mode)) + return FILETYPE_CHAR_DEVICE; + else if (S_ISBLK(mode)) + return FILETYPE_BLOCK_DEVICE; + else + return FILETYPE_UNKNOWN; +} + +bool DFHack::Filesystem::stat (std::string path, STAT_STRUCT &info) +{ + return !(bool)(STAT_FUNC(path.c_str(), &info)); +} + +bool DFHack::Filesystem::exists (std::string path) +{ + STAT_STRUCT info; + return (bool)DFHack::Filesystem::stat(path.c_str(), info); +} + +#include +_filetype DFHack::Filesystem::filetype (std::string path) +{ + STAT_STRUCT info; + DFHack::Filesystem::stat(path, info); + std::cout << info.st_mode << std::endl; + return mode2type(info.st_mode); +} + +bool DFHack::Filesystem::isfile (std::string path) +{ + return DFHack::Filesystem::filetype(path) == FILETYPE_FILE; +} + +bool DFHack::Filesystem::isdir (std::string path) +{ + return DFHack::Filesystem::filetype(path) == FILETYPE_DIRECTORY; +} diff --git a/library/modules/Units.cpp b/library/modules/Units.cpp index 20c536cd1..af4384b79 100644 --- a/library/modules/Units.cpp +++ b/library/modules/Units.cpp @@ -69,6 +69,7 @@ using namespace std; #include "df/unit_misc_trait.h" #include "df/unit_skill.h" #include "df/curse_attr_change.h" +#include "df/squad.h" using namespace DFHack; using namespace df::enums; @@ -1552,3 +1553,15 @@ int8_t DFHack::Units::getCasteProfessionColor(int race, int casteid, df::profess // default to dwarven peasant color return 3; } + +std::string DFHack::Units::getSquadName(df::unit *unit) +{ + if (unit->military.squad_id == -1) + return ""; + df::squad *squad = df::squad::find(unit->military.squad_id); + if (!squad) + return ""; + if (squad->alias.size() > 0) + return squad->alias; + return Translation::TranslateName(&squad->name, true); +} diff --git a/package/darwin/dfhack b/package/darwin/dfhack index 40fc083ab..55aa81a98 100755 --- a/package/darwin/dfhack +++ b/package/darwin/dfhack @@ -12,6 +12,6 @@ fi old_tty_settings=$(stty -g) cd "${PWD}" -DYLD_INSERT_LIBRARIES=./hack/libdfhack.dylib ./dwarfort.exe +DYLD_INSERT_LIBRARIES=./hack/libdfhack.dylib ./dwarfort.exe "$@" stty "$old_tty_settings" echo "" diff --git a/plugins/CMakeLists.txt b/plugins/CMakeLists.txt index 84aa36199..8436f2fe1 100644 --- a/plugins/CMakeLists.txt +++ b/plugins/CMakeLists.txt @@ -167,6 +167,8 @@ if (BUILD_SUPPORTED) DFHACK_PLUGIN(command-prompt command-prompt.cpp) DFHACK_PLUGIN(remotefortressreader remotefortressreader.cpp PROTOBUFS RemoteFortressReader) DFHACK_PLUGIN(building-hacks building-hacks.cpp LINK_LIBRARIES lua) + DFHACK_PLUGIN(embark-tools embark-tools.cpp) + DFHACK_PLUGIN(petcapRemover petcapRemover.cpp) endif() # this is the skeleton plugin. If you want to make your own, make a copy and then change it diff --git a/plugins/command-prompt.cpp b/plugins/command-prompt.cpp index 3cdd83ab3..f9a3f80bf 100644 --- a/plugins/command-prompt.cpp +++ b/plugins/command-prompt.cpp @@ -12,11 +12,13 @@ #include #include -
#include
+#include #include "df/interface_key.h" #include "df/ui.h" #include "df/graphic.h" #include "df/enabler.h" + using namespace DFHack; using namespace df::enums; @@ -24,6 +26,8 @@ using df::global::ui; using df::global::gps; using df::global::enabler; +std::vector +#include + +#include +#include "ColorText.h" +#include "df/viewscreen_choose_start_sitest.h" +#include "df/interface_key.h" + +using namespace DFHack; + +struct EmbarkTool +{ + std::string id; + std::string name; + std::string desc; + bool enabled; + df::interface_key toggle_key; +}; + +EmbarkTool embark_tools[] = { + {"anywhere", "Embark anywhere", "Allows embarking anywhere on the world map", + false, df::interface_key::CUSTOM_A}, + {"nano", "Nano embark", "Allows the embark size to be decreased below 2x2", + false, df::interface_key::CUSTOM_N}, + {"sand", "Sand indicator", "Displays an indicator when sand is present on the given embark site", + false, df::interface_key::CUSTOM_S}, + {"sticky", "Stable position", "Maintains the selected local area while navigating the world map", + false, df::interface_key::CUSTOM_P}, +}; +#define NUM_TOOLS int(sizeof(embark_tools) / sizeof(EmbarkTool)) + +command_result embark_tools_cmd (color_ostream &out, std::vector &commands) +{ + std::string help = ""; + help += "embark-tools (enable/disable) tool [tool...]\n" + "Tools:\n"; + for (int i = 0; i < NUM_TOOLS; i++) + { + help += (" " + embark_tools[i].id + ": " + embark_tools[i].desc + "\n"); + } + commands.push_back(PluginCommand( + "embark-tools", + "A collection of embark tools", + embark_tools_cmd, + false, + help.c_str() + )); + return CR_OK; +} + +DFhackCExport command_result plugin_shutdown (color_ostream &out) +{ + INTERPOSE_HOOK(choose_start_site_hook, feed).remove(); + INTERPOSE_HOOK(choose_start_site_hook, render).remove(); + return CR_OK; +} + +DFhackCExport command_result plugin_enable (color_ostream &out, bool enable) +{ + if (is_enabled != enable) + { + if (!INTERPOSE_HOOK(choose_start_site_hook, feed).apply(enable) || + !INTERPOSE_HOOK(choose_start_site_hook, render).apply(enable)) + return CR_FAILURE; + is_enabled = enable; + } + return CR_OK; +} + +command_result embark_tools_cmd (color_ostream &out, std::vector units; altsort_mode altsort; + bool show_squad; bool do_refresh_names; int first_row, sel_row, num_rows; @@ -418,6 +437,7 @@ viewscreen_unitlaborsst::viewscreen_unitlaborsst(vector
- Siege Engine