Add a project changelog

This also improves formatting to comply with Minetest's
Lua code style guidelines.

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.1.0
+    rev: v2.3.0
     hooks:
       - id: end-of-file-fixer
       - id: trailing-whitespace

.travis.yml

@@ -1,16 +1,16 @@
-language: generic
+dist: bionic
+language: python
 
-addons:
+python:
-  apt:
+  - 3.7.1
-    packages:
-    - luarocks
 
 install:
-  - pyenv global 3.6.3
+  - sudo apt-get update -qq
-  - pip3 install --user pre-commit
+  - sudo apt-get install -qqq luarocks
+  - pip3 install pre-commit
   - luarocks install --local luacheck
 
 script:
   # All linters are run with pre-commit hooks
   - export PATH="$HOME/.luarocks/bin:$PATH"
-  - $HOME/.local/bin/pre-commit run --all-files
+  - pre-commit run --all-files

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## 1.0.0 - 2020-01-01
+
+- Initial versioned release.
+
+[Unreleased]: https://github.com/minetest-mods/gauges/compare/v1.0.0...HEAD

LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2014-2019 4aiman, Hugo Locurcio and contributors
+Copyright © 2014-2020 4aiman, Hugo Locurcio and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -13,11 +13,11 @@ To install Gauges, clone this Git repository into your Minetest's `mods/`
 directory:
 
 ```bash
-git clone https://github.com/Calinou/gauges.git
+git clone https://github.com/minetest-mods/gauges.git
 ```
 
 You can also
-[download a ZIP archive](https://github.com/Calinou/gauges/archive/master.zip)
+[download a ZIP archive](https://github.com/minetest-mods/gauges/archive/master.zip)
 of Gauges. If you do so, you will need to extract the archive then rename
 the resulting folder from `gauges-master` to `gauges` – this is
 **absolutely** required, as the mod won't work otherwise.
@@ -60,13 +60,13 @@ on that line.
 
 ## Version compatibility
 
-Gauges is currently primarily tested with Minetest 0.4.17.
+Gauges is currently primarily tested with Minetest 5.1.0. It may or may not work
-It may or may not work with newer or older versions. Issues arising in older
+with newer or older versions. Issues arising in versions older than 5.0.0
-versions than 0.4.17 will generally not be fixed.
+will generally not be fixed.
 
 ## License
 
-Copyright © 2014-2019 4aiman, Hugo Locurcio and contributors
+Copyright © 2014-2020 4aiman, Hugo Locurcio and contributors
 
 - Code is licensed under the MIT license, see
   [`LICENSE.md`](LICENSE.md) for details.

init.lua

@@ -1,64 +1,54 @@
 -- gauges: Adds health/breath bars above players
 --
--- Copyright © 2014-2019 4aiman, Hugo Locurcio and contributors - MIT License
+-- Copyright © 2014-2020 4aiman, Hugo Locurcio and contributors - MIT License
 -- See `LICENSE.md` included in the source distribution for details.
 
-local hp_bar = {
+if minetest.settings:get_bool("health_bars") == false or
-	physical = false,
+		not minetest.settings:get_bool("enable_damage")
-	collisionbox = {x = 0, y = 0, z = 0},
+then return end
+
+minetest.register_entity("gauges:hp_bar", {
 	visual = "sprite",
-	textures = {"20.png"}, -- The texture is changed later in the code
+	visual_size = {x=1, y=1/16, z = 1},
-	visual_size = {x = 1.5, y = 0.09375, z = 1.5}, -- Y value is (1 / 16) * 1.5
+	-- The texture is changed later in the code
-	wielder = nil,
+	textures = {"blank.png"},
-}
+	collisionbox = {0},
+	physical = false,
 
-function vector.sqdist(a, b)
+	on_step = function(self)
-	local dx = a.x - b.x
+		local player = self.wielder
-	local dy = a.y - b.y
-	local dz = a.z - b.z
-	return dx * dx + dy * dy + dz * dz
-end
 
-function hp_bar:on_step(dtime)
+		if not player or
-	local wielder = self.wielder and minetest.get_player_by_name(self.wielder)
+				not minetest.is_player(player) or
+				vector.distance(player:get_pos(), self.object:get_pos()) > 3
+		then
+			self.object:remove()
+			return
+		end
 
-	if
+		local hp = player:get_hp() <= 20 and player:get_hp() or 20
-		wielder == nil or
+		local breath = player:get_breath() <= 10 and player:get_breath() or 11
-		vector.sqdist(wielder:get_pos(), self.object:get_pos()) > 3
+
-	then
+		if self.hp ~= hp or self.breath ~= breath then
-		self.object:remove()
+			self.object:set_properties({
-		return
+				textures = {
+					"health_"..tostring(hp)..".png^"..
+					"breath_"..tostring(breath)..".png"
+				}
+			})
+			self.hp = hp
+			self.breath = breath
+		end
 	end
+})
 
-	local hp = wielder:get_hp()
+local function add_gauge(player)
-	local breath = wielder:get_breath()
+	local entity = minetest.add_entity(player:get_pos(), "gauges:hp_bar")
 
-	self.object:set_properties({
+	entity:set_attach(player, "", {x=0, y=19, z=0}, {x=0, y=0, z=0})
-		textures = {
+	entity:get_luaentity().wielder = player
-			"health_" .. tostring(hp) .. ".png^breath_" .. tostring(breath) .. ".png",
-		},
-	})
 end
 
-minetest.register_entity("gauges:hp_bar", hp_bar)
+minetest.register_on_joinplayer(function(player)
-
+	minetest.after(1, add_gauge, player)
-local function add_HP_gauge(name)
+end)
-	local player = minetest.get_player_by_name(name)
-	local pos = player:get_pos()
-	local ent = minetest.add_entity(pos, "gauges:hp_bar")
-
-	if ent ~= nil then
-		ent:set_attach(player, "", {x = 0, y = 10, z = 0}, {x = 0, y = 0, z = 0})
-		ent = ent:get_luaentity()
-		ent.wielder = player:get_player_name()
-	end
-end
-
-if
-	minetest.settings:get_bool("enable_damage") and
-	minetest.settings:get_bool("health_bars") ~= false
-then
-	minetest.register_on_joinplayer(function(player)
-		minetest.after(1, add_HP_gauge, player:get_player_name())
-	end)
-end

mod.conf

@@ -0,0 +1,2 @@
+name = gauges
+description = Adds health and breath gauges above players.