dfhack fork
 
 
 
 
 
 
Go to file
Myk b361a66a52
ensure our docs build cleanly with sphinx-5 (#2193)
* 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
2022-06-17 09:35:31 -07:00
.github check for files, not md5 receipt in download-df.sh (#2196) 2022-06-09 11:21:14 -07:00
CMake Apply initial pre-commit config 2022-04-12 14:48:19 -04:00
build Apply initial pre-commit config 2022-04-12 14:48:19 -04:00
ci check for files, not md5 receipt in download-df.sh (#2196) 2022-06-09 11:21:14 -07:00
data don't try to build up stairs on flat ground 2022-06-10 15:59:19 -07:00
depends Auto-update submodules 2022-06-10 22:48:30 +00:00
dfhack-config Apply initial pre-commit config 2022-04-12 14:48:19 -04:00
docs ensure our docs build cleanly with sphinx-5 (#2193) 2022-06-17 09:35:31 -07:00
library Fix UNIT_NEW_ACTIVE events (#2197) 2022-06-17 09:34:41 -07:00
package Apply initial pre-commit config 2022-04-12 14:48:19 -04:00
plugins Fix UNIT_NEW_ACTIVE events (#2197) 2022-06-17 09:34:41 -07:00
scripts@4941caccab Auto-update submodules 2022-06-11 07:16:22 +00:00
test make the extra_fns functionality clearer 2022-06-06 16:44:11 -07:00
travis Add stubs in travis/ to call ci/ scripts 2021-09-05 23:08:01 -04:00
.gitignore Adds plugins/external/ and auto-populates the cmake within upon creation (#2095) 2022-04-27 19:53:05 -07:00
.gitmodules Disable shallow clones in .gitmodules 2021-08-11 21:54:05 -04:00
.pre-commit-config.yaml Upgrade pre-commit-hooks to v4.3.0 (+ submodules) 2022-06-08 17:48:14 -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 version, changelog, modules for 0.47.05-r5 2022-05-04 17:21:31 -07:00
CMakeSettings.json Get intellisense and code analysis working in CMakeSettings.json. 2018-07-23 16:14:22 -05:00
LICENSE.rst add luacov link to license list, install luacov 2021-03-07 08:15:05 -08:00
README.html Apply initial pre-commit config 2022-04-12 14:48:19 -04:00
README.md Clarify text and fix typos in the readme 2022-05-25 22:49:09 -07:00
conf.py ensure our docs build cleanly with sphinx-5 (#2193) 2022-06-17 09:35:31 -07:00
dfhack.init-example Improvements to dreamfort, quickfort keystroke aliases, and example orders (#2162) 2022-06-02 15:51:45 -07:00
index.rst Move support channels to a separate page and update 2021-06-15 00:03:24 -04:00

README.md

DFHack Readme

Build Status Documentation Status License Discord

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.