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 2.3.3.
  15 It works for Minetest 5.3.0.
  16
  17 This software uses [semantic versioning](http://semver.org), as defined by version 2.0.0 of the SemVer
  18 standard.
  19
  20 ## Settings
  21 This mod can be configured quite a bit. You can change HUD bar appearance, offsets, ordering, and more.
  22 Use the advanced settings menu in Minetest for detailed configuration.
  23
  24 ## API
  25 The API is used to add your own custom HUD bars.
  26 Documentation for the API of this mod can be found in `API.md`.
  27
  28 ## Legal
  29 ### License of source code
  30 Author: Wuzzy (2015)
  31
  32 Also: This mod was forked from the “Better HUD” [hud] mod by BlockMen.
  33
  34 Translations:
  35
  36 * German: Wuzzy
  37 * Portuguese: BrunoMine
  38 * Turkish: admicos
  39 * Dutch: kingoscargames
  40 * Italian: Hamlet
  41 * Malay: muhdnurhidayat
  42 * Russian: Imk
  43 * Spanish: wuniversales
  44
  45 This program is free software. It comes without any warranty, to
  46 the extent permitted by applicable law. You can redistribute it
  47 and/or modify it under the terms of the MIT License.
  48
  49 ### Licenses of textures
  50
  51 * `hudbars_icon_health.png`—celeron55 (CC BY-SA 3.0), modified by BlockMen
  52 * `hudbars_bgicon_health.png`—celeron55 (CC BY-SA 3.0), modified by BlockMen
  53 * `hudbars_icon_breath.png`—kaeza (MIT License), modified by BlockMen, modified again by Wuzzy
  54 * `hudbars_bgicon_breath.png`—based on previous image, edited by Wuzzy (MIT License)
  55 * `hudbars_bar_health.png`—Wuzzy (MIT License)
  56 * `hudbars_bar_breath.png`—Wuzzy (MIT License)
  57 * `hudbars_bar_background.png`—Wuzzy (MIT License)
  58
  59 ### License references
  60
  61 * [CC-BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/)
  62 * [MIT License](https://opensource.org/licenses/MIT)