Updates spectate.rst

develop
Josh Cooper 2022-09-01 17:14:10 -07:00
parent cd34749fec
commit b3284c9d82
1 changed files with 24 additions and 1 deletions

@ -11,7 +11,30 @@ Usage
:: ::
enable spectate spectate
spectate <option>
The plugin will automatically switch which dwarf is being followed periodically, The plugin will automatically switch which dwarf is being followed periodically,
preferring dwarves on z-levels with the highest job activity. preferring dwarves on z-levels with the highest job activity.
Examples
--------
``spectate``
See the status of spectate, what is enabled or disabled.
``spectate enable``
Enable spectate plugin to pseudo-randomly follow dwarves around.
``spectate auto-unpause``
Enable the spectate plugin to automatically dismiss pause events caused
by the game. Siege events are one example of such a game event.
Options
-------
:no option: Show plugin status.
:enable: Enable plugin.
:disable: Disable plugin.
:auto-unpause: Toggle auto-dismissal of game pause events.