dfhack fork
 
 
 
 
 
 
Go to file
myk002 301c8e93a1
move builtin docs to individual files
2022-07-18 10:58:35 -07:00
.github Build and install text help alongside html (#2236) 2022-07-10 20:14:20 -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 reorganize init scripts into dfhack-config (#2232) 2022-07-10 08:54:55 -07:00
data support backtick as a keybinding 2022-07-11 17:23:56 -07:00
depends Auto-update submodules 2022-06-10 22:48:30 +00:00
dfhack-config add command frequency file based on survey results 2022-07-17 09:12:20 -07:00
docs move builtin docs to individual files 2022-07-18 10:58:35 -07:00
library move builtin docs to individual files 2022-07-18 10:58:35 -07:00
package Apply initial pre-commit config 2022-04-12 14:48:19 -04:00
plugins integrate hotkeys with helpdb 2022-07-15 09:44:24 -07:00
scripts@ef5fc459c4 Auto-update submodules 2022-07-10 07:17:43 +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 prepare for plugin doc split 2022-07-10 20:19:09 -07:00
.gitmodules Disable shallow clones in .gitmodules 2021-08-11 21:54:05 -04:00
.pre-commit-config.yaml Make the manager orders library available by default (#2233) 2022-07-06 07:03:29 -07:00
.ycm_extra_conf.py Use jsoncpp 1.8.4 as a submodule 2018-06-14 21:20:46 +03:00
CMakeLists.txt ensure all files are reread on every docs build 2022-07-10 20:19:12 -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 move builtin docs to individual files 2022-07-18 10:58:35 -07:00
index.rst move builtin docs to individual files 2022-07-18 10:58:35 -07: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.