summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt61
1 files changed, 24 insertions, 37 deletions
diff --git a/README.txt b/README.txt
index d2899c5..3f5ac6d 100644
--- a/README.txt
+++ b/README.txt
@@ -1,37 +1,32 @@
-Minetest mod "Better HUD"
-=========================
-Version: 1.4.1
+Minetest mod: Hunger [hbhunger]
+===============================
+Version: 0.1.0
License of source code: WTFPL
-----------------------------
-(c) Copyright BlockMen (2013-2015)
+by Wuzzy (2015)
+Forked from the “Better HUD (and hunger)” mod 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.
-
-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.
-
-
-!!IMPORTANT !!:
-Keep in mind if running a server with this mod, that the custom position should be displayed correct on every screen size!!
+This mod adds a mechanic for hunger.
+This mod depends on the HUD bars mod [hudbars], major version 1.
+You can create a "hunger.conf" file to customize the properties of hunger for your needs.
-=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.
+About hunger
+============
+This mod adds a hunger mechanic to the game.
+A new player starts with 20 saturation points out of 30.
+Player actions like digging, placing and walking cause exhausion, which lower the player's
+saturation. Also every 800 seconds you lose 1 saturation point without doing anything.
+If you are hungry (0 saturation) you will suffer damage and die in case you don't eat something.
+If your saturation is greater than 15, you will slowly regenerate health points.
+Eating food will increase your saturation.
+Important: Eating food will not directly increase your health anymore, as long as the food item
+is supported by this mod (see below).
Currently supported food:
@@ -60,23 +55,15 @@ Currently supported food:
- 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)
-
+Examples:
+Eating an apple (from the default Minetest game) increases your saturation by 2,
+eating a bread (from the default Minetest game) increases your saturation by 4.
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
+hunger_icon.png - PilzAdam (WTFPL), modified by BlockMen
+hunger_bar.png - Wuzzy (WTFPL)
everything else is WTFPL:
(c) Copyright BlockMen (2013-2015)