Update documentation

This commit is contained in:
Wuzzy 2015-02-23 23:42:16 +01:00
parent 00accc22ec
commit e52921ba97
3 changed files with 18 additions and 151 deletions

View File

@ -1,37 +1,26 @@
Minetest mod "Better HUD"
=========================
Version: 1.4
Minetest mod: Hunger
====================
Version: 0.1.0
License of source code: WTFPL
-----------------------------
(c) Copyright BlockMen (2013-2014)
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.
This mod adds a mechanic for hunger.
This mod depends on the HUD bars mod [hudbars], major version 1.
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.
You can create a "hunger.conf" file to customize the properties of hunger for your needs.
!!IMPORTANT !!:
Keep in mind if running a server with this mod, that the custom position should be displayed correct on every screen size!!
=Hunger=
========
About 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.
If you are hungry (0 saturation) you will suffer damage and die in case you don't eat something.
Currently supported food:
@ -60,7 +49,9 @@ 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.
Examples:
Eating an apple increases your saturation by 2,
eating a bread (from the farming mod) increases your saturation by 4.
Although it show 20 hunger points (10 breads) in hunger bar,
you can fill it up to 30 points.(5 breads not shown then)
@ -69,14 +60,8 @@ you can fill it up to 30 points.(5 breads not shown then)
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-2014)

View File

@ -1,88 +1,3 @@
0.2 Beta
--------
- added support of custom config files
- you can eat max. 50% more than before (although it isnt shown in hunger bar)
- you get healed with 8 breads and more (in hunger bar) now
- a bread (from farming) == 2 breads in hunger bar
0.2.1 Beta
----------
- tweaked override of food
- added support for food of dwares, moretrees and simple mobs
0.2.2 Beta
----------
- added support for food of animalmaterials (mobf modpack),fishing
0.2.3 Beta
----------
- added support for food of glooptest and bushes (commit by CheeseKeg)
0.3 Beta
----------
- added fancy borders of hud inventory bar (only for screenheight <= 800)
0.4 Beta
----------
- enabled drowning
0.5 Beta
----------
- removed the fancy borders of hud inventory bar and moved to new native support
- moved crosshair to native support too
1.0
---
- hunger is reset after death
- health and hunger bar is shown correct on all screen resolutions now
- switched to changed native hotbar image support
- fixed revival of player when drown
- hunger bar is not shown anymore if hunger is disabled
- hunger can be disabled by minetest.conf ("hud_hunger_enable = false")
1.1
---
- added support for stu's 3darmor mod
- restructured and cleaned up code
- added support for poisen food (damages player, but does not kill)
1.2
---
- Send statbar values only to client when changed
- Hide armor bar if not wearing armor
- More reliable food overrides (by CiaranG)
- Support for bushes_classic foods (plantlife modpack) (by CiaranG)
- Add support for mushroom mod food/poison (by CiaranG)
- Add support for mods: fruit and mush45
- New images for hotbar, smaller armor icons
1.3
---
- New way hunger is saved (all old files in world dirctory can get deleted [e.g. hud_BlockMen_hunger])
- Fixed healing (not while drowning, fix after death)
- Add support for mods: seaplants[sea] and mobfcooking (by Xanthin)
- Tweaked hand image
- Player can die caus of starving now
1.3.1
0.1.0
-----
- Add compatibility for statbar scaling
- Fix typo in depends.txt
- Lower maintimer tick
1.3.2
-----
- Fix dependecies (by Chris Beelby)
- Add support for creatures mod
- Add optional healing for food (by TenPlus1)
1.3.3
-----
- Prevent crash with armor mod and missing player
- Add support for ethereal mod (by TenPlus1)
1.4
---
- New hunger mechanics/added experimental player-action based hunger
- Better crosshair texture, switched to "new" default hand
- Added support for farming redo mod, kpgmobs and jkmod
Initial release

View File

@ -1,33 +0,0 @@
--##Better HUD example config file##
------------------------------------
-- This example moves the health bar in the top left corner and the hunger bar in the top right corner
--
-- general settings
--
HUD_ENABLE_HUNGER = true --enables/disables hunger
HUD_HUNGER_TICK = 300 --sets time for loosing 1/2 bread (of 10) (in seconds)
--!NOTICE!--
-- >>if damage is disabled neither health bar nor hunger bar or breath bar is shown
--
-- health bar
--
HUD_HEALTH_POS = {x=0,y=0} --min 0, max 1
HUD_HEALTH_OFFSET = {x=5,y=30} --offset in pixel
--
-- hunger bar
--
HUD_HUNGER_POS = {x=1,y=0} --min 0, max 1
HUD_HUNGER_OFFSET = {x=-175,y=30} --offset in pixel
--
-- breath bar
--
HUD_AIR_POS = {x=0.5,y=1} --min 0, max 1
HUD_AIR_OFFSET = {x=15,y=-75} --offset in pixel