Contents
-On Linux, DFHack acts as a library that shadows parts of the SDL API using LD_PRELOAD.
-DFHack doesn't have any kind of system of code snapshots in place, so you will have to get code from the github repository using git. -Having a 'git' package installed is the minimal requirement, but some sort of git gui or git integration for your favorite text editor/IDE will certainly help.
-The code resides here: https://github.com/peterix/dfhack
-If you just want to compile DFHack or work on it by contributing patches, it's quite enough to clone from the read-only address:
--git clone git://github.com/peterix/dfhack.git -cd dfhack -git submodule init -git submodule update --
If you want to get really involved with the development, create an account on github, make a clone there and then use that as your remote repository instead. Detailed instructions are beyond the scope of this document. If you need help, join us on IRC (#dfhack channel on freenode).
-DFHack is meant to be installed into an existing DF folder, so get one ready.
-For building, you need a 32-bit version of GCC. For example, to build DFHack on -a 64-bit distribution like Arch, you'll need the multilib development tools and libraries.
-Before you can build anything, you'll also need cmake. It is advisable to also get -ccmake on distributions that split the cmake package into multiple parts.
-For the code generation parts, you need perl and the XML::LibXML and XML::LibXSLT perl packages. -You should be able to find them in your distro repositories (on Arch linux 'perl-xml-libxml' and 'perl-xml-libxslt').
-Building is fairly straightforward. Enter the build folder and start the build like this:
--cd build -cmake .. -DCMAKE_BUILD_TYPE:string=Release -DCMAKE_INSTALL_PREFIX=/home/user/DF -make install --
Obviously, replace the install path with path to your DF. This will build the library -along with the normal set of plugins and install them into your DF folder.
-Alternatively, you can use ccmake instead of cmake:
--cd build -ccmake .. -make install --
This will show a curses-based interface that lets you set all of the -extra options.
-You can also use a cmake-friendly IDE like KDevelop 4 or the cmake-gui -program.
-On Windows, DFHack replaces the SDL library distributed with DF.
-DFHack doesn't have any kind of system of code snapshots in place, so you will have to get code from the github repository using git. -You will need some sort of Windows port of git, or a GUI. Some examples:
----
-- http://code.google.com/p/msysgit/ - this is a command line version of git for windows. Most tutorials on git usage will apply.
-- http://code.google.com/p/tortoisegit/ - this puts a pretty, graphical face on top of msysgit :)
-
The code resides here: https://github.com/peterix/dfhack
-If you just want to compile DFHack or work on it by contributing patches, it's quite enough to clone from the read-only address:
--git clone git://github.com/peterix/dfhack.git -cd dfhack -git submodule init -git submodule update --
The tortoisegit GUI should have the equivalent options included.
-If you want to get really involved with the development, create an account on github, make a clone there and then use that as your remote repository instead. Detailed instructions are beyond the scope of this document. If you need help, join us on IRC (#dfhack channel on freenode).
-First, you need cmake. Get the win32 installer version from the official -site: http://www.cmake.org/cmake/resources/software.html
-It has the usual installer wizard. Make sure you let it add its binary folder -to your binary search PATH so the tool can be later run from anywhere.
-You'll need a copy of Microsoft Visual C++ 2010. The Express version is sufficient. -Grab it from Microsoft's site.
-For the code generation parts, you'll need perl and XML::LibXML. You can install them like this:
-If you already have a different version of perl (for example the one from cygwin), you can run into some trouble. Either remove the other perl install from PATH, or install libxml and libxslt for it instead. Strawberry perl works though and has all the required packages.
-There are several different batch files in the build folder along with a script that's used for picking the DF path.
-First, run set_df_path.vbs and point the dialog that pops up at your DF folder that you want to use for development. -Next, run one of the scripts with generate prefix. These create the MSVC solution file(s):
-Then you can either open the solution with MSVC or use one of the msbuild scripts:
-When you open the solution in MSVC, make sure you never use the Debug builds. Those aren't -binary-compatible with DF. If you try to use a debug build with DF, you'll only get crashes. -So pick either Release or RelWithDebInfo build and build the INSTALL target.
-The debug scripts actually do RelWithDebInfo builds.
-cmake allows you to pick a build type by changing this -variable: CMAKE_BUILD_TYPE
--cmake .. -DCMAKE_BUILD_TYPE:string=BUILD_TYPE --
Without specifying a build type or 'None', cmake uses the -CMAKE_CXX_FLAGS variable for building.
-Valid and useful build types include 'Release', 'Debug' and -'RelWithDebInfo'. 'Debug' is not available on Windows.
-Currently, the most direct way to use the library is to write a plugin that can be loaded by it. -All the plugins can be found in the 'plugins' folder. There's no in-depth documentation -on how to write one yet, but it should be easy enough to copy one and just follow the pattern.
-Other than through plugins, it is possible to use DFHack via remote access interface, or by writing Lua scripts.
-The most important parts of DFHack are the Core, Console, Modules and Plugins.
-Rudimentary API documentation can be built using doxygen (see build options with ccmake or cmake-gui).
-DFHack consists of variously licensed code, but invariably weak copyleft. -The main license is zlib/libpng, some bits are MIT licensed, and some are BSD licensed.
-Feel free to add your own extensions and plugins. Contributing back to -the dfhack repository is welcome and the right thing to do :)
-DFHack uses information about the game data structures, represented via xml files in the library/xml/ submodule.
-Data structure layouts are described in files following the df.*.xml name pattern. This information is transformed by a perl script into C++ headers describing the structures, and associated metadata for the Lua wrapper. These headers and data are then compiled into the DFHack libraries, thus necessitating a compatibility break every time layouts change; in return it significantly boosts the efficiency and capabilities of DFHack code.
-Global object addresses are stored in symbols.xml, which is copied to the dfhack release package and loaded as data at runtime.
-DFHack supports remote access by exchanging Google protobuf messages via a TCP socket. Both the core and plugins can define remotely accessible methods. The dfhack-run command uses this interface to invoke ordinary console commands.
-Currently the supported set of requests is limited, because the developers don't know what exactly is most useful.
-Protocol client implementations exist for Java and C#.
-Several things should be kept in mind when contributing to DFHack.
-DFhack uses ANSI formatting and four spaces as indentation. Line -endings are UNIX. The files use UTF-8 encoding. Code not following this -won't make me happy, because I'll have to fix it. There's a good chance -I'll make you fix it ;)
-You can send patches or make a clone of the github repo and ask me on -the IRC channel to pull your code in. I'll review it and see if there -are any problems. I'll fix them if they are minor.
-Fixes are higher in priority. If you want to work on something, but -don't know what, check out http://github.com/peterix/dfhack/issues -- -this is also a good place to dump new ideas and/or bugs that need -fixing.
-If you want to do memory research, you'll need some tools and some knowledge. -In general, you'll need a good memory viewer and optionally something -to look at machine code without getting crazy :)
-Good windows tools include:
-Good linux tools:
-Using publicly known information and analyzing the game's data is preferred.
-Contents
-The current version of DFHack has extensive support for -the Lua scripting language, providing access to:
-Lua code can be used both for writing scripts, which -are treated by DFHack command line prompt almost as -native C++ commands, and invoked by plugins written in c++.
-This document describes native API available to Lua in detail. -It does not describe all of the utility functions -implemented by Lua files located in hack/lua/...
-DF structures described by the xml files in library/xml are exported -to lua code as a tree of objects and functions under the df global, -which broadly maps to the df namespace in C++.
-WARNING: The wrapper provides almost raw access to the memory -of the game, so mistakes in manipulating objects are as likely to -crash the game as equivalent plain C++ code would be. E.g. NULL -pointer access is safely detected, but dangling pointers aren't.
-Objects managed by the wrapper can be broadly classified into the following groups:
-Typed object pointers (references).
-References represent objects in DF memory with a known type.
-In addition to fields and methods defined by the wrapped type, -every reference has some built-in properties and methods.
-Untyped pointers
-Represented as lightuserdata.
-In assignment to a pointer NULL can be represented either as -nil, or a NULL lightuserdata; reading a NULL pointer field -returns nil.
-Named types
-Objects in the df tree that represent identity of struct, class, -enum and bitfield types. They host nested named types, static -methods, builtin properties & methods, and, for enums and bitfields, -the bi-directional mapping between key names and values.
-The global object
-df.global corresponds to the df::global namespace, and -behaves as a mix between a named type and a reference, containing -both nested types and fields corresponding to global symbols.
-In addition to the global object and top-level types the df -global also contains a few global builtin utility functions.
-The underlying primitive lua object is userdata with a metatable. -Every structured field access produces a new userdata instance.
-All typed objects have the following built-in features:
-ref1 == ref2, tostring(ref)
-References implement equality by type & pointer value, and string conversion.
-pairs(ref)
-Returns an iterator for the sequence of actual C++ field names -and values. Fields are enumerated in memory order. Methods and -lua wrapper properties are not included in the iteration.
-WARNING: a few of the data structures (like ui_look_list) -contain unions with pointers to different types with vtables. -Using pairs on such structs is an almost sure way to crash with -an access violation.
-ref._kind
-Returns one of: primitive, struct, container, -or bitfield, as appropriate for the referenced object.
-ref._type
-Returns the named type object or a string that represents -the referenced object type.
-ref:sizeof()
-Returns size, address
-ref:new()
-Allocates a new instance of the same type, and copies data -from the current object.
-ref:delete()
-Destroys the object with the C++ delete operator. -If destructor is not available, returns false.
-WARNING: the lua reference object remains as a dangling -pointer, like a raw C++ pointer would.
-ref:assign(object)
-Assigns data from object to ref. Object must either be another -ref of a compatible type, or a lua table; in the latter case -special recursive assignment rules are applied.
-ref:_displace(index[,step])
-Returns a new reference with the pointer adjusted by index*step. -Step defaults to the natural object size.
-References of the _kind 'primitive' are used for objects -that don't fit any of the other reference types. Such -references can only appear as a value of a pointer field, -or as a result of calling the _field() method.
-They behave as structs with one field value of the right type.
-To make working with numeric buffers easier, they also allow -numeric indices. Note that other than excluding negative values -no bound checking is performed, since buffer length is not available. -Index 0 is equivalent to the value field.
-Struct references are used for class and struct objects.
-They implement the following features:
-ref.field, ref.field = value
-Valid fields of the structure may be accessed by subscript.
-Primitive typed fields, i.e. numbers & strings, are converted -to/from matching lua values. The value of a pointer is a reference -to the target, or nil/NULL. Complex types are represented by -a reference to the field within the structure; unless recursive -lua table assignment is used, such fields can only be read.
-NOTE: In case of inheritance, superclass fields have precedence -over the subclass, but fields shadowed in this way can still -be accessed as ref['subclasstype.field']. -This shadowing order is necessary because vtable-based classes -are automatically exposed in their exact type, and the reverse -rule would make access to superclass fields unreliable.
-ref._field(field)
-Returns a reference to a valid field. That is, unlike regular -subscript, it returns a reference to the field within the structure -even for primitive typed fields and pointers.
-ref:vmethod(args...)
-Named virtual methods are also exposed, subject to the same -shadowing rules.
-pairs(ref)
-Enumerates all real fields (but not methods) in memory -(= declaration) order.
-Containers represent vectors and arrays, possibly resizable.
-A container field can associate an enum to the container -reference, which allows accessing elements using string keys -instead of numerical indices.
-Implemented features:
-ref._enum
-If the container has an associated enum, returns the matching -named type object.
-#ref
-Returns the length of the container.
-ref[index]
-Accesses the container element, using either a 0-based numerical -index, or, if an enum is associated, a valid enum key string.
-Accessing an invalid index is an error, but some container types -may return a default value, or auto-resize instead for convenience. -Currently this relaxed mode is implemented by df-flagarray aka BitArray.
-ref._field(index)
-Like with structs, returns a pointer to the array element, if possible. -Flag and bit arrays cannot return such pointer, so it fails with an error.
-pairs(ref), ipairs(ref)
-If the container has no associated enum, both behave identically, -iterating over numerical indices in order. Otherwise, ipairs still -uses numbers, while pairs tries to substitute enum keys whenever -possible.
-ref:resize(new_size)
-Resizes the container if supported, or fails with an error.
-ref:insert(index,item)
-Inserts a new item at the specified index. To add at the end, -use #ref, or just '#' as index.
-ref:erase(index)
-Removes the element at the given valid index.
-Bitfields behave like special fixed-size containers. -Consider them to be something in between structs and -fixed-size vectors.
-The _enum property points to the bitfield type. -Numerical indices correspond to the shift value, -and if a subfield occupies multiple bits, the -ipairs order would have a gap.
-Since currently there is no API to allocate a bitfield -object fully in GC-managed lua heap, consider using the -lua table assignment feature outlined below in order to -pass bitfield values to dfhack API functions that need -them, e.g. matinfo:matches{metal=true}.
-Named types are exposed in the df tree with names identical -to the C++ version, except for the :: vs . difference.
-All types and the global object have the following features:
-type._kind
-Evaluates to one of struct-type, class-type, enum-type, -bitfield-type or global.
-type._identity
-Contains a lightuserdata pointing to the underlying -DFHack::type_instance object.
-Types excluding the global object also support:
-type:sizeof()
-Returns the size of an object of the type.
-type:new()
-Creates a new instance of an object of the type.
-type:is_instance(object)
-Returns true if object is same or subclass type, or a reference -to an object of same or subclass type. It is permissible to pass -nil, NULL or non-wrapper value as object; in this case the -method returns nil.
-In addition to this, enum and bitfield types contain a -bi-directional mapping between key strings and values, and -also map _first_item and _last_item to the min and -max values.
-Struct and class types with instance-vector attribute in the -xml have a type.find(key) function that wraps the find -method provided in C++.
-The df table itself contains the following functions and values:
-NULL, df.NULL
-Contains the NULL lightuserdata.
-df.isnull(obj)
-Evaluates to true if obj is nil or NULL; false otherwise.
-df.isvalid(obj[,allow_null])
-For supported objects returns one of type, voidptr, ref.
-If allow_null is true, and obj is nil or NULL, returns null.
-Otherwise returns nil.
-df.sizeof(obj)
-For types and refs identical to obj:sizeof(). -For lightuserdata returns nil, address
-df.new(obj), df.delete(obj), df.assign(obj, obj2)
-Equivalent to using the matching methods of obj.
-df._displace(obj,index[,step])
-For refs equivalent to the method, but also works with -lightuserdata (step is mandatory then).
-df.is_instance(type,obj)
-Equivalent to the method, but also allows a reference as proxy for its type.
-df.new(ptype[,count])
-Allocate a new instance, or an array of built-in types. -The ptype argument is a string from the following list: -string, int8_t, uint8_t, int16_t, uint16_t, -int32_t, uint32_t, int64_t, uint64_t, bool, -float, double. All of these except string can be -used with the count argument to allocate an array.
-df.reinterpret_cast(type,ptr)
-Converts ptr to a ref of specified type. The type may be anything -acceptable to df.is_instance. Ptr may be nil, a ref, -a lightuserdata, or a number.
-Returns nil if NULL, or a ref.
-Recursive assignment is invoked when a lua table is assigned -to a C++ object or field, i.e. one of:
-The general mode of operation is that all fields of the table -are assigned to the fields of the target structure, roughly -emulating the following code:
--function rec_assign(ref,table) - for key,value in pairs(table) do - ref[key] = value - end -end --
Since assigning a table to a field using = invokes the same -process, it is recursive.
-There are however some variations to this process depending -on the type of the field being assigned to:
-If the table contains an assign field, it is -applied first, using the ref:assign(value) method. -It is never assigned as a usual field.
-When a table is assigned to a non-NULL pointer field -using the ref.field = {...} syntax, it is applied -to the target of the pointer instead.
-If the pointer is NULL, the table is checked for a new field:
-After this auto-vivification process, assignment proceeds -as if the pointer wasn't NULL.
-Obviously, the new field inside the table is always skipped -during the actual per-field assignment processing.
-If the target of the assignment is a container, a separate -rule set is used:
-If the table contains neither assign nor resize -fields, it is interpreted as an ordinary 1-based lua -array. The container is resized to the #-size of the -table, and elements are assigned in numeric order:
--ref:resize(#table); -for i=1,#table do ref[i-1] = table[i] end --
Otherwise, resize must be true, false, or -an explicit number. If it is not false, the container -is resized. After that the usual struct-like 'pairs' -assignment is performed.
-In case resize is true, the size is computed -by scanning the table for the largest numeric key.
-This means that in order to reassign only one element of -a container using this system, it is necessary to use:
-
-{ resize=false, [idx]=value }
-
-Since nil inside a table is indistinguishable from missing key, -it is necessary to use df.NULL as a null pointer value.
-This system is intended as a way to define a nested object -tree using pure lua data structures, and then materialize it in -C++ memory in one go. Note that if pointer auto-vivification -is used, an error in the middle of the recursive walk would -not destroy any objects allocated in this way, so the user -should be prepared to catch the error and do the necessary -cleanup.
-DFHack utility functions are placed in the dfhack global tree.
-dfhack.print(args...)
-Output tab-separated args as standard lua print would do, -but without a newline.
-print(args...), dfhack.println(args...)
-A replacement of the standard library print function that -works with DFHack output infrastructure.
-dfhack.printerr(args...)
-Same as println; intended for errors. Uses red color and logs to stderr.log.
-dfhack.color([color])
-Sets the current output color. If color is nil or -1, resets to default. -Returns the previous color value.
-dfhack.is_interactive()
-Checks if the thread can access the interactive console and returns true or false.
-dfhack.lineedit([prompt[,history_filename]])
-If the thread owns the interactive console, shows a prompt -and returns the entered string. Otherwise returns nil, error.
-Depending on the context, this function may actually yield the -running coroutine and let the C++ code release the core suspend -lock. Using an explicit dfhack.with_suspend will prevent -this, forcing the function to block on input with lock held.
-dfhack.interpreter([prompt[,history_filename[,env]]])
-Starts an interactive lua interpreter, using the specified prompt -string, global environment and command-line history file.
-If the interactive console is not accessible, returns nil, error.
-dfhack.error(msg[,level[,verbose]])
-Throws a dfhack exception object with location and stack trace. -The verbose parameter controls whether the trace is printed by default.
-qerror(msg[,level])
-Calls dfhack.error() with verbose being false. Intended to -be used for user-caused errors in scripts, where stack traces are not -desirable.
-dfhack.pcall(f[,args...])
-Invokes f via xpcall, using an error function that attaches -a stack trace to the error. The same function is used by SafeCall -in C++, and dfhack.safecall.
-safecall(f[,args...]), dfhack.safecall(f[,args...])
-Just like pcall, but also prints the error using printerr before -returning. Intended as a convenience function.
-dfhack.saferesume(coroutine[,args...])
-Compares to coroutine.resume like dfhack.safecall vs pcall.
-dfhack.exception
-Metatable of error objects used by dfhack. The objects have the -following properties:
-The location prefix string, or nil.
-The base message string.
-The stack trace string, or nil.
-A different exception object, or nil.
-The coroutine that has thrown the exception.
-Boolean, or nil; specifies if where and stacktrace should be printed.
-Converts the exception to string.
-dfhack.exception.verbose
-The default value of the verbose argument of err:tostring().
-dfhack.VERSION
-DFHack version string constant.
-dfhack.curry(func,args...), or curry(func,args...)
-Returns a closure that invokes the function with args combined -both from the curry call and the closure call itself. I.e. -curry(func,a,b)(c,d) equals func(a,b,c,d).
-dfhack.with_suspend(f[,args...])
-Calls f with arguments after grabbing the DF core suspend lock. -Suspending is necessary for accessing a consistent state of DF memory.
-Returned values and errors are propagated through after releasing -the lock. It is safe to nest suspends.
-Every thread is allowed only one suspend per DF frame, so it is best -to group operations together in one big critical section. A plugin -can choose to run all lua code inside a C++-side suspend lock.
-dfhack.call_with_finalizer(num_cleanup_args,always,cleanup_fn[,cleanup_args...],fn[,args...])
-Invokes fn with args, and after it returns or throws an -error calls cleanup_fn with cleanup_args. Any return values from -fn are propagated, and errors are re-thrown.
-The num_cleanup_args integer specifies the number of cleanup_args, -and the always boolean specifies if cleanup should be called in any case, -or only in case of an error.
-dfhack.with_finalize(cleanup_fn,fn[,args...])
-Calls fn with arguments, then finalizes with cleanup_fn. -Implemented using call_with_finalizer(0,true,...).
-dfhack.with_onerror(cleanup_fn,fn[,args...])
-Calls fn with arguments, then finalizes with cleanup_fn on any thrown error. -Implemented using call_with_finalizer(0,false,...).
-dfhack.with_temp_object(obj,fn[,args...])
-Calls fn(obj,args...), then finalizes with obj:delete().
-This api is intended for storing configuration options in the world itself. -It probably should be restricted to data that is world-dependent.
-Entries are identified by a string key, but it is also possible to manage -multiple entries with the same key; their identity is determined by entry_id. -Every entry has a mutable string value, and an array of 7 mutable ints.
-dfhack.persistent.get(key), entry:get()
-Retrieves a persistent config record with the given string key, -or refreshes an already retrieved entry. If there are multiple -entries with the same key, it is undefined which one is retrieved -by the first version of the call.
-Returns entry, or nil if not found.
-dfhack.persistent.delete(key), entry:delete()
-Removes an existing entry. Returns true if succeeded.
-dfhack.persistent.get_all(key[,match_prefix])
-Retrieves all entries with the same key, or starting with key..'/'. -Calling get_all('',true) will match all entries.
-If none found, returns nil; otherwise returns an array of entries.
-dfhack.persistent.save({key=str1, ...}[,new]), entry:save([new])
-Saves changes in an entry, or creates a new one. Passing true as -new forces creation of a new entry even if one already exists; -otherwise the existing one is simply updated. -Returns entry, did_create_new
-Since the data is hidden in data structures owned by the DF world, -and automatically stored in the save game, these save and retrieval -functions can just copy values in memory without doing any actual I/O. -However, currently every entry has a 180+-byte dead-weight overhead.
-A material info record has fields:
-type, index, material
-DF material code pair, and a reference to the material object.
-mode
-One of 'builtin', 'inorganic', 'plant', 'creature'.
-inorganic, plant, creature
-If the material is of the matching type, contains a reference to the raw object.
-figure
-For a specific creature material contains a ref to the historical figure.
-Functions:
-dfhack.matinfo.decode(type,index)
-Looks up material info for the given number pair; if not found, returs nil.
-....decode(matinfo), ....decode(item), ....decode(obj)
-Uses matinfo.type/matinfo.index, item getter vmethods, -or obj.mat_type/obj.mat_index to get the code pair.
-dfhack.matinfo.find(token[,token...])
-Looks up material by a token string, or a pre-split string token sequence.
-dfhack.matinfo.getToken(...), info:getToken()
-Applies decode and constructs a string token.
-info:toString([temperature[,named]])
-Returns the human-readable name at the given temperature.
-info:getCraftClass()
-Returns the classification used for craft skills.
-info:matches(obj)
-Checks if the material matches job_material_category or job_item. -Accept dfhack_material_category auto-assign table.
-Thin wrappers around C++ functions, similar to the ones for virtual methods. -One notable difference is that these explicit wrappers allow argument count -adjustment according to the usual lua rules, so trailing false/nil arguments -can be omitted.
-dfhack.getOSType()
-Returns the OS type string from symbols.xml.
-dfhack.getDFVersion()
-Returns the DF version string from symbols.xml.
-dfhack.getDFPath()
-Returns the DF directory path.
-dfhack.getHackPath()
-Returns the dfhack directory path, i.e. ".../df/hack/".
-dfhack.getTickCount()
-Returns the tick count in ms, exactly as DF ui uses.
-dfhack.isWorldLoaded()
-Checks if the world is loaded.
-dfhack.isMapLoaded()
-Checks if the world and map are loaded.
-dfhack.TranslateName(name[,in_english,only_last_name])
-Convert a language_name or only the last name part to string.
-dfhack.gui.getCurViewscreen([skip_dismissed])
-Returns the topmost viewscreen. If skip_dismissed is true, -ignores screens already marked to be removed.
-dfhack.gui.getFocusString(viewscreen)
-Returns a string representation of the current focus position -in the ui. The string has a "screen/foo/bar/baz..." format.
-dfhack.gui.getCurFocus([skip_dismissed])
-Returns the focus string of the current viewscreen.
-dfhack.gui.getSelectedWorkshopJob([silent])
-When a job is selected in 'q' mode, returns the job, else -prints error unless silent and returns nil.
-dfhack.gui.getSelectedJob([silent])
-Returns the job selected in a workshop or unit/jobs screen.
-dfhack.gui.getSelectedUnit([silent])
-Returns the unit selected via 'v', 'k', unit/jobs, or -a full-screen item view of a cage or suchlike.
-dfhack.gui.getSelectedItem([silent])
-Returns the item selected via 'v' ->inventory, 'k', 't', or -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.
-dfhack.gui.showZoomAnnouncement(type,pos,text,color[,is_bright])
-Like above, but also specifies a position you can zoom to from the announcement menu.
-dfhack.gui.showPopupAnnouncement(text,color[,is_bright])
-Pops up a titan-style modal announcement window.
-dfhack.gui.showAutoAnnouncement(type,pos,text,color[,is_bright])
-Uses the type to look up options from announcements.txt, and calls the -above operations accordingly. If enabled, pauses and zooms to position.
-dfhack.job.cloneJobStruct(job)
-Creates a deep copy of the given job.
-dfhack.job.printJobDetails(job)
-Prints info about the job.
-dfhack.job.printItemDetails(jobitem,idx)
-Prints info about the job item.
-dfhack.job.getHolder(job)
-Returns the building holding the job.
-dfhack.job.getWorker(job)
-Returns the unit performing the job.
-dfhack.job.checkBuildingsNow()
-Instructs the game to check buildings for jobs next frame and assign workers.
-dfhack.job.checkDesignationsNow()
-Instructs the game to check designations for jobs next frame and assign workers.
-dfhack.job.is_equal(job1,job2)
-Compares important fields in the job and nested item structures.
-dfhack.job.is_item_equal(job_item1,job_item2)
-Compares important fields in the job item structures.
-dfhack.job.listNewlyCreated(first_id)
-Returns the current value of df.global.job_next_id, and -if there are any jobs with first_id <= id < job_next_id, -a lua list containing them.
-dfhack.units.getPosition(unit)
-Returns true x,y,z of the unit, or nil if invalid; may be not equal to unit.pos if caged.
-dfhack.units.getContainer(unit)
-Returns the container (cage) item or nil.
-dfhack.units.setNickname(unit,nick)
-Sets the unit's nickname properly.
-dfhack.units.getVisibleName(unit)
-Returns the language_name object visible in game, accounting for false identities.
-dfhack.units.getIdentity(unit)
-Returns the false identity of the unit if it has one, or nil.
-dfhack.units.getNemesis(unit)
-Returns the nemesis record of the unit if it has one, or nil.
-dfhack.units.isHidingCurse(unit)
-Checks if the unit hides improved attributes from its curse.
-dfhack.units.getPhysicalAttrValue(unit, attr_type)
-dfhack.units.getMentalAttrValue(unit, attr_type)
-Computes the effective attribute value, including curse effect.
-dfhack.units.isCrazed(unit)
-dfhack.units.isOpposedToLife(unit)
-dfhack.units.hasExtravision(unit)
-dfhack.units.isBloodsucker(unit)
-Simple checks of caste attributes that can be modified by curses.
-dfhack.units.getMiscTrait(unit, type[, create])
-Finds (or creates if requested) a misc trait object with the given id.
-dfhack.units.isDead(unit)
-The unit is completely dead and passive, or a ghost.
-dfhack.units.isAlive(unit)
-The unit isn't dead or undead.
-dfhack.units.isSane(unit)
-The unit is capable of rational action, i.e. not dead, insane, zombie, or active werewolf.
-dfhack.units.isDwarf(unit)
-The unit is of the correct race of the fortress.
-dfhack.units.isCitizen(unit)
-The unit is an alive sane citizen of the fortress; wraps the -same checks the game uses to decide game-over by extinction.
-dfhack.units.getAge(unit[,true_age])
-Returns the age of the unit in years as a floating-point value. -If true_age is true, ignores false identities.
-dfhack.units.getEffectiveSkill(unit, skill)
-Computes the effective rating for the given skill, taking into account exhaustion, pain etc.
-dfhack.units.computeMovementSpeed(unit)
-Computes number of frames * 100 it takes the unit to move in its current state of mind and body.
-dfhack.units.getNoblePositions(unit)
-Returns a list of tables describing noble position assignments, or nil. -Every table has fields entity, assignment and position.
-dfhack.units.getProfessionName(unit[,ignore_noble,plural])
-Retrieves the profession name using custom profession, noble assignments -or raws. The ignore_noble boolean disables the use of noble positions.
-dfhack.units.getCasteProfessionName(race,caste,prof_id[,plural])
-Retrieves the profession name for the given race/caste using raws.
-dfhack.units.getProfessionColor(unit[,ignore_noble])
-Retrieves the color associated with the profession, using noble assignments -or raws. The ignore_noble boolean disables the use of noble positions.
-dfhack.units.getCasteProfessionColor(race,caste,prof_id)
-Retrieves the profession color for the given race/caste using raws.
-dfhack.items.getPosition(item)
-Returns true x,y,z of the item, or nil if invalid; may be not equal to item.pos if in inventory.
-dfhack.items.getDescription(item, type[, decorate])
-Returns the string description of the item, as produced by the getItemDescription -method. If decorate is true, also adds markings for quality and improvements.
-dfhack.items.getGeneralRef(item, type)
-Searches for a general_ref with the given type.
-dfhack.items.getSpecificRef(item, type)
-Searches for a specific_ref with the given type.
-dfhack.items.getOwner(item)
-Returns the owner unit or nil.
-dfhack.items.setOwner(item,unit)
-Replaces the owner of the item. If unit is nil, removes ownership. -Returns false in case of error.
-dfhack.items.getContainer(item)
-Returns the container item or nil.
-dfhack.items.getContainedItems(item)
-Returns a list of items contained in this one.
-dfhack.items.moveToGround(item,pos)
-Move the item to the ground at position. Returns false if impossible.
-dfhack.items.moveToContainer(item,container)
-Move the item to the container. Returns false if impossible.
-dfhack.items.moveToBuilding(item,building,use_mode)
-Move the item to the building. Returns false if impossible.
-dfhack.items.moveToInventory(item,unit,use_mode,body_part)
-Move the item to the unit inventory. Returns false if impossible.
-dfhack.items.remove(item[, no_uncat])
-Removes the item, and marks it for garbage collection unless no_uncat is true.
-dfhack.items.makeProjectile(item)
-Turns the item into a projectile, and returns the new object, or nil if impossible.
-dfhack.maps.getSize()
-Returns map size in blocks: x, y, z
-dfhack.maps.getTileSize()
-Returns map size in tiles: x, y, z
-dfhack.maps.getBlock(x,y,z)
-Returns a map block object for given x,y,z in local block coordinates.
-dfhack.maps.isValidTilePos(coords), or isValidTilePos(x,y,z)``
-Checks if the given df::coord or x,y,z in local tile coordinates are valid.
-dfhack.maps.getTileBlock(coords), or getTileBlock(x,y,z)
-Returns a map block object for given df::coord or x,y,z in local tile coordinates.
-dfhack.maps.ensureTileBlock(coords), or ensureTileBlock(x,y,z)
-Like getTileBlock, but if the block is not allocated, try creating it.
-dfhack.maps.getRegionBiome(region_coord2d), or getRegionBiome(x,y)
-Returns the biome info struct for the given global map region.
-dfhack.maps.enableBlockUpdates(block[,flow,temperature])
-Enables updates for liquid flow or temperature, unless already active.
-dfhack.maps.spawnFlow(pos,type,mat_type,mat_index,dimension)
-Spawns a new flow (i.e. steam/mist/dust/etc) at the given pos, and with -the given parameters. Returns it, or nil if unsuccessful.
-dfhack.maps.getGlobalInitFeature(index)
-Returns the global feature object with the given index.
-dfhack.maps.getLocalInitFeature(region_coord2d,index)
-Returns the local feature object with the given region coords and index.
-dfhack.maps.getTileBiomeRgn(coords), or getTileBiomeRgn(x,y,z)
-Returns x, y for use with getRegionBiome.
-dfhack.maps.canWalkBetween(pos1, pos2)
-Checks if a dwarf may be able to walk between the two tiles, -using a pathfinding cache maintained by the game. Note that -this cache is only updated when the game is unpaused, and thus -can get out of date if doors are forbidden or unforbidden, or -tools like liquids or tiletypes are used. It also cannot possibly -take into account anything that depends on the actual units, like -burrows, or the presence of invaders.
-dfhack.burrows.findByName(name)
-Returns the burrow pointer or nil.
-dfhack.burrows.clearUnits(burrow)
-Removes all units from the burrow.
-dfhack.burrows.isAssignedUnit(burrow,unit)
-Checks if the unit is in the burrow.
-dfhack.burrows.setAssignedUnit(burrow,unit,enable)
-Adds or removes the unit from the burrow.
-dfhack.burrows.clearTiles(burrow)
-Removes all tiles from the burrow.
-dfhack.burrows.listBlocks(burrow)
-Returns a table of map block pointers.
-dfhack.burrows.isAssignedTile(burrow,tile_coord)
-Checks if the tile is in burrow.
-dfhack.burrows.setAssignedTile(burrow,tile_coord,enable)
-Adds or removes the tile from the burrow. Returns false if invalid coords.
-dfhack.burrows.isAssignedBlockTile(burrow,block,x,y)
-Checks if the tile within the block is in burrow.
-dfhack.burrows.setAssignedBlockTile(burrow,block,x,y,enable)
-Adds or removes the tile from the burrow. Returns false if invalid coords.
-dfhack.buildings.setOwner(item,unit)
-Replaces the owner of the building. If unit is nil, removes ownership. -Returns false in case of error.
-dfhack.buildings.getSize(building)
-Returns width, height, centerx, centery.
-dfhack.buildings.findAtTile(pos), or findAtTile(x,y,z)
-Scans the buildings for the one located at the given tile. -Does not work on civzones. Warning: linear scan if the map -tile indicates there are buildings at it.
-dfhack.buildings.findCivzonesAt(pos), or findCivzonesAt(x,y,z)
-Scans civzones, and returns a lua sequence of those that touch -the given tile, or nil if none.
-dfhack.buildings.getCorrectSize(width, height, type, subtype, custom, direction)
-Computes correct dimensions for the specified building type and orientation, -using width and height for flexible dimensions. -Returns is_flexible, width, height, center_x, center_y.
-dfhack.buildings.checkFreeTiles(pos,size[,extents,change_extents,allow_occupied])
-Checks if the rectangle defined by pos and size, and possibly extents, -can be used for placing a building. If change_extents is true, bad tiles -are removed from extents. If allow_occupied, the occupancy test is skipped.
-dfhack.buildings.countExtentTiles(extents,defval)
-Returns the number of tiles included by extents, or defval.
-dfhack.buildings.containsTile(building, x, y[, room])
-Checks if the building contains the specified tile, either directly, or as room.
-dfhack.buildings.hasSupport(pos,size)
-Checks if a bridge constructed at specified position would have -support from terrain, and thus won't collapse if retracted.
-Low-level building creation functions;
-dfhack.buildings.allocInstance(pos, type, subtype, custom)
-Creates a new building instance of given type, subtype and custom type, -at specified position. Returns the object, or nil in case of an error.
-dfhack.buildings.setSize(building, width, height, direction)
-Configures an object returned by allocInstance, using specified -parameters wherever appropriate. If the building has fixed size along -any dimension, the corresponding input parameter will be ignored. -Returns false if the building cannot be placed, or true, width, -height, rect_area, true_area. Returned width and height are the -final values used by the building; true_area is less than rect_area -if any tiles were removed from designation.
-dfhack.buildings.constructAbstract(building)
-Links a fully configured object created by allocInstance into the -world. The object must be an abstract building, i.e. a stockpile or civzone. -Returns true, or false if impossible.
-dfhack.buildings.constructWithItems(building, items)
-Links a fully configured object created by allocInstance into the -world for construction, using a list of specific items as material. -Returns true, or false if impossible.
-dfhack.buildings.constructWithFilters(building, job_items)
-Links a fully configured object created by allocInstance into the -world for construction, using a list of job_item filters as inputs. -Returns true, or false if impossible. Filter objects are claimed -and possibly destroyed in any case. -Use a negative quantity field value to auto-compute the amount -from the size of the building.
-dfhack.buildings.deconstruct(building)
-Destroys the building, or queues a deconstruction job. -Returns true if the building was destroyed and deallocated immediately.
-More high-level functions are implemented in lua and can be loaded by -require('dfhack.buildings'). See hack/lua/dfhack/buildings.lua.
-Among them are:
-dfhack.buildings.getFiltersByType(argtable,type,subtype,custom)
-Returns a sequence of lua structures, describing input item filters -suitable for the specified building type, or nil if unknown or invalid. -The returned sequence is suitable for use as the job_items argument -of constructWithFilters. -Uses tables defined in buildings.lua.
-Argtable members material (the default name), bucket, barrel, -chain, mechanism, screw, pipe, anvil, weapon are used to -augment the basic attributes with more detailed information if the -building has input items with the matching name (see the tables for naming details). -Note that it is impossible to override any properties this way, only supply those that -are not mentioned otherwise; one exception is that flags2.non_economic -is automatically cleared if an explicit material is specified.
-dfhack.buildings.constructBuilding{...}
-Creates a building in one call, using options contained -in the argument table. Returns the building, or nil, error.
-NOTE: Despite the name, unless the building is abstract, -the function creates it in an 'unconstructed' stage, with -a queued in-game job that will actually construct it. I.e. -the function replicates programmatically what can be done -through the construct building menu in the game ui, except -that it does less environment constraint checking.
-The following options can be used:
-pos = coordinates, or x = ..., y = ..., z = ...
-Mandatory. Specifies the left upper corner of the building.
-type = df.building_type.FOO, subtype = ..., custom = ...
-Mandatory. Specifies the type of the building. Obviously, subtype -and custom are only expected if the type requires them.
-fields = { ... }
-Initializes fields of the building object after creation with df.assign.
-width = ..., height = ..., direction = ...
-Sets size and orientation of the building. If it is -fixed-size, specified dimensions are ignored.
-full_rectangle = true
-For buildings like stockpiles or farm plots that can normally -accomodate individual tile exclusion, forces an error if any -tiles within the specified width*height are obstructed.
-items = { item, item ... }, or filters = { {...}, {...}... }
-Specifies explicit items or item filters to use in construction. -It is the job of the user to ensure they are correct for the building type.
-abstract = true
-Specifies that the building is abstract and does not require construction. -Required for stockpiles and civzones; an error otherwise.
-material = {...}, mechanism = {...}, ...
-If none of items, filter, or abstract is used, -the function uses getFiltersByType to compute the input -item filters, and passes the argument table through. If no filters -can be determined this way, constructBuilding throws an error.
-dfhack.constructions.designateNew(pos,type,item_type,mat_index)
-Designates a new construction at given position. If there already is -a planned but not completed construction there, changes its type. -Returns true, or false if obstructed. -Note that designated constructions are technically buildings.
-dfhack.constructions.designateRemove(pos), or designateRemove(x,y,z)
-If there is a construction or a planned construction at the specified -coordinates, designates it for removal, or instantly cancels the planned one. -Returns true, was_only_planned if removed; or false if none found.
-The screen module implements support for drawing to the tiled screen of the game. -Note that drawing only has any effect when done from callbacks, so it can only -be feasibly used in the core context.
-Basic painting functions:
-dfhack.screen.getWindowSize()
-Returns width, height of the screen.
-dfhack.screen.getMousePos()
-Returns x,y of the tile the mouse is over.
-dfhack.screen.inGraphicsMode()
-Checks if [GRAPHICS:YES] was specified in init.
-dfhack.screen.paintTile(pen,x,y[,char,tile])
-Paints a tile using given parameters. Pen is a table with following possible fields:
-Provides the ordinary tile character, as either a 1-character string or a number. -Can be overridden with the char function parameter.
-Foreground color for the ordinary tile. Defaults to COLOR_GREY (7).
-Background color for the ordinary tile. Defaults to COLOR_BLACK (0).
-Bright/bold text flag. If nil, computed based on (fg & 8); fg is masked to 3 bits. -Otherwise should be true/false.
-Graphical tile id. Ignored unless [GRAPHICS:YES] was in init.txt.
-Specifies that the tile should be shaded with fg/bg.
-If specified, overrides tile_color and supplies shading colors directly.
-Returns false if coordinates out of bounds, or other error.
-dfhack.screen.readTile(x,y)
-Retrieves the contents of the specified tile from the screen buffers. -Returns a pen, or nil if invalid or TrueType.
-dfhack.screen.paintString(pen,x,y,text)
-Paints the string starting at x,y. Uses the string characters -in sequence to override the ch field of pen.
-Returns true if painting at least one character succeeded.
-dfhack.screen.fillRect(pen,x1,y1,x2,y2)
-Fills the rectangle specified by the coordinates with the given pen. -Returns true if painting at least one character succeeded.
-dfhack.screen.findGraphicsTile(pagename,x,y)
-Finds a tile from a graphics set (i.e. the raws used for creatures), -if in graphics mode and loaded.
-Returns: tile, tile_grayscale, or nil if not found. -The values can then be used for the tile field of pen structures.
-dfhack.screen.clear()
-Fills the screen with blank background.
-dfhack.screen.invalidate()
-Requests repaint of the screen by setting a flag. Unlike other -functions in this section, this may be used at any time.
-In order to actually be able to paint to the screen, it is necessary -to create and register a viewscreen (basically a modal dialog) with -the game.
-NOTE: As a matter of policy, in order to avoid user confusion, all -interface screens added by dfhack should bear the "DFHack" signature.
-Screens are managed with the following functions:
-dfhack.screen.show(screen[,below])
-Displays the given screen, possibly placing it below a different one. -The screen must not be already shown. Returns true if success.
-dfhack.screen.dismiss(screen[,to_first])
-Marks the screen to be removed when the game enters its event loop. -If to_first is true, all screens up to the first one will be deleted.
-dfhack.screen.isDismissed(screen)
-Checks if the screen is already marked for removal.
-Apart from a native viewscreen object, these functions accept a table -as a screen. In this case, show creates a new native viewscreen -that delegates all processing to methods stored in that table.
-NOTE: Lua-implemented screens are only supported in the core context.
-Supported callbacks and fields are:
-screen._native
-Initialized by show with a reference to the backing viewscreen -object, and removed again when the object is deleted.
-function screen:onShow()
-Called by dfhack.screen.show if successful.
-function screen:onDismiss()
-Called by dfhack.screen.dismiss if successful.
-function screen:onDestroy()
-Called from the destructor when the viewscreen is deleted.
-function screen:onResize(w, h)
-Called before onRender or onIdle when the window size has changed.
-function screen:onRender()
-Called when the viewscreen should paint itself. This is the only context -where the above painting functions work correctly.
-If omitted, the screen is cleared; otherwise it should do that itself. -In order to make a see-through dialog, call self._native.parent:render().
-function screen:onIdle()
-Called every frame when the screen is on top of the stack.
-function screen:onHelp()
-Called when the help keybinding is activated (usually '?').
-function screen:onInput(keys)
-Called when keyboard or mouse events are available. -If any keys are pressed, the keys argument is a table mapping them to true. -Note that this refers to logical keybingings computed from real keys via -options; if multiple interpretations exist, the table will contain multiple keys.
-The table also may contain special keys:
-Maps to an integer in range 0-255. Duplicates a separate "STRING_A???" code for convenience.
-If the left or right mouse button is pressed.
-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.
-These functions are intended for the use by dfhack developers, -and are only documented here for completeness:
-dfhack.internal.scripts
-The table used by dfhack.run_script() to give every script its own -global environment, persistent between calls to the script.
-dfhack.internal.getAddress(name)
-Returns the global address name, or nil.
-dfhack.internal.setAddress(name, value)
-Sets the global address name. Returns the value of getAddress before the change.
-dfhack.internal.getVTable(name)
-Returns the pre-extracted vtable address name, or nil.
-dfhack.internal.getRebaseDelta()
-Returns the ASLR rebase offset of the DF executable.
-dfhack.internal.getMemRanges()
-Returns a sequence of tables describing virtual memory ranges of the process.
-dfhack.internal.patchMemory(dest,src,count)
-Like memmove below, but works even if dest is read-only memory, e.g. code. -If destination overlaps a completely invalid memory region, or another error -occurs, returns false.
-dfhack.internal.memmove(dest,src,count)
-Wraps the standard memmove function. Accepts both numbers and refs as pointers.
-dfhack.internal.memcmp(ptr1,ptr2,count)
-Wraps the standard memcmp function.
-dfhack.internal.memscan(haystack,count,step,needle,nsize)
-Searches for needle of nsize bytes in haystack, -using count steps of step bytes. -Returns: step_idx, sum_idx, found_ptr, or nil if not found.
-dfhack.internal.diffscan(old_data, new_data, start_idx, end_idx, eltsize[, oldval, newval, delta])
-Searches for differences between buffers at ptr1 and ptr2, as integers of size eltsize. -The oldval, newval or delta arguments may be used to specify additional constraints. -Returns: found_index, or nil if end reached.
-While plugins can create any number of interpreter instances, -there is one special context managed by dfhack core. It is the -only context that can receive events from DF and plugins.
-Core context specific functions:
-dfhack.is_core_context
-Boolean value; true in the core context.
-dfhack.timeout(time,mode,callback)
-Arranges for the callback to be called once the specified -period of time passes. The mode argument specifies the -unit of time used, and may be one of 'frames' (raw FPS), -'ticks' (unpaused FPS), 'days', 'months', -'years' (in-game time). All timers other than -'frames' are cancelled when the world is unloaded, -and cannot be queued until it is loaded again. -Returns the timer id, or nil if unsuccessful due to -world being unloaded.
-dfhack.timeout_active(id[,new_callback])
-Returns the active callback with the given id, or nil -if inactive or nil id. If called with 2 arguments, replaces -the current callback with the given value, if still active. -Using timeout_active(id,nil) cancels the timer.
-dfhack.onStateChange.foo = function(code)
-Event. Receives the same codes as plugin_onstatechange in C++.
-An event is a native object transparently wrapping a lua table, -and implementing a __call metamethod. When it is invoked, it loops -through the table with next and calls all contained values. -This is intended as an extensible way to add listeners.
-This type itself is available in any context, but only the -core context has the actual events defined by C++ code.
-Features:
-dfhack.event.new()
-Creates a new instance of an event.
-event[key] = function
-Sets the function as one of the listeners. Assign nil to remove it.
-NOTE: The df.NULL key is reserved for the use by -the C++ owner of the event; it is an error to try setting it.
-#event
-Returns the number of non-nil listeners.
-pairs(event)
-Iterates over all listeners in the table.
-event(args...)
-Invokes all listeners contained in the event in an arbitrary -order using dfhack.safecall.
-DFHack sets up the lua interpreter so that the built-in require -function can be used to load shared lua code from hack/lua/. -The dfhack namespace reference itself may be obtained via -require('dfhack'), although it is initially created as a -global by C++ bootstrap code.
-The following module management functions are provided:
-mkmodule(name)
-Creates an environment table for the module. Intended to be used as:
-
-local _ENV = mkmodule('foo')
-...
-return _ENV
-
-If called the second time, returns the same table; thus providing reload support.
-reload(name)
-Reloads a previously require-d module "name" from the file. -Intended as a help for module development.
-dfhack.BASE_G
-This variable contains the root global environment table, which is -used as a base for all module and script environments. Its contents -should be kept limited to the standard Lua library and API described -in this document.
-A number of variables and functions are provided in the base global -environment by the mandatory init file dfhack.lua:
-Color constants
-These are applicable both for dfhack.color() and color fields -in DF functions or structures:
-COLOR_RESET, COLOR_BLACK, COLOR_BLUE, COLOR_GREEN, COLOR_CYAN, -COLOR_RED, COLOR_MAGENTA, COLOR_BROWN, COLOR_GREY, COLOR_DARKGREY, -COLOR_LIGHTBLUE, COLOR_LIGHTGREEN, COLOR_LIGHTCYAN, COLOR_LIGHTRED, -COLOR_LIGHTMAGENTA, COLOR_YELLOW, COLOR_WHITE
-dfhack.onStateChange event codes
-Available only in the core context, as is the event itself:
-SC_WORLD_LOADED, SC_WORLD_UNLOADED, SC_MAP_LOADED, -SC_MAP_UNLOADED, SC_VIEWSCREEN_CHANGED, SC_CORE_INITIALIZED
-Functions already described above
-safecall, qerror, mkmodule, reload
-printall(obj)
-If the argument is a lua table or DF object reference, prints all fields.
-copyall(obj)
-Returns a shallow copy of the table or reference as a lua table.
-pos2xyz(obj)
-The object must have fields x, y and z. Returns them as 3 values. -If obj is nil, or x is -30000 (the usual marker for undefined -coordinates), returns nil.
-xyz2pos(x,y,z)
-Returns a table with x, y and z as fields.
-safe_index(obj,index...)
-Walks a sequence of dereferences, which may be represented by numbers or strings. -Returns nil if any of obj or indices is nil, or a numeric index is out of array bounds.
-utils.compare(a,b)
-Comparator function; returns -1 if a<b, 1 if a>b, 0 otherwise.
-utils.compare_name(a,b)
-Comparator for names; compares empty string last.
-utils.is_container(obj)
-Checks if obj is a container ref.
-utils.make_index_sequence(start,end)
-Returns a lua sequence of numbers in start..end.
-utils.make_sort_order(data, ordering)
-Computes a sorted permutation of objects in data, as a table of integer -indices into the data sequence. Uses data.n as input length -if present.
-The ordering argument is a sequence of ordering specs, represented -as lua tables with following possible fields:
-Computes comparison key from input data value. Not called on nil. -If omitted, the comparison key is the value itself.
-Computes a key table from the data table in one go.
-Comparison function. Defaults to utils.compare above. -Called on non-nil keys; nil sorts last.
-If true, nil keys are sorted first instead of last.
-If true, sort non-nil keys in descending order.
-For every comparison during sorting the specs are applied in -order until an unambiguous decision is reached. Sorting is stable.
-Example of sorting a sequence by field foo:
-
-local spec = { key = function(v) return v.foo end }
-local order = utils.make_sort_order(data, { spec })
-local output = {}
-for i = 1,#order do output[i] = data[order[i]] end
-
-Separating the actual reordering of the sequence in this -way enables applying the same permutation to multiple arrays. -This function is used by the sort plugin.
-utils.assign(tgt, src)
-Does a recursive assignment of src into tgt. -Uses df.assign if tgt is a native object ref; otherwise -recurses into lua tables.
-utils.clone(obj, deep)
-Performs a shallow, or semi-deep copy of the object as a lua table tree. -The deep mode recurses into lua tables and subobjects, except pointers -to other heap objects. -Null pointers are represented as df.NULL. Zero-based native containers -are converted to 1-based lua sequences.
-utils.clone_with_default(obj, default, force)
-Copies the object, using the default lua table tree -as a guide to which values should be skipped as uninteresting. -The force argument makes it always return a non-nil value.
-utils.sort_vector(vector,field,cmpfun)
-Sorts a native vector or lua sequence using the comparator function. -If field is not nil, applies the comparator to the field instead -of the whole object.
-utils.binsearch(vector,key,field,cmpfun,min,max)
-Does a binary search in a native vector or lua sequence for -key, using cmpfun and field like sort_vector. -If min and max are specified, they are used as the -search subrange bounds.
-If found, returns item, true, idx. Otherwise returns -nil, false, insert_idx, where insert_idx is the correct -insertion point.
-utils.insert_sorted(vector,item,field,cmpfun)
-Does a binary search, and inserts item if not found. -Returns did_insert, vector[idx], idx.
-utils.insert_or_update(vector,item,field,cmpfun)
-Like insert_sorted, but also assigns the item into -the vector cell if insertion didn't happen.
-As an example, you can use this to set skill values:
-
-utils.insert_or_update(soul.skills, {new=true, id=..., rating=...}, 'id')
-
-(For an explanation of new=true, see table assignment in the wrapper section)
-utils.prompt_yes_no(prompt, default)
-Presents a yes/no prompt to the user. If default is not nil, -allows just pressing Enter to submit the default choice. -If the user enters 'abort', throws an error.
-utils.prompt_input(prompt, checkfun, quit_str)
-Presents a prompt to input data, until a valid string is entered. -Once checkfun(input) returns true, ..., passes the values -through. If the user enters the quit_str (defaults to '~~~'), -throws an error.
-utils.check_number(text)
-A prompt_input checkfun that verifies a number input.
-A third-party lua table dumper module from -http://lua-users.org/wiki/DataDumper. Defines one -function:
-dumper.DataDumper(value, varname, fastmode, ident, indent_step)
-Returns value converted to a string. The indent_step -argument specifies the indentation step size in spaces. For -the other arguments see the original documentation link above.
-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:
-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.
-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.
-Implements extended burrow manipulations.
-Events:
-onBurrowRename.foo = function(burrow)
-Emitted when a burrow might have been renamed either through -the game UI, or renameBurrow().
-onDigComplete.foo = function(job_type,pos,old_tiletype,new_tiletype,worker)
-Emitted when a tile might have been dug out. Only tracked if the -auto-growing burrows feature is enabled.
-Native functions:
-renameBurrow(burrow,name)
-Renames the burrow, emitting onBurrowRename and updating auto-grow state properly.
-findByName(burrow,name)
-Finds a burrow by name, using the same rules as the plugin command line interface. -Namely, trailing '+' characters marking auto-grow burrows are ignored.
-copyUnits(target,source,enable)
-Applies units from source burrow to target. The enable -parameter specifies if they are to be added or removed.
-copyTiles(target,source,enable)
-Applies tiles from source burrow to target. The enable -parameter specifies if they are to be added or removed.
-setTilesByKeyword(target,keyword,enable)
-Adds or removes tiles matching a predefined keyword. The keyword -set is the same as used by the command line.
-The lua module file also re-exports functions from dfhack.burrows.
-Does not export any native functions as of now. Instead, it -calls lua code to perform the actual ordering of list items.
-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 -the extension.
-If the first line of the script is a one-line comment, it is -used by the built-in ls and help commands.
-NOTE: Scripts placed in subdirectories still can be accessed, but -do not clutter the ls command list; thus it is preferred -for obscure developer-oriented scripts and scripts used by tools. -When calling such scripts, always use '/' as the separator for -directories, e.g. devel/lua-example.
-Scripts are re-read from disk every time they are used -(this may be changed later to check the file change time); however -the global variable values persist in memory between calls. -Every script gets its own separate environment for global -variables.
-Arguments are passed in to the scripts via the ... built-in -quasi-variable; when the script is called by the DFHack core, -they are all guaranteed to be non-nil strings.
-DFHack core invokes the scripts in the core context (see above); -however it is possible to call them from any lua code (including -from other scripts) in any context, via the same function the core uses:
-dfhack.run_script(name[,args...])
-Run a lua script in hack/scripts/, as if it was started from dfhack command-line. -The name argument should be the name stem, as would be used on the command line.
-Note that this function lets errors propagate to the caller.
-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 -access DF memory and allow for easier development of new tools.
-Contents
-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
-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 -for older versions, look for older releases.
-On Windows, you have to use the SDL version of DF.
-It is possible to use the Windows DFHack under wine/OSX.
-Installing DFhack involves copying files into your DF folder. -Copy the files from a release archive so that:
----
-- On Windows, SDL.dll is replaced
-- On Linux, the 'dfhack' script is placed in the same folder as the 'df' script
-
Uninstalling is basically the same, in reverse:
----
-- On Windows, first delete SDL.dll and rename SDLreal.dll to SDL.dll. Then -remove the other DFHack files
-- On Linux, Remove the DFHack files.
-
The stonesense plugin might require some additional libraries on Linux.
-If any of the plugins or dfhack itself refuses to load, check the stderr.log -file created in your DF folder.
-DFHack basically extends what DF can do with something similar to the drop-down -console found in Quake engine games. On Windows, this is a separate command line -window. On linux, the terminal used to launch the dfhack script is taken over -(so, make sure you start from a terminal). Basic interaction with dfhack -involves entering commands into the console. For some basic instroduction, -use the 'help' command. To list all possible commands, use the 'ls' command. -Many commands have their own help or detailed description. You can use -'command help' or 'command ?' to show that.
-The command line has some nice line editing capabilities, including history -that's preserved between different runs of DF (use up/down keys to go through -the history).
-The second way to interact with DFHack is to bind the available commands -to in-game hotkeys. The old way to do this is via the hotkey/zoom menu (normally -opened with the 'h' key). Binding the commands is done by assigning a command as -a hotkey name (with 'n').
-A new and more flexible way is the keybinding command in the dfhack console. -However, bindings created this way are not automatically remembered between runs -of the game, so it becomes necessary to use the dfhack.init file to ensure that -they are re-created every time it is loaded.
-Interactive commands like 'liquids' cannot be used as hotkeys.
-Most of the commands come from plugins. Those reside in 'hack/plugins/'.
-First, don't panic :) Second, dfhack keeps a few log files in DF's folder -- stderr.log and stdout.log. You can look at those and possibly find out what's -happening. -If you found a bug, you can either report it in the bay12 DFHack thread, -the issues tracker on github, contact me (peterix@gmail.com) or visit the -#dfhack IRC channel on freenode.
-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.
-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.
-DFHack command syntax consists of a command name, followed by arguments separated -by whitespace. To include whitespace in an argument, quote it in double quotes. -To include a double quote character, use \" inside double quotes.
-If the first non-whitespace character of a line is #, the line is treated -as a comment, i.e. a silent no-op command.
-If the first non-whitespace character is :, the command is parsed in a special -alternative mode: first, non-whitespace characters immediately following the : -are used as the command name; the remaining part of the line, starting with the first -non-whitespace character after the command name, is used verbatim as the first argument. -The following two command lines are exactly equivalent:
----
-- :foo a b "c d" e f
-- foo "a b \"c d\" e f"
-
This is intended for commands like rb_eval that evaluate script language statements.
-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.
-Instantly kills DF without saving.
-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'
-
Disables pausing (both manual and automatic) with the exception of pause forced -by 'reveal hell'. This is nice for digging under rivers.
-Makes your minions move at ludicrous speeds.
----
-- Activate with 'fastdwarf 1'
-- Deactivate with 'fastdwarf 0'
-
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.
-Toggle between all possible positions where the idlers count can be placed.
-Toggle between displaying/not displaying liquid depth as numbers.
-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.
-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. -
This allows taking control over your followers and other creatures in adventure -mode. For example, you can make them pick up new arms and armor and equip them -properly.
-Usage:
----
-- When viewing unit details, body-swaps into that unit.
-- In the main adventure mode screen, reverts transient swap.
-
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. -
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 -changes only the layer at the cursor position. Note that one layer can stretch -across lots of z levels. By default changes only the geology which is linked -to the biome under the cursor. That geology might be linked to other biomes -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:
----
-- - - - 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 -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 -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 -will allow the floor to be engraved. -Note that stone will not be magically replaced with soil. -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. -
Examples:
----
-- changelayer GRANITE
-- Convert layer at cursor position into granite.
-- changelayer SILTY_CLAY force
-- Convert layer at cursor position into clay even if it's stone.
-- changelayer MARBLE all_biomes all_layers
-- Convert all layers of all biomes which are not soil into marble.
-
Note
-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
-- Convert vein at cursor position into platinum ore.
-
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 -is of the same subtype (for example wood<->wood, stone<->stone etc). But since -some transformations work pretty well and may be desired you can override this -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:
----
-- - - - 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
-- Change material of all items under the cursor to granite.
-- changeitem q 5
-- Change currently selected item to masterpiece quality.
-
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 -
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).
-Enables management of map features.
-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. -
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.
-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.
-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 -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.
-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.
-The properties of filter and paint can be partially defined. This means that -you can for example do something like this:
--filter material STONE -filter shape FORTIFICATION -paint shape FLOOR --
This will turn all stone fortifications into floors, preserving the material.
-Or this:
--filter shape FLOOR -filter material MINERAL -paint shape WALL --
Turning mineral vein floors back into walls.
-The tool also allows tweaking some tile flags:
-Or this:
--paint hidden 1 -paint hidden 0 --
This will hide previously revealed tiles (or show hidden with the 0 option).
-Any paint or filter option (or the entire paint or filter) can be disabled entirely by using the ANY keyword:
--paint hidden ANY -paint shape ANY -filter material any -filter shape any -filter any --
Example:
--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.
-Runs tiletypes commands, separated by ;. This makes it possible to change -tiletypes modes from a hotkey.
-Apply the current tiletypes options at the in-game cursor position, including -the brush. Can be used from a hotkey.
-Apply the current tiletypes options at the in-game cursor position to a single -tile. Can be used from a hotkey.
-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).
-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! -
Makes all saplings present on the map grow into trees (almost) instantly.
-Very similar to extirpate, but additionally sets the plants on fire. The fires -can and will spread ;)
-Regrows grass. Not much to it ;)
-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. -- rain: make it rain. -- - clear: clear the sky. -
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). -- 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). -
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
-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.
-Can be used to determine tile properties like temperature.
-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'. -
If prospect is called during the embark selection screen, it displays an estimate of -layer stone availability.
-Note
-The results of pre-embark prospect are an estimate, and can at best be expected -to be somewhere within +/- 30% of the true amount; sometimes it does a lot worse. -Especially, it is not clear how to precisely compute how many soil layers there -will be in a given embark tile, so it can report a whole extra layer, or omit one -that is actually present.
-Options:
----
-- - - - - all: Also estimate vein mineral amounts. -
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'.
-Reverts the effects of 'reveal'.
-Switches between 'reveal' and 'unreveal'.
-This command will hide the whole map and then reveal all the tiles that have -a path to the in-game cursor.
-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.
-Shows all items needed for the currently active strange mood.
-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. -
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).
-A permanent alias for 'digv x'.
-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).
-A permanent alias for 'digl x'.
-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:
----
-- - - - diag5: diagonals separated by 5 tiles -- diag5r: diag5 rotated 90 degrees -- ladder: A 'ladder' pattern -- ladderr: ladder rotated 90 degrees -- clear: Just remove all dig designations -- - cross: A cross, exactly in the middle of the map. -
Filters:
----
-- - - - 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.
-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
-
A command for easy designation of filled and hollow circles. -It has several types of options.
-Shape:
----
-- - - - hollow: Set the circle to hollow (default) -- filled: Set the circle to filled -- - #: Diameter in tiles (default = 0, does nothing) -
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:
-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.-
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.-
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.
-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. -
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.
-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). -
Destroy items marked for dumping under cursor. Identical to autodump -destroy-here, but intended for use as keybinding.
-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.
-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.
-
This utility removes water from all buckets in your fortress, allowing them to be safely used for making lye.
-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.
-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.
-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.
-Contains various tweaks for minor bugs.
-One-shot subcommands:
-| clear-missing: | Remove the missing status from the selected unit. -This allows engraving slabs for ghostly, but not yet -found, creatures. | -
|---|---|
| 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. | -
| 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). | -
| 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. | -
Subcommands that persist until disabled or DF quit:
-| stable-cursor: | Saves the exact cursor position between t/q/k/d/etc menus of dwarfmode. | -
|---|---|
| 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). | -
| readable-build-plate: | |
| Fixes rendering of creature weight limits in pressure plate build menu. | -|
| 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% | -
| 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. | -|
| fast-trade: | Makes Shift-Enter in the Move Goods to Depot and Trade screens select -the current item (fully, in case of a stack), and scroll down one line. | -
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) -
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
-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
-Export the current loaded map as a file. This will be eventually usable -with visualizers.
-Export dwarves to RuneSmith-compatible XML.
-Command for general job query and manipulation.
-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.
-
Manage control of repeat jobs.
-Usage:
----
-- workflow enable [option...], workflow disable [option...]
-- -
If no options are specified, enables or disables the plugin. -Otherwise, enables or disables any of the following options:
--
-- drybuckets: Automatically empty abandoned water buckets.
-- auto-melt: Resume melt jobs when there are objects to melt.
-- workflow jobs
-- List workflow-controlled jobs (if in a workshop, filtered by it).
-- workflow list
-- List active constraints, and their job counts.
-- workflow count <constraint-spec> <cnt-limit> [cnt-gap], workflow amount <constraint-spec> <cnt-limit> [cnt-gap]
-- Set a constraint. The first form counts each stack as only 1 item.
-- workflow unlimit <constraint-spec>
-- Delete a constraint.
-
When the plugin is enabled, it protects all repeat jobs from removal. -If they do disappear due to any cause, they are immediately re-added to their -workshop and suspended.
-In addition, when any constraints on item amounts are set, repeat jobs that -produce that kind of item are automatically suspended and resumed as the item -amount goes above or below the limit. The gap specifies how much below the limit -the amount has to drop before jobs are resumed; this is intended to reduce -the frequency of jobs being toggled.
-Keep metal bolts within 900-1000, and wood/bone within 150-200.
--workflow amount AMMO:ITEM_AMMO_BOLTS/METAL 1000 100 -workflow amount AMMO:ITEM_AMMO_BOLTS/WOOD,BONE 200 50 --
Keep the number of prepared food & drink stacks between 90 and 120
--workflow count FOOD 120 30 -workflow count DRINK 120 30 --
Make sure there are always 25-30 empty bins/barrels/bags.
--workflow count BIN 30 -workflow count BARREL 30 -workflow count BOX/CLOTH,SILK,YARN 30 --
Make sure there are always 15-20 coal and 25-30 copper bars.
--workflow count BAR//COAL 20 -workflow count BAR//COPPER 30 --
Collect 15-20 sand bags and clay boulders.
--workflow count POWDER_MISC/SAND 20 -workflow count BOULDER/CLAY 20 --
Make sure there are always 80-100 units of dimple dye.
-- workflow amount POWDER_MISC//MUSHROOM_CUP_DIMPLE:MILL 100 20 - -In order for this to work, you have to set the material of the PLANT input -on the Mill Plants job to MUSHROOM_CUP_DIMPLE using the 'job item-material' -command. --
Tool for turning cooking of seeds and plants on/off depending on how much you -have of them.
-See 'seedwatch help' for detailed description.
-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. -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 -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 -be selected in the in-game ui. -- 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. -
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. -
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 -on the map (in 'v' or 'k' mode), in the unit list or from inside cages -and use 'zone assign' to assign them to their new home. Allows pitting your -own dwarves, by the way.
-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. -It's not possible to cage owned pets because in that case the owner -uncages them after a while which results in infinite hauling back and forth.
-Usually you should always use the filter 'own' (which implies tame) unless you -want to use the zone tool for pitting hostiles. 'own' ignores own dwarves unless -you specify 'race DWARF' (so it's safe to use 'assign all own' to one big -pasture if you want to have all your animals at the same place). 'egglayer' and -'milkable' should be used together with 'female' unless you have a mod with -egg-laying male elves who give milk or whatever. Merchants and their animals are -ignored unless you specify 'merchant' (pitting them should be no problem, -but stealing and pasturing their animals is not a good idea since currently they -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).
-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.
-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 -to build cages and then place one pen/pasture activity zone above them, covering -all cages you want to use. Then use 'zone set' (like with 'assign') and use -'zone tocages filter1 filter2 ...'. 'tocages' overwrites 'assign' because it -would make no sense, but can be used together with 'nick' or 'remnick' and all -the usual filters.
-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 -of the size. The age of the units is currently not checked, most birds grow up -quite fast. Egglayers who are also grazers will be ignored, since confining them -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:
----
-- - - - 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. -
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 -autobutcher you can give them nicknames with the tool 'rename unit' for single -units or with 'zone nick' to mass-rename units in pastures and cages).
-Creatures trained for war or hunting will be ignored as well.
-Creatures assigned to cages will be ignored if the cage is defined as a room -(to avoid butchering unnamed zoo animals).
-Once you have too much adults, the oldest will be butchered first. -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:
----
-- - - - 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 -to allow that the older ones grow into adults. Any unnamed cats will -be slaughtered as soon as possible.
--autobutcher target 4 3 2 1 ALPACA BIRD_TURKEY -autobutcher target 0 0 0 0 CAT -autobutcher watch ALPACA BIRD_TURKEY CAT -autobutcher start --
Automatically put all new races onto the watchlist and mark unnamed tame units -for slaughter as soon as they arrive in your fort. Settings already made -for specific races will be left untouched.
--autobutcher target 0 0 0 0 new -autobutcher autowatch -autobutcher start --
Stop watching the races alpaca and cat, but remember the target count -settings so that you can use 'unwatch' without the need to enter the -values again. Note: 'autobutcher unwatch all' works, but only makes sense -if you want to keep the plugin running with the 'autowatch' feature or manually -add some new races with 'watch'. If you simply want to stop it completely use -'autobutcher stop' instead.
--autobutcher unwatch ALPACA CAT --
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:
--Load savegame where you made the settings. -Start a CMD shell and navigate to the df directory. Type the following into the shell: -dfhack-run autobutcher list_export > autobutcher.bat -Load the savegame where you want to copy the settings to, run the batch file (from the shell): -autobutcher.bat --
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 -also tries to have dwarves specialize in specific skills.
-Note
-Warning: autolabor will override any manual changes you make to labors -while it is enabled.
-For detailed usage information, see 'help autolabor'.
-Makes cats just multiply. It is not a good idea to run this more than once or -twice.
-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
-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:
-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.
-Scripts that implement dialogs inserted into the main game window are put in this -directory.
-If called in dwarf mode, makes DF immediately auto-save the game by setting a flag -normally used in seasonal auto-save.
-Run setfps <number> to set the FPS cap at runtime, in case you want to watch -combat in slow motion or something :)
-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 -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.
-Instantly grow seeds inside farming plots.
-With no argument, this command list the various seed types currently in -use in your farming plots. -With a seed type, the script will grow 100 of these seeds, ready to be -harvested. You can change the number with a 2nd argument.
-For exemple, to grow 40 plump helmet spawn:
--growcrops plump 40 --
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 -clear all your fort's units minds.
-Individual dwarf happiness may not increase right after this command is run, -but in the short term your dwarves will get much more joyful. -The thoughts are set to be very old, and the game will remove them soon when -you unpause.
-With the optional -v parameter, the script will dump the negative thoughts -it removed.
-Kills any unit of a given race.
-With no argument, lists the available races.
-With the special argument 'him', targets only the selected creature.
-Any non-dead non-caged unit of the specified race gets its blood_count -set to 0, which means immediate death at the next game tick. For creatures -such as vampires, also set animal.vanish_countdown to 2.
-An alternate mode is selected by adding a 2nd argument to the command, -magma. In this case, a column of 7/7 magma is generated on top of the -targets until they die (Warning: do not call on magma-safe creatures. Also, -using this mode for birds is not recommanded.)
-Will target any unit on a revealed tile of the map, including ambushers.
-Ex:
--slayrace gob --
To kill a single creature, select the unit with the 'v' cursor and:
--slayrace him --
To purify all elves on the map with fire (may have side-effects):
--slayrace elve magma --
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.
-Place the game cursor where you want to create the source (must be a -flow-passable tile, and not too high in the sky) and call:
--magmasource here --
To add more than 1 unit everytime, call the command again.
-To delete one source, place the cursor over its tile and use delete-here. -To remove all placed sources, call magmasource stop.
-With no argument, this command shows an help message and list existing sources.
-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:
--# this is a comment -d;d;u;d;d;skip this tile;d -d;d;d;i --
Available tile shapes are named after the 'dig' menu shortcuts: -d for dig, u for upstairs, d downstairs, i updown, -h channel, r upward ramp, x remove designation. -Unrecognized characters are ignored (eg the 'skip this tile' in the sample).
-Empty lines and data after a # are ignored as comments. -To skip a row in your design, use a single ;.
-The script takes the plan filename, starting from the root df folder.
-Similar to fastdwarf, per-creature.
-To make any creature superfast, target it ingame using 'v' and:
--superdwarf add --
Other options available: del, clear, list.
-This plugin also shortens the 'sleeping' and 'on break' periods of targets.
-Remove all 'aquifer' tag from the map blocks. Irreversible.
-Focus a body part ingame, and this script will display the cause of death of -the creature.
-These tools work by displaying dialogs or overlays in the game window, and -are mostly implemented by lua scripts.
-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. The numpad Z-Up and Z-Down keys seek to the first or last unit -in the list.
-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, -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 -Manipulator and zoom to its position within your fortress.
-The following mouse shortcuts are also available:
-Pressing ESC normally returns to the unit screen, but Shift-ESC would exit -directly to the main dwarf mode screen.
-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.
-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.
-To exit, press ESC or Enter; ESC recenters on the original building, while Enter leaves -focus on the current one. Shift-Enter has an effect equivalent to pressing Enter, and then -re-entering the mechanisms ui.
-Backed by the rename plugin, the gui/rename script allows entering the desired name -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. -It is also possible to rename zones from the 'i' menu.
-gui/rename [unit] with a unit selected changes the nickname.
-gui/rename unit-profession changes the selected unit's custom profession name.
-The building or unit options are automatically assumed when in relevant ui state.
-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.
-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.
-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.
-The configuration front-end to the plugin is implemented by the gui/siege-engine -script. Bind it to a key and activate after selecting a siege engine in 'q' mode.
-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 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 (this doesn't actually change the original aiming -code, instead the projectile trajectory parameters are rewritten as soon as it appears).
-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.
-DISCLAIMER
-Siege engines are a very interesting feature, but sadly almost useless in the current state -because they haven't been updated since 2D and can only aim in four directions. This is an -attempt to bring them more up to date until Toady has time to work on it. Actual improvements, -e.g. like making siegers bring their own, are something only Toady can do.
-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 -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.
-The steam-engine plugin detects custom workshops with STEAM_ENGINE in -their token, and turns them into real steam engines.
-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 -limited in supply, or actually flowing and thus laggy.
-Steam engines are an alternative to water reactors that actually makes -sense, and hopefully doesn't lag. Also, unlike e.g. animal treadmills, -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.
-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 hooked, 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 hooked. 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.
-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 -in the 't' view of the workshop.
-Note
-The completion of the job will actually consume one unit -of the appropriate liquids from below the workshop. This means -that you cannot just raise 7 units of magma with a piston and -have infinite power. However, liquid consumption should be slow -enough that water can be supplied by a pond zone bucket chain.
-Every such item gives 100 power, up to a limit of 300 for coal, -and 500 for a magma engine. The building can host twice that -amount of items to provide longer autonomous running. When the -boiler gets filled to capacity, all queued jobs are suspended; -once it drops back to 3+1 or 5+1 items, they are re-enabled.
-While the engine is providing power, steam is being consumed. -The consumption speed includes a fixed 10% waste rate, and -the remaining 90% are applied proportionally to the actual -load in the machine. With the engine at nominal 300 power with -150 load in the system, it will consume steam for actual -300*(10% + 90%*150/300) = 165 power.
-Masterpiece mechanism and chain will decrease the mechanical -power drawn by the engine itself from 10 to 5. Masterpiece -barrel decreases waste rate by 4%. Masterpiece piston and pipe -decrease it by further 4%, and also decrease the whole steam -use rate by 10%.
-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 -eventually the engine explodes. It should also explode if -toppled during operation by a building destroyer, or a -tantruming dwarf.
-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 -to them, or machines they connect to (including by pulling levers), -can easily result in inconsistent state once this plugin is -available again. The effects may be as weird as negative power -being generated.
-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 -the clean items command.
-The plugin is 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, tweak fix-dimensions -and tweak advmode-contained.
-