b361a66a52
* ensure our docs build cleanly with sphinx-5 * adapt to the API change in sphinx 5 while keeping compatibility with <5 * get rid of the extra colons in field lists |
||
---|---|---|
.github | ||
CMake | ||
build | ||
ci | ||
data | ||
depends | ||
dfhack-config | ||
docs | ||
library | ||
package | ||
plugins | ||
scripts@4941caccab | ||
test | ||
travis | ||
.gitignore | ||
.gitmodules | ||
.pre-commit-config.yaml | ||
.ycm_extra_conf.py | ||
CMakeLists.txt | ||
CMakeSettings.json | ||
LICENSE.rst | ||
README.html | ||
README.md | ||
conf.py | ||
dfhack.init-example | ||
index.rst |
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.
It is also accessible via 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 the docs are unclear or you need more help, please check out our support page for ways to contact the DFHack developers.