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

update docs for generated-creature-renamer

develop
myk002 2022-07-25 16:54:28 -07:00
parent eb0f016804
commit 367ac0064e
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 22 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/plugins/generated-creature-renamer.rst
Unescape Escape View File

@ -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.

13
plugins/generated-creature-renamer.cpp
Unescape Escape View File

@ -27,17 +27,12 @@ DFhackCExport command_result plugin_init(color_ostream &out, std::vector <Plugin
commands.push_back(PluginCommand(
"list-generated",
"Prints a list of generated creature tokens.",
list_creatures,
false, //allow non-interactive use
"Use \"list-generated detailed\" to show descriptions."
));
list_creatures));
commands.push_back(PluginCommand(
"save-generated-raws",
"Saves a graphics raw file to use with the renamed generated creatures.",
save_generated_raw,
false, //allow non-interactive use
"Creates graphics_procedural_creatures.txt, with a full set of creature graphics definitions for all possible generated beasts. Modify the resulting file to suit your needs."
)); return CR_OK;
"Exports a graphics raw file for the renamed generated creatures.",
save_generated_raw));
return CR_OK;
}
DFhackCExport command_result plugin_shutdown(color_ostream &out)