dfhack fork
 
 
 
 
 
 
Go to file
myk002 5869ba64c8
add tag description to the tag index page
this is a terrible hack that only works because sphinx doesn't sanitize
its input for the html builder. we set the title to

  '%s<h4>%s</h4>' % (tag, desc)

so the final html looks like <h1>adventure<h4>...</h4></h1>

this may not play nice with the pdf builder..
2022-09-23 10:21:53 -07:00
.github Merge branch 'develop' into docs 2022-08-15 17:09:36 -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 modify ci/script-docs.py to read new doc locations 2022-07-20 16:28:11 -07:00
data add keybinding for gui/workorder-details 2022-09-07 22:02:33 -07:00
depends Update clsocket 2022-09-02 11:25:41 -04:00
dfhack-config move dwarfmonitor's weather indicator to the right 2022-09-16 21:56:04 -07:00
docs add tag description to the tag index page 2022-09-23 10:21:53 -07:00
library implement basic domain index structure 2022-09-23 08:46:50 -07:00
package Apply initial pre-commit config 2022-04-12 14:48:19 -04:00
plugins don't display overlay on trade goods screen 2022-09-21 08:59:36 -07:00
scripts@8c03de45ba Auto-update submodules 2022-09-21 07:42:18 +00:00
test replace die's underline with tombstones 2022-09-23 08:34:22 -07:00
travis Add stubs in travis/ to call ci/ scripts 2021-09-05 23:08:01 -04:00
.gitignore clean up generate doc dirs with ninja clean 2022-08-05 22:05:52 -07:00
.gitmodules Disable shallow clones in .gitmodules 2021-08-11 21:54:05 -04:00
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate 2022-09-07 09:12:52 -07:00
.readthedocs.requirements.txt pin the sphinx version exactly at 4.4.0 2022-09-21 10:07:20 -07:00
.readthedocs.yml readthedocs doesn't like "all", list separately 2022-09-21 10:47:02 -07:00
.ycm_extra_conf.py Use jsoncpp 1.8.4 as a submodule 2018-06-14 21:20:46 +03:00
CMakeLists.txt include other doc build types in ninja clean 2022-08-26 13:37:58 -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 use a domain index instead of the genindex 2022-09-23 10:10:28 -07:00
index.rst organize tags by group, add more info about tools 2022-08-15 23:14:50 -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.