18 lines
958 B
Markdown
18 lines
958 B
Markdown
# DFHack Readme
|
|
|
|
[](https://github.com/DFHack/dfhack/actions?query=workflow%3ABuild)
|
|
[](https://dfhack.readthedocs.org)
|
|
[](https://en.wikipedia.org/wiki/Zlib_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](https://dfhack.readthedocs.org),
|
|
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](http://www.bay12forums.com/smf/index.php?topic=164123)
|
|
or the #dfhack IRC channel on freenode.
|