summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
authorWuzzy <almikes@aol.com>2016-07-02 21:09:57 +0200
committerWuzzy <almikes@aol.com>2016-07-02 21:09:57 +0200
commit0d022110ebc803bdd65ea5250c819503bcf0be42 (patch)
treedf276cbfd5802c56252c59ed36969dc7ef79d410 /README.txt
parent185f0f5b2f8cb5bb878b6427a1b116cfff5184a2 (diff)
Add settings to advanced settings menu
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt61
1 files changed, 4 insertions, 57 deletions
diff --git a/README.txt b/README.txt
index 77fc7cb..061fa3b 100644
--- a/README.txt
+++ b/README.txt
@@ -24,63 +24,8 @@ Keep in mind if running a server with this mod, that the custom position should
Settings:
---------
-This mod can be configured by editing minetest.conf. Currently, the following setting is recognized:
-
-- hudbars_autohide_breath: A boolean setting, it can be either “true” or “false”. If set to “true”,
- the breath bar will be automatically hidden shortly after the breathbar has been filled up. If set
- to “false”, the breath bar will always be displayed. The default value is “true”.
-
-- hudbars_sorting: This setting allows you to specify the “slot” positions of the HUD bars manually.
-
- The setting has to be specified as a comma-seperated list of key=value pairs, where a key refers to the
- identifier of a HUD bar and the value refers to the slot number of where the HUD bar should be placed.
- The slot number must be an integer greater of equal to 0. The slot positions start (slot 0) at the
- bottom (nearest to hotbar in default configuration) left side, the following slot 1 is at the right
- side, slot `2` is on the right side again, but placed over the first HUD bar (slot 0), and it goes on,
- in a zig-zag pattern.
- All HUD bars to which no sorting rule has been applied will fill in all slots which have not been occupied
- by the HUD bars specified in this setting, the slots will be filled in from the lowest slot number.
- Note that the order of those remaining HUD bars is *not* fixed, it basically just boils down on which mod
- “came” first. Don't worry, the mod will still work perfectly fine, this setting is entirely optional.
-
- Be careful not to use slot indices twice, or else different HUD bars will be drawn over each other!
-
- If this setting is not set, by default the health and breath bar are displayed at slot positions 0 and 1,
- respectively (health bar at left bottom-most positoin, breath bar right from it). All other HUD bars are
- placed automatically.
-
- Example value:
- breath=0, health=1
- This places the breath bar at the left side, and the health bar to the right side.
-
-- hudbars_bar_type: Specifies the style of bars. You can select between the default progress-bar-like bars and the good old statbars
- like you know from vanilla Minetest. Note that the classic and modern statbars are still a little bit experimental.
- These values are possible:
- - progress_bar: A horizontal progress-bar-like bar with a label, showing numerical value (current, maximum), and an icon.
- These bars usually convey the most information. This is the default and recommended value..
- - statbar_classic: Classic statbar, like in vanilla Minetest. Made out of up to 20 half-symbols. Those bars represent the vague ratio between
- the current value and the maximum value. 1 half-symbol stands for approximately 5% of the maximum value.
- - statbar_modern: Like the classic statbar, but also supports background images, this kind of statbar may be considered to be more user-friendly
- than the classic statbar. This bar type closely resembles the [hud] mod.
-
-- hudbars_vmargin: The vertical distance between two HUD bars in pixels (default: 24)
-- hudbars_tick: The number of seconds between two updates of the HUD bars. Increase this number if you have a slow server (default: 0.1)
-
-Position settings:
-With these settings you can configure the positions of the HUD bars. All settings must be specified as a number.
-The pos settings are specified as a floating-point number between 0 to 1 each, the start_offset settings are
-specified as whole numbers, they specify a number of pixels.
-The left and right variants are used for the zig-zag mode. In the stack_up and stack_down modes, only the left variant is used for
-the base position
-
-- hudbars_pos_left_x, hudbars_pos_left_y: Screen position (x and y) of the left HUD bar in zigzag mode. 0 is left-most/top, 1 is right-most/bottom.
- Defaults: 0.5 (x) and 1 (y)
-- hudbars_pos_right_x, hudbars_pos_right_y: Same as above, but for the right one.
- Defaults: 0.5 and 1.
-- hudbars_start_offset_left_x, hudbars_start_offset_left_y: Offset in pixels from the basic screen position specified in hudbars_pos_left_x/hudbars_pos_left_y.
- Defaults: -175 and -86
-- hudbars_start_offset_right_x, hudbars_start_offset_right_y: Same as above, but for the right one.
- Defaults: 15 and -86
+This mod can be configured quite a bit. You can change HUD bar appearance, offsets, ordering, and more. Use the advanced settings
+in Minetest for detailed configuration.
API:
----
@@ -97,6 +42,8 @@ hudbars_bar_health.png - Wuzzy (WTFPL)
hudbars_bar_breath.png - Wuzzy (WTFPL)
hudbars_bar_background.png - Wuzzy(WTFPL)
+License of mod:
+---------------
This program is free software. It comes without any warranty, to
the extent permitted by applicable law. You can redistribute it
and/or modify it under the terms of the Do What The Fuck You Want