5f3d5bbcd5
This is more convenient for some devs than the old CMakeLists.custom.txt solution because it allows the plugins themselves (files or folders) to be ignored, rather than needing to remember to leave them unstaged. |
||
---|---|---|
.github | ||
CMake | ||
build | ||
ci | ||
data | ||
depends | ||
dfhack-config | ||
docs | ||
library | ||
package | ||
plugins | ||
scripts@a1df858afd | ||
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 | ||
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 checkout our support page for up-to-date options.