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

update docs for 3dveins

develop
myk002 2022-07-18 11:34:58 -07:00
parent d27def7128
commit 2207f26992
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 26 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/plugins/3dveins.rst
Unescape Escape View File

@ -1,14 +1,27 @@
3dveins
=======
Removes all existing veins from the map and generates new ones using
3D Perlin noise, in order to produce a layout that smoothly flows between
Z levels. The vein distribution is based on the world seed, so running
the command for the second time should produce no change. It is best to
run it just once immediately after embark.
This command is intended as only a cosmetic change, so it takes
care to exactly preserve the mineral counts reported by `prospect` ``all``.
The amounts of different layer stones may slightly change in some cases
if vein mass shifts between Z layers.
Rewrites layer veins to expand in 3D space. Existing, flat veins are removed
and new 3D veins that naturally span z-levels are generated in their place.
The transformation preserves the mineral counts reported by `prospect`.
Usage::
3dveins [verbose]
The ``verbose`` option prints out extra information to the console.
Example::
3dveins
New veins are generated using 3D Perlin noise in order to produce a layout that
flows smoothly between z-levels. The vein distribution is based on the world
seed, so running the command for the second time should produce no change. It is
best to run it just once immediately after embark.
This command is intended as only a cosmetic change, so it takes care to exactly
preserve the mineral counts reported by ``prospect all``. The amounts of layer
stones may slightly change in some cases if vein mass shifts between z layers.
The only undo option is to restore your save from backup.

9
plugins/3dveins.cpp
Unescape Escape View File

@ -52,12 +52,9 @@ command_result cmd_3dveins(color_ostream &out, std::vector <std::string> & param
DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <PluginCommand> &commands)
{
commands.push_back(PluginCommand(
"3dveins", "Rewrites the veins to make them extend in 3D space.",
cmd_3dveins, false,
" Run this after embark to change all veins on the map to a shape\n"
" that consistently spans Z levels. The operation preserves the\n"
" mineral counts reported by prospect.\n"
));
"3dveins",
"Rewrites the veins to make them extend in 3D space.",
cmd_3dveins));
return CR_OK;
}