added doc and changelog entry for preserve-tombs plugin

develop
Najeeb Al-Shabibi 2023-09-29 14:21:44 +01:00
parent 0b2989fb15
commit df5de8b7ec
2 changed files with 23 additions and 0 deletions

@ -52,6 +52,7 @@ Template for new versions:
# Future
## New Tools
- `preserve-tombs`: tracks tomb assignments to living units and ensures that the tomb stays assigned to them when they die.
## New Features

@ -0,0 +1,22 @@
preserve-tombs
==============
.. dfhack-tool::
:summary: Fix tombs being unassigned to units on death
:tags: fort bugfix
If you find that the tombs you assign to units get unassigned from them when
they die (e.g. your nobles), this tool can help fix that.
Usage
-----
::
enable preserve-tombs
preserve-tombs status
This tool runs in the background. You can check the status of the plugin
by running ``preserve-tombs status`` which will show whether the plugin
is enabled and if so, display a list of all tracked tomb assignments
to living units.