add cautionary note about exposed secrets in the caverns

DFHack · Dec 31, 2023 · b3526a7 · b3526a7
1 parent 5d63e7a
commit b3526a7
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/docs/plugins/reveal.rst b/docs/plugins/reveal.rst
@@ -54,3 +54,14 @@ Usage
     forced by `reveal` ``hell``. This is nice for digging under rivers. Use
     ``nopause 1`` to prevent pausing and ``nopause 0`` to allow pausing like
     normal.
+
+Note
+----
+
+Sometimes, the map generates secret hollows adjacent to caverns in such a way
+that the ceiling of the hollow collapses on the first tick of the embark,
+leaving the hollow exposed to the caverns. In this case, the secret event will
+be triggered as soon as the cavern is discovered and that tile is unhidden.
+This would happen anyway even if you don't use `reveal`, but be aware that it
+is possible to trigger *some* events when you run `reveal`, even without the
+``hell`` option.