From 367ac0064ef21089a7eca07752f3417fba6eb977 Mon Sep 17 00:00:00 2001 From: myk002 Date: Mon, 25 Jul 2022 16:54:28 -0700 Subject: [PATCH] update docs for generated-creature-renamer --- docs/plugins/generated-creature-renamer.rst | 28 +++++++++++++-------- plugins/generated-creature-renamer.cpp | 13 +++------- 2 files changed, 22 insertions(+), 19 deletions(-) diff --git a/docs/plugins/generated-creature-renamer.rst b/docs/plugins/generated-creature-renamer.rst index bb486a4ee..1615ba32d 100644 --- a/docs/plugins/generated-creature-renamer.rst +++ b/docs/plugins/generated-creature-renamer.rst @@ -1,15 +1,23 @@ generated-creature-renamer ========================== -Automatically renames generated creatures, such as forgotten beasts, titans, -etc, to have raw token names that match the description given in-game. +Tags: +:dfhack-keybind:`list-generated` +:dfhack-keybind:`save-generated-raws` -The ``list-generated`` command can be used to list the token names of all -generated creatures in a given save, with an optional ``detailed`` argument -to show the accompanying description. +Automatically renames generated creatures. Now, forgotten beasts, titans, +necromancer experiments, etc. will have raw token names that match the +description given in-game instead of unreadable generated strings. -The ``save-generated-raws`` command will save a sample creature graphics file in -the Dwarf Fortress root directory, to use as a start for making a graphics set -for generated creatures using the new names that they get with this plugin. +Usage: -The new names are saved with the save, and the plugin, when enabled, only runs once -per save, unless there's an update. +``enable generated-creature-renamer`` + Rename generated creatures when a world is loaded. +``list-generated [detailed]`` + List the token names of all generated creatures in the loaded save. If + ``detailed`` is specified, then also show the accompanying description. +``save-generated-raws`` + Save a sample creature graphics file in the Dwarf Fortress root directory to + use as a start for making a graphics set for generated creatures using the + new names that they get with this plugin. + +The new names are saved with the world. diff --git a/plugins/generated-creature-renamer.cpp b/plugins/generated-creature-renamer.cpp index 625c093cf..f6e9e41b6 100644 --- a/plugins/generated-creature-renamer.cpp +++ b/plugins/generated-creature-renamer.cpp @@ -27,17 +27,12 @@ DFhackCExport command_result plugin_init(color_ostream &out, std::vector