Mark changelog as old
[minetest_hbhunger.git] / README.md
blob7d9de6bbe451b598ed73565f11f91384b1ba675f
1 # Hunger with HUD bar [`hbhunger`]
3 * Version: 0.7.1
5 ## Using the mod
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 This mod adds a hunger mechanic to the game. Players get a new attribute called “satiation”:
14 * A new player starts with 20 satiation points out of 30
15 * Actions like digging, placing and walking cause exhaustion, which lower the satiation
16 * Every 800 seconds you lose 1 satiation point without doing anything
17 * At 1 or 0 satiation you will suffer damage and die in case you don't eat something
18 * If your satiation is 16 or higher, you will slowly regenerate health points
19 * Eating food will increase your satiation (Duh!)
21 Important: Eating food will not directly increase your health anymore, as long as the food
22 item is supported by this mod (see below).
24 Careful! Some foods may be poisoned. If you eat a poisoned item, you may still get a satiation
25 boost, but for a brief period you lose health points because of food poisoning. However,
26 food poisoning can never kill you.
28 ## Statbar mode
29 If you use the statbar mode of the HUD Bars mod, these things are important to know:
30 As with all mods using HUD Bars, the bread statbar symbols represent the rough percentage
31 out of 30 satiation points, in steps of 5%, so the symbols give you an estimate of your
32 satiation. This is different from the hunger mod by BlockMen.
34 You gain health at 5.5 symbols or more, as 5.5 symbols correspond to 16 satiation points.
35 You *may* lose health at exactly 0.5 symbols, as 0.5 symbols correspond to 1-2 satiation points.
37 ## Supported food
38 All mods which add food through standard measures (`minetest.item_eat`) are already
39 supported automatically. Poisoned food needs special support.
41 ### Known supported food mods
42 * Apple from Minetest Game [`default`]
43 * Red and brown mushroom from Minetest Game [`flowers`]
44 * Bread from Minetest Game [`farming`]
45 * [`animalmaterials`] (Mob Framework (`mobf` modpack))
46 * Bushes [`bushes`]
47 * [`bushes_classic`]
48 * Creatures [`creatures`]
49 * [`dwarves`] (beer and such)
50 * Docfarming [`docfarming`]
51 * Ethereal / Ethereal NG [`ethereal`]
52 * Farming Redo [`farming`] by TenPlus1
53 * Farming plus [`farming_plus`]
54 * Ferns [`ferns`]
55 * Fishing [`fishing`]
56 * [`fruit`]
57 * Glooptest [`glooptest`]
58 * JKMod ([`jkanimals`], [`jkfarming`], [`jkwine`])
59 * [`kpgmobs`]
60 * [`mobfcooking`]
61 * [`mooretrees`]
62 * [`mtfoods`]
63 * [`mushroom`]
64 * [`mush45`]
65 * Seaplants [`sea`]
66 * Simple mobs [`mobs`]
67 * Pizza [`pizza`]
68 * Not So Simple Mobs [`nssm`]
70 ### Supported mods without optional dependency (mods provide their own support)
72 * Food ([`food`], [`food_basic`])
73 * Sweet Foods [`food_sweet`]
75 ### Examples
77 * Eating an apple (from Minetest Game) increases your satiation by 2;
78 * eating a bread (from Minetest Game) increases your satiation by 4.
80 ## Licensing
81 This mod is free software.
83 ### Source code
85 * License: [LGPL v2.1](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html)
86 * Author: by Wuzzy (2015-2016)
87 * Forked from the “Better HUD (and hunger)” mod by BlockMen (2013-2015),
88   most code comes from this mod.
90 ### Textures
92 * `hbhunger_icon.png`—PilzAdam ([MIT License](https://opensource.org/licenses/MIT)), modified by BlockMen
93 * `hbhunger_bgicon.png`—PilzAdam (MIT License), modified by BlockMen
94 * `hbhunger_bar.png—Wuzzy` (MIT License)
95 * `hbhunger_icon_health_poison.png`—celeron55 ([CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/)), modified by BlockMen, modified again by Wuzzy
96 * Everything else: MIT License, by BlockMen and Wuzzy