mods/HUD/hudbars/settingtypes.txt

   1 [Appearance]
   2 # Specifies how the value indicators (i.e. health, breah, etc.) look. There are 3 styles
   3 # available. You can choose between the default progress-bar-like bars and the good
   4 # old statbars like you know from vanilla Minetest.
   5 # These values are possible:
   6 #   - progress_bar:    A horizontal progress-bar-like bar with a label, showing numerical value
   7 #                      (current, maximum), and an icon. These bars usually convey the most
   8 #                      information. This is the default and recommended value.
   9 #   - statbar_classic: Classic statbar, like in vanilla Minetest. Made out of up to 20
  10 #                      half-symbols. Those bars represent the vague ratio between
  11 #                      the current value and the maximum value. 1 half-symbol stands for
  12 #                      approximately 5% of the maximum value.
  13 #   - statbar_modern:  Like the classic statbar, but also supports background images, this
  14 #                      kind of statbar may be considered to be more user-friendly than the
  15 #                      classic statbar. This bar type closely resembles the mod
  16 #                      “Better HUD” [hud] by BlockMen.
  17 hudbars_bar_type (HUD bars style) enum progress_bar progress_bar,statbar_classic,statbar_modern
  18
  19
  20 # If enabled (default), the breath indicators in the HUD will be automatically hidden shortly
  21 # after the breath has been filled up. Otherwise, the breath will always be displayed.
  22 hudbars_autohide_breath (Automatically hide breath indicators) bool true
  23
  24 # This setting changes the way the HUD bars are ordered on the display. You can choose
  25 # between a zig-zag pattern (default) or a vertically stacked pattern.
  26 # The following values are allowed:
  27 #    - zigzag:     Starting from the left bottom, the next is right from the first,
  28 #                  the next is above the first, the next is right of the third, etc.
  29 #    - stack_up:   The HUD bars are stacked vertically, going upwards.
  30 #    - stack_down: The HUD bars are stacked vertically, going downwards.
  31 hudbars_alignment_pattern (HUD bars alignment pattern) enum zigzag zigzag,stack_up,stack_down
  32
  33 # This setting allows you to specify the order of the HUD bars explicitly. If left empty
  34 # (the default), the health and breath indicators come first, additional indicators
  35 # may appear in any order. This setting is quite technical and normal users probably do not
  36 # need to worry about it.
  37 #
  38 # Syntax:
  39 # The setting has to be specified as a comma-seperated list of key=value pairs, where a key
  40 # refers to the identifier of a HUD bar and the value refers to the slot number of where the
  41 # HUD bar should be placed. The slot number must be an integer greater of equal to 0. Where
  42 # the HUD bars will be displayed exactly depends on the alignment pattern being used.
  43 # All HUD bars to which no order value has been applied will fill in all slots which have
  44 # not been occupied by the HUD bars specified in this setting, the slots will be filled in
  45 # from the lowest slot number.
  46 # Note that the order of those remaining HUD bars is not fixed, it basically just boils
  47 # down on which mod “came” first. Don't worry, the mod will still work perfectly fine, this
  48 # setting is entirely optional.
  49 # The identifier for the health bar is “health” and the identifier for the breath bar is
  50 # “breath”. For other HUD bars, you have to learn it from the mod which is supplying them.
  51 #
  52 # Be careful not to use slot indices twice, or else different HUD bars will be drawn over
  53 # each other!
  54 #
  55 # Example: “breath=0, health=1”
  56 # This makes the breath bar first and the health bar second, which is the opposite order
  57 # of the default one.
  58 hudbars_sorting (HUD bars order) string
  59
  60 [Positions and offsets]
  61 # Horizontal (x) main position of the HUD bars over the entire screen.
  62 # 0.0 is left-most, 1.0 is right-most.
  63 # For the zig-zag alignment pattern, this is for the left HUD bars.
  64 hudbars_pos_left_x (Left HUD bar screen x position) float 0.5 0.0 1.0
  65 # Vertical (y) main position of the HUD bars over the entire screen.
  66 # 0.0 is top, 1.0 is bottom.
  67 # For the zig-zag alignment pattern, this is for the left HUD bars.
  68 hudbars_pos_left_y (Left HUD bar screen y position) float 1.0 0.0 1.0
  69 # Horizontal (x) main position of the right HUD bars over the entire screen.
  70 # 0.0 is left-most, 1.0 is right-most.
  71 # Only used for the zig-zag alignment pattern.
  72 hudbars_pos_right_x (Right HUD bar screen x position) float 0.5 0.0 1.0
  73 # Vertical main position (y) of the right HUD bars over the entire screen.
  74 # 0.0 is top, 1.0 is bottom.
  75 # Only used for the zig-zag alignment pattern.
  76 hudbars_pos_right_y (Right HUD bar screen y position) float 1.0 0.0 1.0
  77
  78 # Precise x offset in pixels from the basic screen x position of the HUD bars.
  79 # For the zig-zag alignment pattern, this is for the left HUD bars.
  80 # This setting is used for the progress bar HUD bar style.
  81 hudbars_start_offset_left_x (Left HUD bar x offset) int -175
  82 # Precise y offset in pixels from the basic screen y position of the HUD bars.
  83 # For the zig-zag alignment pattern, this is for the left HUD bars.
  84 # This setting is used for the progress bar HUD bar style.
  85 hudbars_start_offset_left_y (Left HUD bar y offset) int -86
  86 # Precise x offset in pixels from the basic screen x position of the right HUD bars.
  87 # Only used for the zig-zag alignment pattern.
  88 # This setting is used for the progress bar HUD bar style.
  89 hudbars_start_offset_right_x (Right HUD bar x offset) int 15
  90 # Precise y offset in pixels from the basic screen y position of the right HUD bars.
  91 # Only used for the zig-zag alignment pattern.
  92 # This setting is used for the progress bar HUD bar style.
  93 hudbars_start_offset_right_y (Right HUD bar y offset) int -86
  94
  95 # Precise x offset in pixels from the basic screen x position of the HUD statbars.
  96 # For the zig-zag alignment pattern, this is for the left HUD statbars.
  97 # This setting is used for the classic and modern statbar styles.
  98 hudbars_start_statbar_offset_left_x (Left HUD statbar x offset) int -265
  99 # Precise y offset in pixels from the basic screen y position of the HUD statbars.
 100 # For the zig-zag alignment pattern, this is for the left HUD statbars.
 101 # This setting is used for the classic and modern statbar styles.
 102 hudbars_start_statbar_offset_left_y (Left HUD statbar y offset) int -90
 103 # Precise x offset in pixels from the basic screen x position of the right HUD statbars.
 104 # Only used for the zig-zag alignment pattern.
 105 # This setting is used for the classic and modern statbar styles.
 106 hudbars_start_statbar_offset_right_x (Right HUD statbar x offset) int 25
 107 # Precise y offset in pixels from the basic screen y position of the right HUD statbars.
 108 # Only used for the zig-zag alignment pattern.
 109 # This setting is used for the classic and modern statbar styles.
 110 hudbars_start_statbar_offset_right_y (Right HUD statbar y offset) int -90
 111
 112 # The vertical distance between two HUD bars, in pixels.
 113 hudbars_vmargin (Vertical distance between HUD bars) int 28 0
 114
 115 [Performance]
 116 # The of seconds which need to pass before the server updates the default HUD bars
 117 # (health and breath). Increase this number if you have a slow server or a slow network
 118 # connection and experience performance problems.
 119 hudbars_tick (Default HUD bars update interval) float 0.1 0.0 4.0