Skip to content
31 changes: 31 additions & 0 deletions docs/plugins/spectate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,22 @@ Settings
Toggle whether to prefer following (non-siege) units that have newly
arrived on the map.

``tooltip-follow`` (default: enabled)
If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
tooltip.

``tooltip-follow-blink-milliseconds`` (default: 3000)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we'll have to get feedback on this in the beta. It might make sense to default to always on for graphics mode but default to a slow blink for ascii. Other tools that display things over the map do that, like the warm/damp overlay and the gui/quickfort preview shadow.

If the ``spectate.tooltip`` overlay is enabled, set tooltip's blink duration
in milliseconds. Set to 0 to always show.

``tooltip-follow-job`` (default: enabled)
If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
job of the dwarf in the tooltip.

``tooltip-follow-job-shortenings``
If the ``spectate.tooltip`` overlay is enabled, this dictionary is used to
shorten some job names, f.e. "Store item in stockpile" becomes "Store item".

``tooltip-follow-name`` (default: enabled)
If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
name of the dwarf in the tooltip.
Expand All @@ -115,6 +127,15 @@ Settings
If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
happiness level (stress) of the dwarf in the tooltip.

``tooltip-follow-stress-levels`` (default: Displeased, Content, Pleased are disabled)
If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
specific happiness level (stress) of the dwarf in the tooltip. F.e.
``tooltip-follow-stress-levels 2 true`` would show Displeased emoticon.

``tooltip-hover`` (default: enabled)
If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
hover panel.

``tooltip-hover-job`` (default: enabled)
If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
job of the dwarf in the hover panel.
Expand All @@ -127,6 +148,16 @@ Settings
If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
happiness level (stress) of the dwarf in the hover panel.

``tooltip-hover-stress-levels`` (default: Displeased, Content, Pleased are disabled)
If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
specific happiness level (stress) of the dwarf in the hover panel. F.e.
``tooltip-hover-stress-levels 2 true`` would show Displeased emoticon.

``tooltip-stress-levels``
Controls how happiness levels (stress) are displayed (emoticon and color).
F.e. ``tooltip-stress-levels 6 text XD`` will change the emoticon for
Ecstatic dwarves to ``XD``.

Overlays
--------

Expand Down
Loading