025c9ff758
- 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 |
||
---|---|---|
.github | ||
CMake | ||
build | ||
data | ||
depends | ||
dfhack-config | ||
docs | ||
library | ||
package | ||
plugins | ||
scripts@cc202a95a7 | ||
test | ||
travis | ||
.gitignore | ||
.gitmodules | ||
.ycm_extra_conf.py | ||
CMakeLists.txt | ||
CMakeSettings.json | ||
LICENSE.rst | ||
README.html | ||
README.md | ||
conf.py | ||
dfhack.init-example | ||
index.rst | ||
onLoad.init-example |
README.md
DFHack Readme
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.