dfhack fork
 
 
 
 
 
 
Go to file
myk002 025c9ff758
overhaul quickfort alias documentation
- move the alias syntax and usage docs from dfhack-config/quickfort/aliases.txt to a proper guide written in RST. Add examples and more details.
- move the alias library docs from data/quickfort/aliases-common.txt to the new guide
- reorder aliases in aliases-common to match the order in the docs
- factor out the character used to enter the stockpile config screen so we can use the same aliases for stockpiles and hauling routes (use 's' for stockpiles and '{Enter}' for hauling routes)
- reference the new guide in the quickfort user guide
- do an editorial pass of the quickfort user guide
  - change name to "Quickfort Blueprint Guide", but only in the text, not the filename, so we don't change the URL
  - add `quickfort-blueprint-guide` as a label, in addition to the existing `quickfort-user-guide`
  - changed table-like lists to actual tables
  - changed "grid" tables into "simple" tables where possible
  - used ':kbd:' markers whenever we refer to a single character
  - turned Meta blueprints and Notes blueprints sections into subsections of a new "Other blueprint modes" section, in preparation for a few new modes coming in -r5.
  - updated out-of date caveat about bookcases, display furniture, and offering places not being supported
2020-12-05 18:36:15 -08:00
.github Reduce build matrix entries 2020-10-26 01:23:24 -04:00
CMake Clean up *.cmake style 2019-07-20 16:17:44 -04:00
build Make the win64 build/install batch files work with non-C system drives. 2018-05-14 14:15:38 -05:00
data overhaul quickfort alias documentation 2020-12-05 18:36:15 -08:00
depends Also apply to xlsxio_write 2020-11-09 23:48:57 -05:00
dfhack-config overhaul quickfort alias documentation 2020-12-05 18:36:15 -08:00
docs overhaul quickfort alias documentation 2020-12-05 18:36:15 -08:00
library Update submodules 2020-12-04 23:55:43 -05:00
package Add --sizecheck option to Linux launcher script, update docs 2020-08-08 00:41:04 -04:00
plugins Merge remote-tracking branch 'PatrikLundell/embark-assistant' into develop 2020-12-04 23:54:50 -05:00
scripts@cc202a95a7 Update submodules 2020-12-04 23:55:43 -05:00
test Add test for get_initial_cwd() 2020-11-12 21:03:05 -05:00
travis exempt scripts under 'internal' from docstring req 2020-07-24 23:40:27 -07:00
.gitignore quickfort files and docs 2020-07-18 08:54:24 -07:00
.gitmodules Fix some CMake warnings and extraneous output 2020-09-19 01:17:25 -04:00
.ycm_extra_conf.py Use jsoncpp 1.8.4 as a submodule 2018-06-14 21:20:46 +03:00
CMakeLists.txt Update to 0.47.04-r3 (authors, changelog, and submodules) 2020-10-10 17:31:30 -04:00
CMakeSettings.json Get intellisense and code analysis working in CMakeSettings.json. 2018-07-23 16:14:22 -05:00
LICENSE.rst add libexpat, libzip, and xlsxio to LICENSE.rst 2020-11-18 19:04:56 -08:00
README.html Fix html redirection to the docs 2016-04-11 09:30:05 +10:00
README.md Restrict status badge to push events only 2020-04-15 01:15:09 -04:00
conf.py Update some docs links to use HTTPS 2020-10-09 19:17:59 -04:00
dfhack.init-example Activate autodump in default config 2020-04-01 15:09:51 +01:00
index.rst Add user guides section to main toctree 2020-10-01 22:17:53 -04:00
onLoad.init-example Remove warn-stuck-trees from onLoad.init-example 2017-12-23 20:49:24 -05:00

README.md

DFHack Readme

Build Status Documentation Status License

DFHack is a Dwarf Fortress memory access library, distributed with scripts and plugins implementing a wide variety of useful functions and tools.

The full documentation is available online here, from the README.html page in the DFHack distribution, or as raw text in the ./docs folder. If you're an end-user, modder, or interested in contributing to DFHack - go read those docs.

If that's unclear or you need more help, try the Bay12 forums thread or the #dfhack IRC channel on freenode.