aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorparamat <mat.gregory@virginmedia.com>2016-09-23 17:01:49 +0100
committerparamat <mat.gregory@virginmedia.com>2016-09-23 19:01:31 +0100
commitcd2c8ade2d86f709d9a82b7ad86284cc3e9ce8c3 (patch)
tree2dab2c607b1cea0e77086166b5ca1bba60433055
parent9fa562f8880c6c447d265fe181986075b640223a (diff)
downloadminetest-cd2c8ade2d86f709d9a82b7ad86284cc3e9ce8c3.tar.gz
minetest-cd2c8ade2d86f709d9a82b7ad86284cc3e9ce8c3.tar.bz2
minetest-cd2c8ade2d86f709d9a82b7ad86284cc3e9ce8c3.zip
Conf.example: Re-add deleted noise parameter documentation
Re-add documentation of noise parameter formats. Re-add 'mgv5_np_ground' noise parameters in group format. Both these were deleted through auto-generation of conf.example. Add note to builtin/mainmenu/dlg_settings_advanced.lua that this documentation must be preserved.
-rw-r--r--builtin/mainmenu/dlg_settings_advanced.lua9
-rw-r--r--minetest.conf.example33
2 files changed, 41 insertions, 1 deletions
diff --git a/builtin/mainmenu/dlg_settings_advanced.lua b/builtin/mainmenu/dlg_settings_advanced.lua
index 68b5fd4ef..06def72a3 100644
--- a/builtin/mainmenu/dlg_settings_advanced.lua
+++ b/builtin/mainmenu/dlg_settings_advanced.lua
@@ -659,5 +659,12 @@ function create_adv_settings_dlg()
return dlg
end
--- generate minetest.conf.example and settings_translation_file.cpp:
+-- Generate minetest.conf.example and settings_translation_file.cpp
+
+-- *** Please note ***
+-- There is text in minetest.conf.example that will not be generated from
+-- settingtypes.txt but must be preserved:
+-- The documentation of mapgen noise parameter formats (title plus 16 lines)
+-- Noise parameter 'mgv5_np_ground' in group format (13 lines)
+
--assert(loadfile(core.get_mainmenu_path()..DIR_DELIM.."generate_from_settingtypes.lua"))(parse_config_file(true, false))
diff --git a/minetest.conf.example b/minetest.conf.example
index bedc8c579..9c8015625 100644
--- a/minetest.conf.example
+++ b/minetest.conf.example
@@ -1099,6 +1099,25 @@
# type: int
# num_emerge_threads = 1
+#### Noise parameters and formats
+
+# Noise parameters can be specified as a set of positional values, for example:
+# Offset, scale, (spread factors), seed offset, number of octaves, persistence, lacunarity
+# mgv6_np_terrain_base = -4, 20, (250, 250, 250), 82341, 5, 0.6, 2.0
+# Or the group format can be used instead, for example:
+# mgv6_np_terrain_base = {
+# offset = -4,
+# scale = 20,
+# spread = (250, 250, 250),
+# seed = 82341,
+# octaves = 5,
+# persistence = 0.6,
+# lacunarity = 2.0,
+# flags = "defaults"
+# }
+# Only the group format supports noise flags which are needed for eased noise.
+# Mgv5 uses eased noise for np_ground so this is shown in group format below.
+
# Noise parameters for biome API temperature, humidity and biome blend.
# type: noise_params
# mg_biome_np_heat = 50, 50, (750, 750, 750), 5349, 3, 0.5, 2.0
@@ -1133,6 +1152,20 @@
# type: noise_params
# mgv5_np_cave2 = 0, 12, (50, 50, 50), 10325, 4, 0.5, 2.0
+# Noise parameters in group format, unsupported by advanced settings
+# menu but settable in minetest.conf.
+# See documentation of noise parameter formats above.
+# mgv5_np_ground = {
+# offset = 0,
+# scale = 40,
+# spread = (80, 80, 80),
+# seed = 983240,
+# octaves = 4,
+# persistence = 0.55,
+# lacunarity = 2.0,
+# flags = "eased"
+# }
+
#### Mapgen v6
# Map generation attributes specific to Mapgen v6.