diff --git a/docs/plugins/misery.rst b/docs/plugins/misery.rst index 1c146a10f..9a3a632f2 100644 --- a/docs/plugins/misery.rst +++ b/docs/plugins/misery.rst @@ -1,14 +1,18 @@ 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: -:misery enable n: enable misery with optional magnitude n. If specified, n must - be positive. -:misery n: same as "misery enable n" -:misery enable: same as "misery enable 1" -:misery disable: stop adding new negative thoughts. This will not remove - existing negative thoughts. Equivalent to "misery 0". -:misery clear: remove fake thoughts, even after saving and reloading. Does - not change factor. +``enable misery`` + Start multiplying negative thoughts. +``misery `` + Change the multiplicative factor of bad thoughts. The default is ``2``. +``misery clear`` + Clear away negative thoughts added by ``misery``. diff --git a/plugins/misery.cpp b/plugins/misery.cpp index b8e11f5c0..224060c6b 100644 --- a/plugins/misery.cpp +++ b/plugins/misery.cpp @@ -128,21 +128,10 @@ DFhackCExport command_result plugin_onupdate(color_ostream& out) { } DFhackCExport command_result plugin_init(color_ostream& out, vector &commands) { - commands.push_back(PluginCommand("misery", "increase the intensity of negative dwarven thoughts", - &misery, false, - "misery: When enabled, every new negative dwarven thought will be multiplied by a factor (2 by default).\n" - "Usage:\n" - " 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" - )); + commands.push_back(PluginCommand( + "misery", + "Increase the intensity of negative dwarven thoughts.", + misery)); return CR_OK; }