mods/PLAYER/mcl_hunger/README.md

   1 # Hunger for MineClone 2 [`mcl_hunger`]
   2
   3 * Forked from `hbhunger`, version: 0.5.2
   4
   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.”.
  10
  11 ## About hunger
  12 This mod adds a hunger mechanic to the game. Players get a new attribute called “satiation”:
  13
  14 * A new player starts with 20 satiation points out of 20
  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!)
  20
  21 ## Statbar mode
  22 If you use the statbar mode of the HUD Bars mod, these things are important to know:
  23 As with all mods using HUD Bars, the bread statbar symbols represent the rough percentage
  24 out of 30 satiation points, in steps of 5%, so the symbols give you an estimate of your
  25 satiation. This is different from the hunger mod by BlockMen.
  26
  27 You gain health at 5.5 symbols or more, as 5.5 symbols correspond to 16 satiation points.
  28 You *may* lose health at exactly 0.5 symbols, as 0.5 symbols correspond to 1-2 satiation points.
  29
  30 ### Examples
  31
  32 * Eating an apple (from Minetest Game) increases your satiation by 2;
  33 * eating a bread (from Minetest Game) increases your satiation by 4.
  34
  35 ## Licensing
  36 This mod is free software.
  37
  38 ### Source code
  39
  40 * License: [LGPL v2.1](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html)
  41 * Author: by Wuzzy (2015-2016)
  42 * Forked from `hbhunger` for MineClone 2. `hbhunger` in turn was forked from the “Better HUD
  43   (and hunger)” mod by BlockMen (2013-2015), most code comes from this mod.
  44
  45 ### Textures and sounds
  46
  47 * `hbhunger_icon.png`—PilzAdam ([WTFPL](http://www.wtfpl.net/txt/copying/)), modified by BlockMen
  48 * `hbhunger_bgicon.png`—PilzAdam (WTFPL), modified by BlockMen
  49 * `hbhunger_bar.png—Wuzzy` (WTFPL)
  50 * `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
  51 * `mcl_hunger_bite.1.ogg`, `mcl_hungr_bite.2.ogg`: WTFPL
  52 * `survival_thirst_drink.ogg`: WTFPL
  53 * Everything else: WTFPL, by BlockMen and Wuzzy
  54