README.md

   1 # HUD bars
   2
   3 ## Description
   4 This mod changes the HUD of Minetest. It replaces the default health and breath
   5 symbols by horizontal colored bars with text showing the number.
   6
   7 Furthermore, it enables other mods to add their own custom bars to the HUD,
   8 this mod will place them accordingly.
   9
  10 **Important**: Keep in mind if running a server with this mod, that the custom
  11 position should be displayed correctly on every screen size.
  12
  13 ## Current version
  14 The current version is 1.7.1.
  15
  16 This software uses [semantic versioning](http://semver.org), as defined by version 2.0.0 of the SemVer
  17 standard.
  18
  19 ## Settings
  20 This mod can be configured quite a bit. You can change HUD bar appearance, offsets, ordering, and more.
  21 Use the advanced settings menu in Minetest for detailed configuration.
  22
  23 ## API
  24 The API is used to add your own custom HUD bars.
  25 Documentation for the API of this mod can be found in `API.md`.
  26
  27 ## Legal
  28 ### License of source code
  29 Author: Wuzzy (2015)
  30
  31 Also: This mod was forked from the “Better HUD” [hud] mod by BlockMen.
  32
  33 Translations:
  34
  35 * German: Wuzzy
  36 * Portuguese: BrunoMine
  37
  38 This program is free software. It comes without any warranty, to
  39 the extent permitted by applicable law. You can redistribute it
  40 and/or modify it under the terms of the Do What The Fuck You Want
  41 To Public License (WTFPL), version 2, as published by Sam Hocevar.
  42
  43 ### Licenses of textures
  44
  45 * `hudbars_icon_health.png`—celeron55 (CC BY-SA 3.0), modified by BlockMen
  46 * `hudbars_bgicon_health.png`—celeron55 (CC BY-SA 3.0), modified by BlockMen
  47 * `hudbars_icon_breath.png`—kaeza (WTFPL), modified by BlockMen, modified again by Wuzzy
  48 * `hudbars_bgicon_breath.png`—based on previous image, edited by Wuzzy (WTFPL)
  49 * `hudbars_bar_health.png`—Wuzzy (WTFPL)
  50 * `hudbars_bar_breath.png`—Wuzzy (WTFPL)
  51 * `hudbars_bar_background.png`—Wuzzy (WTFPL)
  52
  53 ### License references
  54
  55 * [CC-BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/)
  56 * [WTFPL](http://sam.zoy.org/wtfpl/COPYING)