dfhack fork
 
 
 
 
 
 
Go to file
Tim Siegel 8e18d610f5 cmake: Add SDL dep for Linux dfhack; deprecate BUILD_TESTS
On Linux, libdfhack.so depends on libSDL.so, but that was not marked
inside CMake. As it's only used via LD_PRELOAD, there was no problem.
But when linking unit tests against it, this becomes necessary. It may
be wise to add a find_package(SDL) to provide the user with more
control, but just a hard-coded "SDL" should work for most installs.

The CTest module creates a BUILD_TESTING option, which clashes
(thematically, not in code) with the existing BUILD_TESTS option.
Resolve it thus:
- Deprecate BUILD_TESTS; it still works, but is marked as an advanced
  option so it doesn't show in the CMake UI by default.
- Add a new BUILD_TEST_SCRIPTS that does what BUILD_TESTS used to do,
  but is a "dependent" option so it goes away if BUILD_TESTING=OFF.

The up-shot is that, by default, the C++ unit tests will be built
(BUILD_TESTING=ON) and the Lua integration tests are not installed
(BUILD_TEST_SCRIPTS=OFF).
2022-11-25 09:43:04 -08: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 Revert "Allowing whitespace-only lines." 2022-11-14 22:10:48 -05:00
data remove resume plugin 2022-11-21 15:27:40 -08:00
depends Update clsocket 2022-09-02 11:25:41 -04:00
dfhack-config remove resume plugin 2022-11-21 15:27:40 -08:00
docs Merge pull request #2111 from cppcooper/channel-safely 2022-11-23 12:41:50 -08:00
library cmake: Add SDL dep for Linux dfhack; deprecate BUILD_TESTS 2022-11-25 09:43:04 -08:00
package Apply initial pre-commit config 2022-04-12 14:48:19 -04:00
plugins Merge pull request #2111 from cppcooper/channel-safely 2022-11-23 12:41:50 -08:00
scripts@727e4921c0 Auto-update submodules 2022-11-23 19:33:21 +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 Disable shallow clones in .gitmodules 2021-08-11 21:54:05 -04: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 cmake: Add SDL dep for Linux dfhack; deprecate BUILD_TESTS 2022-11-25 09:43:04 -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 organize tags by group, add more info about tools 2022-08-15 23:14:50 -07: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.