]> git.lizzy.rs Git - minetest.git/blobdiff - builtin/settingtypes.txt
Improve light curve parameter limits and documentation (#9054)
[minetest.git] / builtin / settingtypes.txt
index 10bb4985f91c3d3ed1a9a86abfd1f34d75c94b53..feb29c2e262dc4845f0a59f17ce3809526691150 100644 (file)
@@ -112,7 +112,7 @@ always_fly_fast (Always fly and fast) bool true
 
 #    The time in seconds it takes between repeated right clicks when holding the right
 #    mouse button.
-repeat_rightclick_time (Rightclick repetition interval) float 0.25
+repeat_rightclick_time (Rightclick repetition interval) float 0.25 0.001
 
 #    Automatically jump up single-node obstacles.
 autojump (Automatic jumping) bool false
@@ -150,7 +150,7 @@ joystick_type (Joystick type) enum auto auto,generic,xbox
 
 #    The time in seconds it takes between repeated events
 #    when holding down a joystick button combination.
-repeat_joystick_button_time (Joystick button repetition interval) float 0.17
+repeat_joystick_button_time (Joystick button repetition interval) float 0.17 0.001
 
 #    The sensitivity of the joystick axes for moving the
 #    ingame view frustum around.
@@ -526,7 +526,10 @@ shader_path (Shader path) path
 
 [***Tone Mapping]
 
-#    Enables filmic tone mapping
+#    Enables Hable's 'Uncharted 2' filmic tone mapping.
+#    Simulates the tone curve of photographic film and how this approximates the
+#    appearance of high dynamic range images. Mid-range contrast is slightly
+#    enhanced, highlights and shadows are gradually compressed.
 tone_mapping (Filmic tone mapping) bool false
 
 [***Bumpmapping]
@@ -597,10 +600,10 @@ arm_inertia (Arm inertia) bool true
 
 #    If FPS would go higher than this, limit it by sleeping
 #    to not waste CPU power for no benefit.
-fps_max (Maximum FPS) int 60
+fps_max (Maximum FPS) int 60 1
 
 #    Maximum FPS when game is paused.
-pause_fps_max (FPS in pause menu) int 20
+pause_fps_max (FPS in pause menu) int 20 1
 
 #    Open the pause menu when the window's focus is lost. Does not pause if a formspec is
 #    open.
@@ -616,10 +619,10 @@ viewing_range (Viewing range) int 100 20 4000
 near_plane (Near clipping plane) float 0.1 0 0.5
 
 #    Width component of the initial window size.
-screen_w (Screen width) int 1024
+screen_w (Screen width) int 1024 1
 
 #    Height component of the initial window size.
-screen_h (Screen height) int 600
+screen_h (Screen height) int 600 1
 
 #    Save window size automatically when modified.
 autosave_screensize (Autosave screen size) bool true
@@ -636,25 +639,34 @@ vsync (VSync) bool false
 #    Field of view in degrees.
 fov (Field of view) int 72 45 160
 
-#    Adjust the gamma encoding for the light tables. Higher numbers are brighter.
-#    This setting is for the client only and is ignored by the server.
-display_gamma (Gamma) float 1.0 0.5 10.0
+#    Alters the light curve by applying 'gamma correction' to it.
+#    Higher values make middle and lower light levels brighter.
+#    Value '1.0' leaves the light curve unaltered.
+#    This only has significant effect on daylight and artificial
+#    light, it has very little effect on natural night light.
+display_gamma (Light curve gamma) float 1.0 0.33 3.0
 
 #    Gradient of light curve at minimum light level.
-lighting_alpha (Darkness sharpness) float 0.0 0.0 4.0
+#    Controls the contrast of the lowest light levels.
+lighting_alpha (Light curve low gradient) float 0.0 0.0 3.0
 
 #    Gradient of light curve at maximum light level.
-lighting_beta (Lightness sharpness) float 1.5 0.0 4.0
+#    Controls the contrast of the highest light levels.
+lighting_beta (Light curve high gradient) float 1.5 0.0 3.0
 
-#    Strength of light curve mid-boost.
-lighting_boost (Light curve mid boost) float 0.2 0.0 1.0
+#    Strength of light curve boost.
+#    The 3 'boost' parameters define a range of the light
+#    curve that is boosted in brightness.
+lighting_boost (Light curve boost) float 0.2 0.0 0.4
 
-#    Center of light curve mid-boost.
-lighting_boost_center (Light curve mid boost center) float 0.5 0.0 1.0
+#    Center of light curve boost range.
+#    Where 0.0 is minimum light level, 1.0 is maximum light level.
+lighting_boost_center (Light curve boost center) float 0.5 0.0 1.0
 
-#    Spread of light curve mid-boost.
-#    Standard deviation of the mid-boost gaussian.
-lighting_boost_spread (Light curve mid boost spread) float 0.2 0.0 1.0
+#    Spread of light curve boost range.
+#    Controls the width of the range to be boosted.
+#    Standard deviation of the light curve boost Gaussian.
+lighting_boost_spread (Light curve boost spread) float 0.2 0.0 0.4
 
 #    Path to texture directory. All textures are first searched from here.
 texture_path (Texture path) path
@@ -756,7 +768,7 @@ minimap_shape_round (Round minimap) bool true
 
 #    True = 256
 #    False = 128
-#    Useable to make minimap smoother on slower machines.
+#    Usable to make minimap smoother on slower machines.
 minimap_double_scan_height (Minimap scan height) bool true
 
 #    Make fog and sky colors depend on daytime (dawn/sunset) and view direction.
@@ -806,7 +818,7 @@ menu_clouds (Clouds in menu) bool true
 #    This will smooth over some of the rough edges, and blend
 #    pixels when scaling down, at the cost of blurring some
 #    edge pixels when images are scaled by non-integer sizes.
-gui_scaling (GUI scaling) float 1.0
+gui_scaling (GUI scaling) float 1.0 0.001
 
 #    When gui_scaling_filter is true, all GUI images need to be
 #    filtered in software, but some images are generated directly
@@ -831,7 +843,7 @@ freetype (FreeType fonts) bool true
 #    Path to TrueTypeFont or bitmap.
 font_path (Font path) filepath fonts/liberationsans.ttf
 
-font_size (Font size) int 16
+font_size (Font size) int 16 1
 
 #    Font shadow offset, if 0 then shadow will not be drawn.
 font_shadow (Font shadow) int 1
@@ -841,11 +853,11 @@ font_shadow_alpha (Font shadow alpha) int 127 0 255
 
 mono_font_path (Monospace font path) filepath fonts/liberationmono.ttf
 
-mono_font_size (Monospace font size) int 15
+mono_font_size (Monospace font size) int 15 1
 
 #    This font will be used for certain languages.
 fallback_font_path (Fallback font) filepath fonts/DroidSansFallbackFull.ttf
-fallback_font_size (Fallback font size) int 15
+fallback_font_size (Fallback font size) int 15 1
 fallback_font_shadow (Fallback font shadow) int 1
 fallback_font_shadow_alpha (Fallback font shadow alpha) int 128 0 255
 
@@ -863,7 +875,7 @@ screenshot_quality (Screenshot quality) int 0 0 100
 [*Advanced]
 
 #    Adjust dpi configuration to your screen (non X11/Android only) e.g. for 4k screens.
-screen_dpi (DPI) int 72
+screen_dpi (DPI) int 72 1
 
 #    Windows systems only: Start Minetest with the command line window in the background.
 #    Contains the same information as the file debug.txt (default name).
@@ -1145,10 +1157,10 @@ movement_speed_climb (Climbing speed) float 3
 #    Initial vertical speed when jumping, in nodes per second.
 movement_speed_jump (Jumping speed) float 6.5
 
-#    Decrease this to increase liquid resistence to movement.
+#    Decrease this to increase liquid resistance to movement.
 movement_liquid_fluidity (Liquid fluidity) float 1
 
-#    Maximum liquid resistence. Controls deceleration when entering liquid at
+#    Maximum liquid resistance. Controls deceleration when entering liquid at
 #    high speed.
 movement_liquid_fluidity_smooth (Liquid fluidity smoothing) float 0.5
 
@@ -1160,7 +1172,7 @@ movement_gravity (Gravity) float 9.81
 
 [**Advanced]
 
-#    Handling for deprecated lua api calls:
+#    Handling for deprecated Lua API calls:
 #    -    legacy: (try to) mimic old behaviour (default for release).
 #    -    log: mimic and log backtrace of deprecated call (default for debug).
 #    -    error: abort on usage of deprecated call (suggested for mod developers).
@@ -1709,7 +1721,7 @@ mgcarpathian_np_dungeons (Dungeon noise) noise_params_3d 0.9, 0.5, (500, 500, 50
 
 [*Mapgen Flat]
 
-#    Map generation attributes specific to Mapgen flat.
+#    Map generation attributes specific to Mapgen Flat.
 #    Occasional lakes and hills can be added to the flat world.
 mgflat_spflags (Mapgen Flat specific flags) flags nolakes,nohills lakes,hills,nolakes,nohills
 
@@ -1767,7 +1779,7 @@ mgflat_np_dungeons (Dungeon noise) noise_params_3d 0.9, 0.5, (500, 500, 500), 0,
 
 [*Mapgen Fractal]
 
-#    Map generation attributes specific to Mapgen flat.
+#    Map generation attributes specific to Mapgen Fractal.
 #    'terrain' enables the generation of non-fractal terrain:
 #    ocean, islands and underground.
 mgfractal_spflags (Mapgen Fractal specific flags) flags terrain terrain,noterrain
@@ -1789,24 +1801,24 @@ mgfractal_dungeon_ymin (Dungeon minimum Y) int -31000
 mgfractal_dungeon_ymax (Dungeon maximum Y) int 31000
 
 #    Selects one of 18 fractal types.
-#    1 = 4D "Roundy" mandelbrot set.
-#    2 = 4D "Roundy" julia set.
-#    3 = 4D "Squarry" mandelbrot set.
-#    4 = 4D "Squarry" julia set.
-#    5 = 4D "Mandy Cousin" mandelbrot set.
-#    6 = 4D "Mandy Cousin" julia set.
-#    7 = 4D "Variation" mandelbrot set.
-#    8 = 4D "Variation" julia set.
-#    9 = 3D "Mandelbrot/Mandelbar" mandelbrot set.
-#    10 = 3D "Mandelbrot/Mandelbar" julia set.
-#    11 = 3D "Christmas Tree" mandelbrot set.
-#    12 = 3D "Christmas Tree" julia set.
-#    13 = 3D "Mandelbulb" mandelbrot set.
-#    14 = 3D "Mandelbulb" julia set.
-#    15 = 3D "Cosine Mandelbulb" mandelbrot set.
-#    16 = 3D "Cosine Mandelbulb" julia set.
-#    17 = 4D "Mandelbulb" mandelbrot set.
-#    18 = 4D "Mandelbulb" julia set.
+#    1 = 4D "Roundy" Mandelbrot set.
+#    2 = 4D "Roundy" Julia set.
+#    3 = 4D "Squarry" Mandelbrot set.
+#    4 = 4D "Squarry" Julia set.
+#    5 = 4D "Mandy Cousin" Mandelbrot set.
+#    6 = 4D "Mandy Cousin" Julia set.
+#    7 = 4D "Variation" Mandelbrot set.
+#    8 = 4D "Variation" Julia set.
+#    9 = 3D "Mandelbrot/Mandelbar" Mandelbrot set.
+#    10 = 3D "Mandelbrot/Mandelbar" Julia set.
+#    11 = 3D "Christmas Tree" Mandelbrot set.
+#    12 = 3D "Christmas Tree" Julia set.
+#    13 = 3D "Mandelbulb" Mandelbrot set.
+#    14 = 3D "Mandelbulb" Julia set.
+#    15 = 3D "Cosine Mandelbulb" Mandelbrot set.
+#    16 = 3D "Cosine Mandelbulb" Julia set.
+#    17 = 4D "Mandelbulb" Mandelbrot set.
+#    18 = 4D "Mandelbulb" Julia set.
 mgfractal_fractal (Fractal type) int 1 1 18
 
 #    Iterations of the recursive function.
@@ -1828,7 +1840,7 @@ mgfractal_scale (Scale) v3f (4096.0, 1024.0, 4096.0)
 #    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
+#    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.