Mgfractal: Add documentation to conf.example and settingtypes

2 files changed, 134 insertions, 7 deletions

diff --git a/builtin/settingtypes.txt b/builtin/settingtypes.txt
index 6fbc8f244..ef39239df 100644
--- a/builtin/settingtypes.txt
+++ b/builtin/settingtypes.txt
@@ -812,7 +812,7 @@ liquid_update (Liquid update tick) float 1.0
 
 #    Name of map generator to be used when creating a new world.
 #    Creating a world in the main menu will override this.
-mg_name (Mapgen name) enum v6 v5,v6,v7,singlenode
+mg_name (Mapgen name) enum v6 v5,v6,v7,fractal,singlenode
 
 #    Water surface level of the world.
 water_level (Water level) int 1
@@ -885,13 +885,13 @@ mgv5_np_cave2 (Mapgen v5 cave2 noise parameters) noise_params 0, 12, (50, 50, 50
 
 [***Mapgen v6]
 
-#    Map generation attributes specific to Mapgen V6.
+#    Map generation attributes specific to Mapgen v6.
 #    When snowbiomes are enabled jungles are enabled and the jungles flag is ignored.
 #    Flags that are not specified in the flag string are not modified from the default.
 #    Flags starting with "no" are used to explicitly disable them.
 mgv6_spflags (Mapgen v6 flags) flags jungles,biomeblend,mudflow,snowbiomes jungles,biomeblend,mudflow,snowbiomes,nojungles,nobiomeblend,nomudflow,nosnowbiomes
 
-#    Controls size of deserts and beaches in Mapgen V6.
+#    Controls size of deserts and beaches in Mapgen v6.
 #    When snowbiomes are enabled 'mgv6_freq_desert' is ignored.
 mgv6_freq_desert (Mapgen v6 desert frequency) float 0.45
 mgv6_freq_beach (Mapgen v6 beach frequency) float 0.15
@@ -909,7 +909,8 @@ mgv6_np_trees (Mapgen v6 trees noise parameters) noise_params 0, 1, (125, 125, 1
 mgv6_np_apple_trees (Mapgen v6 apple trees noise parameters) noise_params 0, 1, (100, 100, 100), 342902, 3, 0.45, 2.0
 
 [***Mapgen v7]
-#    Map generation attributes specific to Mapgen V7.
+
+#    Map generation attributes specific to Mapgen v7.
 #    'ridges' are the rivers.
 #    Flags that are not specified in the flag string are not modified from the default.
 #    Flags starting with "no" are used to explicitly disable them.
@@ -927,6 +928,61 @@ mgv7_np_ridge (Mapgen v7 ridge noise parameters) noise_params 0, 1, (100, 100, 1
 mgv7_np_cave1 (Mapgen v7 cave1 noise parameters) noise_params 0, 12, (100, 100, 100), 52534, 4, 0.5, 2.0
 mgv7_np_cave2 (Mapgen v7 cave2 noise parameters) noise_params 0, 12, (100, 100, 100), 10325, 4, 0.5, 2.0
 
+[***Mapgen fractal]
+
+#    Map generation attributes specific to Mapgen fractal.
+#    'julia' selects a julia set to be generated instead of a mandelbrot set.
+#    Flags that are not specified in the flag string are not modified from the default.
+#    Flags starting with "no" are used to explicitly disable them.
+mgfractal_spflags (Mapgen fractal flags) flags nojulia julia,nojulia
+
+#    Mandelbrot set: iterations of recursive function.
+#    Controls scale of finest detail.
+mgfractal_m_iterations (Mapgen fractal mandelbrot iterations) int 9
+#
+#    TODO
+#    Mandelbrot set: Approximate scale in nodes.
+#mgfractal_m_scale (Mapgen fractal mandelbrot scale) v3f (1024.0, 256.0, 1024.0)
+#
+#    Mandelbrot set: Offsets the fractal from world centre.
+#    Range -2 to 2, multiply by m_scale for actual offset in nodes.
+#mgfractal_m_offset (Mapgen fractal mandelbrot offset) v3f (1.75, 0.0, 0.0)
+
+#    Mandelbrot set: W co-ordinate of the generated 3D slice of the 4D shape.
+mgfractal_m_slice_w (Mapgen fractal mandelbrot slice w) float 0.0
+
+#    Julia set: iterations of recursive function.
+#    Controls scale of finest detail.
+mgfractal_j_iterations (Mapgen fractal julia iterations) int 9
+#
+#    TODO
+#    Julia set: Approximate scale in nodes.
+#mgfractal_j_scale (Mapgen fractal julia scale) v3f (2048.0, 512.0, 2048.0)
+#
+#    Julia set: Offsets the fractal from world centre.
+#    Range -2 to 2, multiply by j_scale for actual offset in nodes.
+#mgfractal_j_offset (Mapgen fractal julia offset) v3f (0.0, 1.0, 0.0)
+
+#    Julia set: W co-ordinate of the generated 3D slice of the 4D shape.
+mgfractal_j_slice_w (Mapgen fractal julia slice w) float 0.0
+
+#    Julia set: X value determining the 4D shape.
+mgfractal_julia_x (Mapgen fractal julia x) float 0.33
+
+#    Julia set: Y value determining the 4D shape.
+mgfractal_julia_y (Mapgen fractal julia y) float 0.33
+
+#    Julia set: Z value determining the 4D shape.
+mgfractal_julia_z (Mapgen fractal julia z) float 0.33
+
+#    Julia set: W value determining the 4D shape.
+mgfractal_julia_w (Mapgen fractal julia w) float 0.33
+
+mgfractal_np_seabed (Mapgen fractal seabed noise parameters) noise_params -14, 9, (600, 600, 600), 41900, 5, 0.6, 2.0
+mgfractal_np_filler_depth (Mapgen fractal filler depth noise parameters) noise_params 0, 1.2, (150, 150, 150), 261, 3, 0.7, 2.0
+mgfractal_np_cave1 (Mapgen fractal cave1 noise parameters) noise_params 0, 12, (128, 128, 128), 52534, 4, 0.5, 2.0
+mgfractal_np_cave2 (Mapgen fractal cave2 noise parameters) noise_params 0, 12, (128, 128, 128), 10325, 4, 0.5, 2.0
+
 [*Security]
 
 #    Prevent mods from doing insecure things like running shell commands.
diff --git a/minetest.conf.example b/minetest.conf.example
index d523b75e6..888e0b41f 100644
--- a/minetest.conf.example
+++ b/minetest.conf.example
@@ -1000,7 +1000,7 @@
 
 #    Name of map generator to be used when creating a new world.
 #    Creating a world in the main menu will override this.
-#    type: enum values: v5, v6, v7, singlenode
+#    type: enum values: v5, v6, v7, fractal, singlenode
 # mg_name = v6
 
 #    Water surface level of the world.
@@ -1089,7 +1089,7 @@
 
 #### Mapgen v6
 
-#    Map generation attributes specific to Mapgen V6.
+#    Map generation attributes specific to Mapgen v6.
 #    When snowbiomes are enabled jungles are enabled and the jungles flag is ignored.
 #    Flags that are not specified in the flag string are not modified from the default.
 #    Flags starting with "no" are used to explicitly disable them.
@@ -1139,7 +1139,7 @@
 
 #### Mapgen v7
 
-#    Map generation attributes specific to Mapgen V7.
+#    Map generation attributes specific to Mapgen v7.
 #    'ridges' are the rivers.
 #    Flags that are not specified in the flag string are not modified from the default.
 #    Flags starting with "no" are used to explicitly disable them.
@@ -1179,6 +1179,77 @@
 #    type: noise_params
 # mgv7_np_cave2 = 0, 12, (100, 100, 100), 10325, 4, 0.5, 2.0
 
+#### Mapgen fractal
+
+#    Map generation attributes specific to Mapgen fractal.
+#    'julia' selects a julia set to be generated instead of a mandelbrot set.
+#    Flags that are not specified in the flag string are not modified from the default.
+#    Flags starting with "no" are used to explicitly disable them.
+#    type: flags possible values: julia, nojulia
+# mgfractal_spflags = nojulia
+
+#    Mandelbrot set: iterations of recursive function.
+#    Controls scale of finest detail.
+#    type: int
+# mgfractal_m_iterations = 9
+
+#    Mandelbrot set: Approximate scale in nodes.
+#    type: v3f
+# mgfractal_m_scale = (1024.0, 256.0, 1024.0)
+
+#    Mandelbrot set: Offsets the fractal from world centre.
+#    Range -2 to 2, multiply by m_scale for actual offset in nodes.
+#    type: v3f
+# mgfractal_m_offset = (1.75, 0.0, 0.0)
+
+#    Mandelbrot set: W co-ordinate of the generated 3D slice of the 4D shape.
+#    type: float
+# mgfractal_m_slice_w = 0.0
+
+#    Julia set: iterations of recursive function.
+#    Controls scale of finest detail.
+#    type: int
+# mgfractal_j_iterations = 9
+
+#    Julia set: Approximate scale in nodes.
+#    type: v3f
+# mgfractal_j_scale = (2048.0, 512.0, 2048.0)
+
+#    Julia set: Offsets the fractal from world centre.
+#    Range -2 to 2, multiply by j_scale for actual offset in nodes.
+#    type: v3f
+# mgfractal_j_offset = (0.0, 1.0, 0.0)
+
+#    Julia set: W co-ordinate of the generated 3D slice of the 4D shape.
+#    type: float
+# mgfractal_j_slice_w = 0.0
+
+#    Julia set: The following 4 values determine the 4D shape.
+#    Range -2 to 2.
+#    type: float
+# mgfractal_julia_x = 0.33
+
+#    type: float
+# mgfractal_julia_y = 0.33
+
+#    type: float
+# mgfractal_julia_z = 0.33
+
+#    type: float
+# mgfractal_julia_w = 0.33
+
+#    type: noise_params
+# mgfractal_np_seabed = -14, 9, (600, 600, 600), 41900, 5, 0.6, 2.0
+
+#    type: noise_params
+# mgfractal_np_filler_depth = 0, 1.2, (150, 150, 150), 261, 3, 0.7, 2.0
+
+#    type: noise_params
+# mgfractal_np_cave1 = 0, 12, (128, 128, 128), 52534, 4, 0.5, 2.0
+
+#    type: noise_params
+# mgfractal_np_cave2 = 0, 12, (128, 128, 128), 10325, 4, 0.5, 2.0
+
 ## Security
 
 #    Prevent mods from doing insecure things like running shell commands.