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

Add basic documentation for the generated-creature-renamer plugin.

develop
Japa Illo 2017-02-10 15:30:48 +05:30
parent 0d8decd7ec
commit c68faaae37
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/Plugins.rst
Unescape Escape View File

@ -2453,6 +2453,24 @@ armor onto a war animal or to add unusual items (such as crowns) to any unit.
For more information run ``forceequip help``. See also `modtools/equip-item`.
.. _generated-creature-renamer:
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.
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.
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.
The new names are saved with the save, and the plugin, when enabled, only runs once
per save, unless there's an update.
.. _lair:
lair