Mgfractal / chunksize: Improve documentation
authorparamat <paramat@users.noreply.github.com>
Tue, 20 Mar 2018 02:30:25 +0000 (02:30 +0000)
committerparamat <mat.gregory@virginmedia.com>
Tue, 20 Mar 2018 03:41:39 +0000 (03:41 +0000)
builtin/settingtypes.txt

index ff08a20697cf7f3657d7b1e846f9efb423b5e707..4a2fa787ebff6d0fa3c43a8723bff21e9b08ad9d 100644 (file)
@@ -1656,7 +1656,7 @@ mgfractal_dungeon_ymin (Dungeon minimum Y) int -31000
 #    Upper Y limit of dungeons.
 mgfractal_dungeon_ymax (Dungeon maximum Y) int 31000
 
-#    Choice of 18 fractals from 9 formulas.
+#    Selects one of 18 fractal types.
 #    1 = 4D "Roundy" mandelbrot set.
 #    2 = 4D "Roundy" julia set.
 #    3 = 4D "Squarry" mandelbrot set.
@@ -1678,37 +1678,58 @@ mgfractal_dungeon_ymax (Dungeon maximum Y) int 31000
 mgfractal_fractal (Fractal type) int 1 1 18
 
 #    Iterations of the recursive function.
-#    Controls the amount of fine detail.
+#    Increasing this increases the amount of fine detail, but also
+#    increases processing load.
+#    At iterations = 20 this mapgen has a similar load to mapgen V7.
 mgfractal_iterations (Iterations) int 11
 
-#    Approximate (X,Y,Z) scale of fractal in nodes.
+#    (X,Y,Z) scale of fractal in nodes.
+#    Actual fractal size will be 2 to 3 times larger.
+#    These numbers can be made very large, the fractal does
+#    not have to fit inside the world.
+#    Increase these to 'zoom' into the detail of the fractal.
+#    Default is for a vertically-squashed shape suitable for
+#    an island, set all 3 numbers equal for the raw shape.
 mgfractal_scale (Scale) v3f (4096.0, 1024.0, 4096.0)
 
 #    (X,Y,Z) offset of fractal from world centre in units of 'scale'.
-#    Used to move a suitable spawn area of low land close to (0, 0).
-#    The default is suitable for mandelbrot sets, it needs to be edited for julia sets.
+#    Can be used to move a desired point to (0, 0): to create a
+#    suitable spawn point, or to allow 'zooming in' on a desired
+#    point by increasing 'scale'.
+#    The default is tuned for a suitable spawn point for mandelbrot
+#    sets with default parameters, it may need altering in other
+#    situations.
 #    Range roughly -2 to 2. Multiply by 'scale' for offset in nodes.
 mgfractal_offset (Offset) v3f (1.79, 0.0, 0.0)
 
 #    W co-ordinate of the generated 3D slice of a 4D fractal.
 #    Determines which 3D slice of the 4D shape is generated.
+#    Alters the shape of the fractal.
 #    Has no effect on 3D fractals.
 #    Range roughly -2 to 2.
 mgfractal_slice_w (Slice w) float 0.0
 
-#    Julia set only: X component of hypercomplex constant determining julia shape.
+#    Julia set only.
+#    X component of hypercomplex constant.
+#    Alters the shape of the fractal.
 #    Range roughly -2 to 2.
 mgfractal_julia_x (Julia x) float 0.33
 
-#    Julia set only: Y component of hypercomplex constant determining julia shape.
+#    Julia set only.
+#    Y component of hypercomplex constant.
+#    Alters the shape of the fractal.
 #    Range roughly -2 to 2.
 mgfractal_julia_y (Julia y) float 0.33
 
-#    Julia set only: Z component of hypercomplex constant determining julia shape.
+#    Julia set only.
+#    Z component of hypercomplex constant.
+#    Alters the shape of the fractal.
 #    Range roughly -2 to 2.
 mgfractal_julia_z (Julia z) float 0.33
 
-#    Julia set only: W component of hypercomplex constant determining julia shape.
+#    Julia set only.
+#    W component of hypercomplex constant.
+#    Alters the shape of the fractal.
 #    Has no effect on 3D fractals.
 #    Range roughly -2 to 2.
 mgfractal_julia_w (Julia w) float 0.33
@@ -1804,6 +1825,11 @@ mgvalleys_np_inter_valley_slope (Valley slope) noise_params_2d 0.5, 0.5, (128, 1
 [*Advanced]
 
 #    Size of chunks to be generated at once by mapgen, stated in mapblocks (16 nodes).
+#    Increasing this by 1 almost doubles the 3D noise calculation load.
+#    High values can cause noise calculation to overload.
+#    Values smaller than 5 cause a terrain bug in mgv6.
+#    Since there is a fixed number of large caves and dungeons per
+#    mapchunk, values other than 5 alter the density of these.
 chunksize (Chunk size) int 5
 
 #    Dump the mapgen debug infos.