dfhack fork
 
 
 
 
 
 
Go to file
Myk 697b727952
Merge pull request #2447 from myk002/myk_doc_fixup
Fix and organize docs
2022-11-30 10:39:50 -08:00
.github simplify the github action to just ninja test 2022-11-28 17:22:17 -08: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 update path references, move NEWS files back 2022-11-30 04:16:41 -08:00
data remove resume plugin 2022-11-21 15:27:40 -08:00
depends ugh unit tests don't work on our OSX build either 2022-11-30 06:57:11 -08:00
dfhack-config remove resume plugin 2022-11-21 15:27:40 -08:00
docs Merge pull request #2447 from myk002/myk_doc_fixup 2022-11-30 10:39:50 -08:00
library Merge pull request #2429 from cppcooper/patch-3 2022-11-29 18:43:04 -08:00
package Apply initial pre-commit config 2022-04-12 14:48:19 -04:00
plugins Merge pull request #2434 from cppcooper/channel-safely 2022-11-30 08:28:08 -08:00
scripts@ed57d138a7 Auto-update submodules 2022-11-29 23:10:05 +00:00
test we kept editfield as MOUSE_L for click and drag 2022-11-21 17:51:24 -08:00
travis Add stubs in travis/ to call ci/ scripts 2021-09-05 23:08:01 -04:00
.gitignore unit tests: Add CTest support, and a trivial first unit test 2022-11-25 09:43:04 -08:00
.gitmodules Update .gitmodules 2022-11-25 09:43:04 -08:00
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate 2022-11-07 21:21:27 +00:00
.readthedocs.requirements.txt pin the sphinx version exactly at 4.4.0 2022-09-21 10:07:20 -07:00
.readthedocs.yml ensure readthedocs checks out submodules 2022-09-23 16:09:46 -07:00
.ycm_extra_conf.py Use jsoncpp 1.8.4 as a submodule 2018-06-14 21:20:46 +03:00
CMakeLists.txt ugh unit tests don't work on our OSX build either 2022-11-30 06:57:11 -08: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 create robots.txt for HTML docs 2022-11-20 17:08:02 -08:00
index.rst move dev docs into dev dir 2022-11-30 04:01:32 -08:00
robots.txt create robots.txt for HTML docs 2022-11-20 17:08:02 -08: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.