realign the misery docs to the actual implementation

develop
Myk Taylor 2023-07-09 10:18:10 -07:00
parent 88732d724c
commit ff6f7c9454
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 10 additions and 8 deletions

@ -43,6 +43,7 @@ changelog.txt uses a syntax similar to RST, with a few special sequences:
- ``widgets.EditField``: DFHack edit fields now support cut/copy/paste with the system clipboard with Ctrl-X/Ctrl-C/Ctrl-V
## Documentation
- `misery`: rewrite the documentation to clarify the actual effects of the plugin
## API
- ``Units::getUnitByNobleRole``, ``Units::getUnitsByNobleRole``: unit lookup API by role

@ -2,11 +2,12 @@ misery
======
.. dfhack-tool::
:summary: Increase the intensity of your citizens' negative thoughts.
:summary: Lower the baseline for your citizens' happiness.
:tags: fort gameplay units
When enabled, negative thoughts that your citizens have will multiply by the
specified factor. This makes it more challenging to keep them happy.
When enabled, all of your citizens receive a negative thought about a
particularly nasty soapy bath. You can vary the strength of this negative
thought to increase or decrease the difficulty of keeping your citizens happy.
Usage
-----
@ -18,18 +19,18 @@ Usage
misery <factor>
misery clear
The default misery factor is ``2``, meaning that your dwarves will become
miserable twice as fast.
The default misery factor is ``2``, which will result in a moderate hit to your
dwarves' happiness. Larger numbers increase the challenge.
Examples
--------
``enable misery``
Start multiplying bad thoughts for your citizens!
Start adding bad thoughts about nasty soapy baths to your citizens!
``misery 5``
Make dwarves become unhappy 5 times faster than normal -- this is quite
challenging to handle!
Change the strength of the soapy bath negative thought to something quite
large -- this is very challenging to handle!
``misery clear``
Clear away negative thoughts added by ``misery``. Note that this will not