MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs for misery

develop
myk002 2022-07-28 02:46:48 -07:00
parent 6aabf5f3c3
commit 756900393f
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 17 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/plugins/misery.rst
Unescape Escape View File

@ -1,14 +1,18 @@
misery misery
====== ======
When enabled, fake bad thoughts will be added to all dwarves. Tags:
:dfhack-keybind:`misery`
Increase the intensity of negative dwarven thoughts.
When enabled, negative thoughts that your dwarves have will multiply by the
specified factor.
Usage: Usage:
:misery enable n: enable misery with optional magnitude n. If specified, n must ``enable misery``
be positive. Start multiplying negative thoughts.
:misery n: same as "misery enable n" ``misery <factor>``
:misery enable: same as "misery enable 1" Change the multiplicative factor of bad thoughts. The default is ``2``.
:misery disable: stop adding new negative thoughts. This will not remove ``misery clear``
existing negative thoughts. Equivalent to "misery 0". Clear away negative thoughts added by ``misery``.
:misery clear: remove fake thoughts, even after saving and reloading. Does
not change factor.

19
plugins/misery.cpp
Unescape Escape View File

@ -128,21 +128,10 @@ DFhackCExport command_result plugin_onupdate(color_ostream& out) {
} }
DFhackCExport command_result plugin_init(color_ostream& out, vector<PluginCommand> &commands) { DFhackCExport command_result plugin_init(color_ostream& out, vector<PluginCommand> &commands) {
commands.push_back(PluginCommand("misery", "increase the intensity of negative dwarven thoughts", commands.push_back(PluginCommand(
&misery, false, "misery",
"misery: When enabled, every new negative dwarven thought will be multiplied by a factor (2 by default).\n" "Increase the intensity of negative dwarven thoughts.",
"Usage:\n" misery));
" misery enable n\n"
" enable misery with optional magnitude n. If specified, n must be positive.\n"
" misery n\n"
" same as \"misery enable n\"\n"
" misery enable\n"
" same as \"misery enable 2\"\n"
" misery disable\n"
" stop adding new negative thoughts. This will not remove existing duplicated thoughts. Equivalent to \"misery 1\"\n"
" misery clear\n"
" remove fake thoughts added in this session of DF. Saving makes them permanent! Does not change factor.\n\n"
));
return CR_OK; return CR_OK;
} }