Fix outdated intllib boilerplate
[minetest_hbhunger.git] / README.txt
blobf8bd8b3b80c38904cfd2d1e928be3f5968756a10
1 Minetest mod: Hunger [hbhunger]
2 ===============================
3 Version: 0.5.1
5 Using the mod:
6 --------------
7 This mod adds a mechanic for hunger.
8 This mod depends on the HUD bars mod [hudbars], version 1.4.1 or any later version
9 starting with “1.”.
11 About hunger
12 ============
13 This mod adds a hunger mechanic to the game. Players get a new attribute called “satiation”
15 - A new player starts with 20 satiation points out of 30.
16 - Actions like digging, placing and walking cause exhausion, which lower the satiation
17 - Every 800 seconds you lose 1 satiation point without doing anything
18 - At 1 or 0 satiation you will suffer damage and die in case you don't eat something
19 - If your satiation is 16 or higher, you will slowly regenerate health points
20 - Eating food will increase your satiation (Duh!)
22 Important: Eating food will not directly increase your health anymore, as long as the food
23 item is supported by this mod (see below).
25 Careful! Some foods may be poisoned. If you eat a poisoned item, you may still get a satiation
26 boost, but for a brief perioud you lose health points because of food poisoning. However,
27 food poisoning can never kill you.
29 Statbar mode
30 ============
31 If you use the statbar mode of the HUD Bars mod, these things are important to know:
32 As with all mods using HUD Bars, the bread statbar symbols represent the rough percentage
33 out of 30 satiation points, in steps of 5%, so the sybols give you an estimate of your
34 satiation. This is different from the hunger mod by BlockMen.
36 You gain health at 5.5 symbols or more, as 5.5 symbols correspond to 16 satiation points.
37 You MAY lose health at exactly 0.5 symbols, as 0.5 symbols correspond to 1-2 satiation points.
39 Supported food:
40 ---------------
41 All mods which add food through standard measures (minetest.item_eat) are already
42 supported automatically. Poisoned food needs special support.
44 Known supported food mods:
45 --------------------------
46 - Apple [default]
47 - Red and brown mushroom [flowers]
48 - Bread [farming]
50 - [animalmaterials] (Mob Framework (mobf modpack))
51 - Bushes [bushes]
52 - [bushes_classic]
53 - Creatures [creatures]
54 - [dwarves] (beer and such)
55 - Docfarming [docfarming]
56 - Ethereal [ethereal]
57 - Farming [farming] from Minetest Game
58 - Farming Redo [farming] by TenPlus1
59 - Farming plus [farming_plus]
60 - Ferns [ferns]
61 - Fishing [fishing]
62 - [fruit]
63 - Glooptest [glooptest]
64 - JKMod ([jkanimals], [jkfarming], [jkwine])
65 - [kpgmobs]
66 - [mobfcooking]
67 - [mooretrees]
68 - [mtfoods]
69 - [mushroom]
70 - [mush45]
71 - Seaplants [sea]
72 - Simple mobs [mobs]
73 - Pizza [pizza]
74 - Not So Simple Mobs [nssm]
76 Supported mods without optional dependency (mods provide their own support):
77 - Food ([food], [food_basic])
78 - Sweet Foods [food_sweet]
80 Examples: 
81 Eating an apple (from Minetest Game) increases your satiation by 2,
82 eating a bread (from Minetest Game) increases your satiation by 4.
84 License of source code: LGPL v2.1
85 ---------------------------------
86 by Wuzzy (2015-2016)
88 Forked from the “Better HUD (and hunger)” mod by BlockMen (2013-2015),
89 most code comes from this mod.
91 License of textures:
92 --------------------
93 hbhunger_icon.png - PilzAdam (WTFPL), modified by BlockMen
94 hbhunger_bgicon.png - PilzAdam (WTFPL), modified by BlockMen
95 hbhunger_bar.png - Wuzzy (WTFPL)
96 hbhunger_icon_health_poison.png - celeron55 (CC BY-SA 3.0), modified by BlockMen, modified again by Wuzzy
98 everything else is WTFPL
99 Authors: BlockMen and Wuzzy