diff --git a/docs/plugins/3dveins.rst b/docs/plugins/3dveins.rst index 0e6841792..9a074a4c8 100644 --- a/docs/plugins/3dveins.rst +++ b/docs/plugins/3dveins.rst @@ -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. diff --git a/plugins/3dveins.cpp b/plugins/3dveins.cpp index 929ee24f6..eaf741caf 100644 --- a/plugins/3dveins.cpp +++ b/plugins/3dveins.cpp @@ -52,12 +52,9 @@ command_result cmd_3dveins(color_ostream &out, std::vector & param DFhackCExport command_result plugin_init ( color_ostream &out, std::vector &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; }