Replace Travis CI with GitHub Actions (#12)

Co-authored-by: sys4 <bricassa@sys4.fr>

.github/workflows/build.yml

@@ -0,0 +1,20 @@
+name: build
+on: [push, pull_request]
+
+jobs:
+  luacheck:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install dependencies
+      run: |
+        sudo apt-get update -qq
+        sudo apt-get install -qqq luarocks
+    - name: Install LuaCheck and pre-commit
+      run: |
+        pip3 install pre-commit
+        luarocks install --local luacheck
+    - name: Run LuaCheck with pre-commit
+      run: |
+        export PATH="$HOME/.luarocks/bin:$PATH"
+        pre-commit run --all-files

.luacheckrc

@@ -21,6 +21,11 @@ stds.minetest = {
 				"copy",
 			},
 		},
+		math = {
+			fields = {
+				"round",
+			},
+		}
 	}
 }
 

.travis.yml

@@ -1,16 +0,0 @@
-dist: bionic
-language: python
-
-python:
-  - 3.7.1
-
-install:
-  - sudo apt-get update -qq
-  - 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"
-  - pre-commit run --all-files

CHANGELOG.md

@@ -7,8 +7,57 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Changed
+
+- [Health and breath bars now adapt to custom maximum values instead of being hardcoded to 20 and 11 respectively.](https://github.com/minetest-mods/gauges/pull/9)
+
+### Fixed
+
+- [The health bar entity is no longer lost when a player teleports.](https://github.com/minetest-mods/gauges/pull/10)
+  - A side effect is that health bar entities are no longer saved in map metadata.
+
+## [1.0.4] - 2020-09-27
+
+### Added
+
+- Support for Minetest 5.3 and improved Minetest version definitions.
+
+### Changed
+
+- Gauge entities are now removed when the mod is disabled or when the server switches to creative mode.
+
+## [1.0.3] - 2020-02-15
+
+### Fixed
+
+- Fix an issue with gauges occasionally no longer appearing above a player.
+
+### Changed
+
+- Improved the reliability of the Minetest version check (for compatibility with 0.4.17).
+
+## [1.0.2] - 2020-01-16
+
+### Fixed
+
+- Fix crash when creating an entity if a player leaves the server quickly.
+
+### Changed
+
+- Restore Minetest 0.4.17 support. The version check works only with `minetest_game` with the `player_api` mod added in Minetest 5.0.
+
+## [1.0.1] - 2020-01-01
+
+### Changed
+
+- Improve performance by localizing the `vector.distance()` function.
+
 ## 1.0.0 - 2020-01-01
 
 - Initial versioned release.
 
-[Unreleased]: https://github.com/minetest-mods/gauges/compare/v1.0.0...HEAD
+[Unreleased]: https://github.com/minetest-mods/gauges/compare/v1.0.4...HEAD
+[1.0.4]: https://github.com/minetest-mods/gauges/compare/v1.0.3...v1.0.4
+[1.0.3]: https://github.com/minetest-mods/gauges/compare/v1.0.2...v1.0.3
+[1.0.2]: https://github.com/minetest-mods/gauges/compare/v1.0.1...v1.0.2
+[1.0.1]: https://github.com/minetest-mods/gauges/compare/v1.0.0...v1.0.1

README.md

@@ -1,5 +1,7 @@
 # Gauges
 
+![Preview](https://content.minetest.net/uploads/GBoKauWSou.png)
+
 Gauges for [Minetest](https://www.minetest.net/), a free and open source infinite
 world block sandbox game.
 
@@ -18,9 +20,7 @@ git clone https://github.com/minetest-mods/gauges.git
 
 You can also
 [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.
+of Gauges.
 
 ### Enable the mod
 
@@ -60,9 +60,8 @@ on that line.
 
 ## Version compatibility
 
-Gauges is currently primarily tested with Minetest 5.1.0. It may or may not work
-with newer or older versions. Issues arising in versions older than 5.0.0
-will generally not be fixed.
+Gauges currently supports Minetest 5.0 and later, as well as 0.4.17.
+Issues arising in versions older than 5.0 will generally not be fixed.
 
 ## License
 

init.lua

@@ -3,38 +3,86 @@
 -- Copyright © 2014-2020 4aiman, Hugo Locurcio and contributors - MIT License
 -- See `LICENSE.md` included in the source distribution for details.
 
-if minetest.settings:get_bool("health_bars") == false or
-		not minetest.settings:get_bool("enable_damage")
-then return end
+local function round(v)
+	return math.floor(v + 0.5)
+end
+
+local enabled = minetest.settings:get_bool("health_bars") ~= false
+if enabled then
+	enabled = minetest.settings:get_bool("enable_damage")
+end
+
+-- Localize this functions for better performance,
+-- as it's called on every step
+local vector_distance = vector.distance
+local max = {
+	breath = 11,
+	hp = 20,
+}
+
+local mt_5 = minetest.features.object_independent_selectionbox
+
+local function add_gauge(player)
+	if player and player:is_player() then
+		local entity = minetest.add_entity(player:get_pos(), "gauges:hp_bar")
+
+		-- Check Minetest version and set required entity heigh
+		-- (The entity height offset was changed in Minetest 5.0.0)
+		local height = mt_5 and 19 or 9
+
+		entity:set_attach(player, "", {x=0, y=height, z=0}, {x=0, y=0, z=0})
+		entity:get_luaentity().wielder = player
+	end
+end
+
+-- credit:
+-- https://github.com/minetest/minetest/blob/master/builtin/game/statbars.lua#L31-L37
+local function scaleToDefault(player, field)
+	-- Scale "hp" or "breath" to supported amount
+	local current = player["get_" .. field](player)
+	local max_display = math.max(player:get_properties()[field .. "_max"], current)
+	return round(current / max_display * max[field])
+end
 
 minetest.register_entity("gauges:hp_bar", {
 	visual = "sprite",
-	visual_size = {x=1, y=1/16, z = 1},
-	-- The texture is changed later in the code
+	visual_size = {x=1, y=1/16, z=1},
 	textures = {"blank.png"},
 	collisionbox = {0},
 	physical = false,
+	static_save = false,
 
 	on_step = function(self)
 		local player = self.wielder
+		local gauge = self.object
 
-		if not player or
-				not minetest.is_player(player) or
-				vector.distance(player:get_pos(), self.object:get_pos()) > 3
-		then
-			self.object:remove()
+		if not enabled or
+				not player or not player:is_player() then
+			gauge:remove()
+			return
+		elseif vector_distance(player:get_pos(), gauge:get_pos()) > 3 then
+			gauge:remove()
+			add_gauge(player)
 			return
 		end
 
-		local hp = player:get_hp() <= 20 and player:get_hp() or 20
-		local breath = player:get_breath() <= 10 and player:get_breath() or 11
+		local hp = scaleToDefault(player, "hp")
+		local breath = scaleToDefault(player, "breath")
 
 		if self.hp ~= hp or self.breath ~= breath then
-			self.object:set_properties({
-				textures = {
-					"health_"..tostring(hp)..".png^"..
-					"breath_"..tostring(breath)..".png"
-				}
+			local health_t = "health_"..hp..".png"
+			local breath_t = "breath_"..breath..".png"
+
+			if hp == 0 then
+				health_t = "blank.png"
+			end
+
+			if breath == max.breath then
+				breath_t = "blank.png"
+			end
+
+			gauge:set_properties({
+				textures = {health_t.."^"..breath_t}
 			})
 			self.hp = hp
 			self.breath = breath
@@ -42,13 +90,8 @@ minetest.register_entity("gauges:hp_bar", {
 	end
 })
 
-local function add_gauge(player)
-	local entity = minetest.add_entity(player:get_pos(), "gauges:hp_bar")
-
-	entity:set_attach(player, "", {x=0, y=19, z=0}, {x=0, y=0, z=0})
-	entity:get_luaentity().wielder = player
+if enabled then
+	minetest.register_on_joinplayer(function(player)
+		minetest.after(1, add_gauge, player)
+	end)
 end
-
-minetest.register_on_joinplayer(function(player)
-	minetest.after(1, add_gauge, player)
-end)

mod.conf

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