diff --git a/README.txt b/README.txt index 4a9474d..4424cde 100644 --- a/README.txt +++ b/README.txt @@ -1,82 +1,42 @@ -Minetest mod "Better HUD" -========================= -Version: 1.4 +Minetest mod: HUD bar for armor [hbarmor] +========================================= +Version: 0.1.0 License of source code: WTFPL ----------------------------- -(c) Copyright BlockMen (2013-2014) +By Wuzzy, + +forked from the mod “Better HUD (and hunger)” [hud] +by BlockMen (2013-2014). Using the mod: -------------- -This mod changes the HUD of Minetest. -It improves the apperance of the health and breath bar and adds a more fancy hotbar. Furthermore it adds a -custom crosshair, an armor bar (only for 3darmor mod) and a hunger bar. It includes also a mechanic for hunger. +This mod adds a simple HUD bar which displays the current +damage of the player's armor (from the 3D Armor mod) as a percentage, +this number is of course rounded. +100% means the armor is in perfect shape, 0% means the armor +is almost destroyed or non-existant. +Note that to reach 100%, the player must wear at least 4 different +pieces of armor in perfect shape. +The armor bar also does not tell anything about the armor's strength, +only how worn out it already is. -You can create a "hud.conf" file to customize the positions of health, hunger, armor and breath bar. Take a look at "hud.conf.example" to get more infos. +By default, the armor bar is hidden if the player wears no armor. -!!IMPORTANT !!: -Keep in mind if running a server with this mod, that the custom position should be displayed correct on every screen size!! - - -=Hunger= -======== -This mod adds a hunger mechanic to the game. Player actions like digging, placing and walking causes exhausion, -that lowers players saturation. Also every 800 seconds you lose 1 saturation point without doing anything. -If you are hungry (empty hunger bar) you will get damage and die in case you don't eat something. - - -Notice: -------- -You can disable this by setting "HUD_HUNGER_ENABLE = false" in "hud.conf", or "hud_hunger_enable = false" in minetest.conf. -In case of conflict hud.conf configuration is dominant. - - -Currently supported food: -------------------------- -- Apples (default) -- Animalmaterials (mobf modpack) -- Bread (default) -- Bushes -- bushes_classic -- Creatures -- Dwarves (beer and such) -- Docfarming -- Fishing -- Farming plus -- Farming (default and Tenplus1's fork) -- Food -- fruit -- Glooptest -- JKMod -- kpgmobs -- Mobfcooking -- Mooretrees -- Mtfoods -- mushroom -- mush45 -- Seaplants (sea) -- Simple mobs - -Example: 1 apple fills up the hunger bar by 1 bread, 1 bread (from farming) 2 breads in bar. - -Although it show 20 hunger points (10 breads) in hunger bar, -you can fill it up to 30 points.(5 breads not shown then) +Dependencies: +- HUD bars [hudbars], major version 1 +- 3D Armor [3d_armor] (tested with 0.4.3) License of textures: -------------------- -hud_heart_fg.png - celeron55 (CC BY-SA 3.0), modified by BlockMen -hud_heart_bg.png - celeron55 (CC BY-SA 3.0), modified by BlockMen -hud_hunger_fg.png - PilzAdam (WTFPL), modified by BlockMen -hud_hunger_bg.png - PilzAdam (WTFPL), modified by BlockMen -wieldhand.png (from character.png) - Jordach (CC BY-SA 3.0), modified by BlockMen -hud_air_fg.png - kaeza (WTFPL), modified by BlockMen -hud_armor_fg.png - Stu (CC BY-SA 3.0), modified by BlockMen -hud_armor_bg.png - Stu (CC BY-SA 3.0), modified by BlockMen +hbarmor_icon.png - Stu (CC BY-SA 3.0), modified by BlockMen +hbarmor_bar.png - Wuzzy (WTFPL) + everything else is WTFPL: (c) Copyright BlockMen (2013-2014)