Merge branch 'master' of yunohost.local:minetest-mods/hbsprint into nalc-1.2-dev

* Update mod.conf

* Delete description.txt

No longer needed.

* Delete depends.txt

No longer needed.

README.md

@@ -12,12 +12,14 @@ A flexible sprint mod supporting stamina, hunger and coexistance with other phys
 
 ## Notes
 hbSprint can be played with Minetest 0.4.16 or above.
-It has no dependencies, but it supports on [hudbars](http://repo.or.cz/w/minetest_hudbars.git), [hbhunger](http://repo.or.cz/w/minetest_hbhunger.git) and [player_monoids](https://github.com/minetest-mods/player_monoids).
+It has no dependencies, but supports [hudbars](https://repo.or.cz/minetest_hudbars.git) and [player_monoids](https://github.com/minetest-mods/player_monoids).
+
+Compatible hunger mods: [hbhunger](https://repo.or.cz/minetest_hbhunger.git) or [hunger_ng](https://gitlab.com/4w/hunger_ng).
 
 ## List of features
 
 - Displays and drains stamina (by default, if hudbars is present). Hides stamina bar if full.
-- Displays and drains satiation (by default, if hbhunger is present)
+- Displays and drains satiation (by default, if compatible hunger mod found)
 - Drains air faster while sprinting on walkable ground but in water (by default)
 - Requires only forward key to be pressed, not left and right (by default)
 - Requires walkable ground (no water surface sprinting)
@@ -32,6 +34,6 @@ It has no dependencies, but it supports on [hudbars](http://repo.or.cz/w/minetes
 You can report bugs or suggest ideas by [filing an issue](http://github.com/tacotexmex/hbsprint/issues/new).
 
 ## Links
-* [Download ZIP](https://github.com/tacotexmex/hbsprint/archive/master.zip)
-* [Source](https://github.com/tacotexmex/hbsprint/)
+* [Download ZIP](https://github.com/minetest-mods/hbsprint/archive/master.zip)
+* [Source](https://github.com/minetest-mods/hbsprint)
 * [Forum thread](https://forum.minetest.net/viewtopic.php?f=9&t=18069&p=282981)

depends.txt

@@ -1,4 +0,0 @@
-player_monoids?
-hudbars?
-hbhunger?
-hunger_ng?

description.txt

@@ -1 +0,0 @@
-A flexible sprint mod supporting stamina, hunger and monoids.

init.lua

@@ -1,115 +1,142 @@
 -- Vars
 
-local speed         = tonumber(minetest.settings:get ("sprint_speed")) or 1.3
-local jump          = tonumber(minetest.settings:get ("sprint_jump")) or 1.1
-local key           = minetest.settings:get ("sprint_key") or "Use"
-local dir           = minetest.settings:get_bool("sprint_forward_only") ~= false
-local particles     = tonumber(minetest.settings:get ("sprint_particles")) or 2
-local stamina       = minetest.settings:get_bool("sprint_stamina") ~= false
-local stamina_drain = tonumber(minetest.settings:get ("sprint_stamina_drain")) or 2
-local replenish     = tonumber(minetest.settings:get ("sprint_stamina_replenish")) or 2
-local starve        = minetest.settings:get_bool("sprint_starve") ~= false
-local starve_drain  = tonumber(minetest.settings:get ("sprint_starve_drain")) or 0.5
-local starve_limit  = tonumber(minetest.settings:get ("sprint_starve_limit")) or 6
-local breath        = minetest.settings:get_bool("sprint_breath") ~= false
-local breath_drain  = tonumber(minetest.settings:get ("sprint_breath_drain")) or 1
-local autohide      = minetest.settings:get_bool("hudbars_autohide_stamina") ~= false
+local function setting_get(name, default)
+	return minetest.settings:get(name) or default
+end
+
+local speed         = tonumber(setting_get("sprint_speed", "1.3"))
+local jump          = tonumber(setting_get("sprint_jump", "1.1"))
+local dir           = minetest.is_yes(setting_get("sprint_forward_only", "false"))
+local particles     = tonumber(setting_get("sprint_particles", "2"))
+local stamina       = minetest.is_yes(setting_get("sprint_stamina", "true"))
+local stamina_drain = tonumber(setting_get("sprint_stamina_drain", "2"))
+local replenish     = tonumber(setting_get("sprint_stamina_replenish", "2"))
+local starve        = minetest.is_yes(setting_get("sprint_starve", "true"))
+local starve_drain  = tonumber(setting_get("sprint_starve_drain", "0.5"))
+local starve_limit  = tonumber(setting_get("sprint_starve_limit", "6"))
+local breath        = minetest.is_yes(setting_get("sprint_breath", "true"))
+local breath_drain  = tonumber(setting_get("sprint_breath_drain", "1"))
+local autohide      = minetest.is_yes(setting_get("hudbars_autohide_stamina", "true"))
 
 local sprint_timer_step = 0.5
 local sprint_timer = 0
-local stamina_timer = 0
-local breath_timer = 0
+local sprinting = {}
+local stamina_timer = {}
+local breath_timer = {}
 
-local hudbars = minetest.get_modpath("hudbars") or false
-local monoids = minetest.get_modpath("player_monoids") or false
-local starve
+local mod_hudbars = minetest.get_modpath("hudbars") ~= nil
+local mod_player_monoids = minetest.get_modpath("player_monoids") ~= nil
+local mod_playerphysics = minetest.get_modpath("playerphysics") ~= nil
+
+if starve then
   if minetest.get_modpath("hbhunger") then
     starve = "hbhunger"
   elseif minetest.get_modpath("hunger_ng") then
     starve = "hunger_ng"
-  --starve_drain = starve_drain * -1
   else
     starve = false
   end
+end
 if minetest.settings:get_bool("creative_mode") then
   starve = false
 end
+
 -- Functions
 
 local function start_sprint(player)
-  if player:get_attribute("hbsprint:sprinting") == "false" then
-    if monoids then
+  local name = player:get_player_name()
+  if not sprinting[name] then
+    if mod_player_monoids then
       player_monoids.speed:add_change(player, speed, "hbsprint:speed")
       player_monoids.jump:add_change(player, jump, "hbsprint:jump")
+    elseif mod_playerphysics then
+      playerphysics.add_physics_factor(player, "speed", "hbsprint:speed", speed)
+      playerphysics.add_physics_factor(player, "jump", "hbsprint:jump", jump)
     else
       player:set_physics_override({speed = speed, jump = jump})
     end
+    sprinting[name] = true
   end
 end
 
 local function stop_sprint(player)
-  if player:get_attribute("hbsprint:sprinting") == "true" then
-    if monoids then
+  local name = player:get_player_name()
+  if sprinting[name] then
+    if mod_player_monoids then
       player_monoids.speed:del_change(player, "hbsprint:speed")
       player_monoids.jump:del_change(player, "hbsprint:jump")
+    elseif mod_playerphysics then
+      playerphysics.remove_physics_factor(player, "speed", "hbsprint:speed")
+      playerphysics.remove_physics_factor(player, "jump", "hbsprint:jump")
     else
       player:set_physics_override({speed = 1, jump = 1})
     end
+    sprinting[name] = false
   end
 end
 
 local function drain_stamina(player)
-  local player_stamina = tonumber(player:get_attribute("hbsprint:stamina"))
+  local player_stamina = player:get_meta():get_float("hbsprint:stamina")
   if player_stamina > 0 then
-    player:set_attribute("hbsprint:stamina", player_stamina - stamina_drain)
+    player_stamina = math.max(0, player_stamina - stamina_drain)
+    player:get_meta():set_float("hbsprint:stamina", player_stamina)
   end
-  if hudbars then
+  if mod_hudbars then
     if autohide and player_stamina < 20 then hb.unhide_hudbar(player, "stamina") end
     hb.change_hudbar(player, "stamina", player_stamina)
   end
 end
 
 local function replenish_stamina(player)
-  local player_stamina = tonumber(player:get_attribute("hbsprint:stamina"))
+  local player_stamina = player:get_meta():get_float("hbsprint:stamina")
   if player_stamina < 20 then
-    player:set_attribute("hbsprint:stamina", player_stamina + stamina_drain)
+    player_stamina = math.min(20, player_stamina + stamina_drain)
+    player:get_meta():set_float("hbsprint:stamina", player_stamina)
   end
-  if hudbars then
+  if mod_hudbars then
     hb.change_hudbar(player, "stamina", player_stamina)
-    if autohide and player_stamina == 20 then hb.hide_hudbar(player, "stamina") end
+    if autohide and player_stamina >= 20 then hb.hide_hudbar(player, "stamina") end
   end
 end
 
-local function drain_hunger(player, hunger, name)
-  if hunger > 0 then
-    local newhunger = hunger - starve_drain
+local function drain_hunger(player, name)
   if starve == "hbhunger" then
-      hbhunger.hunger[name] = newhunger
+    local hunger = tonumber(hbhunger.hunger[name]) - starve_drain
+    hbhunger.hunger[name] = math.max(0, hunger)
     hbhunger.set_hunger_raw(player)
   elseif starve == "hunger_ng" then
-      player:set_attribute("hunger_ng:hunger", newhunger)
-    end
+    hunger_ng.alter_hunger(name, -starve_drain, "Sprinting")
   end
 end
 
 local function drain_breath(player)
   local player_breath = player:get_breath()
-  if player_breath < 11 then
-    player_breath = player_breath - breath_drain
-    if player_breath > 0 then
+  if player_breath < player:get_properties().breath_max then
+    player_breath = math.max(0, player_breath - breath_drain)
     player:set_breath(player_breath)
   end
 end
+
+local function is_walkable(ground)
+  local ground_def = minetest.registered_nodes[ground.name]
+  return ground_def and (ground_def.walkable and ground_def.liquidtype == "none")
 end
 
-local function create_particles(player, name, pos, ground)
-  if ground and ground.name ~= "air" and ground.name ~= "ignore" then
+local function create_particles(player, name, ground)
   local def = minetest.registered_nodes[ground.name]
-    local tile = def.tiles[1] or def.inventory_image or ""
-    if type(tile) == "string" then
+  local tile = def.tiles[1] or def.inventory_image
+  if type(tile) == "table" then
+    tile = tile.name
+  end
+  if not tile then
+    return
+  end
+
+  local pos = player:get_pos()
+  local rand = function() return math.random(-1,1) * math.random() / 2 end
   for i = 1, particles do
     minetest.add_particle({
-          pos = {x = pos.x + math.random(-1,1) * math.random() / 2, y = pos.y + 0.1, z = pos.z + math.random(-1,1) * math.random() / 2},
+      pos = {x = pos.x + rand(), y = pos.y + 0.1, z = pos.z + rand()},
       velocity = {x = 0, y = 5, z = 0},
       acceleration = {x = 0, y = -13, z = 0},
       expirationtime = math.random(),
@@ -119,12 +146,10 @@ local function create_particles(player, name, pos, ground)
     })
   end
 end
-  end
-end
 
 -- Registrations
 
-if minetest.get_modpath("hudbars") ~= nil and stamina then
+if mod_hudbars and stamina then
   hb.register_hudbar(
     "stamina",
     0xFFFFFF,
@@ -140,71 +165,90 @@ if minetest.get_modpath("hudbars") ~= nil and stamina then
 end
 
 minetest.register_on_joinplayer(function(player)
-  if hudbars and stamina then hb.init_hudbar(player, "stamina", 20, 20, autohide) end
-  player:set_attribute("hbsprint:stamina", 20)
+  if stamina then
+    if mod_hudbars then
+      hb.init_hudbar(player, "stamina", 20, 20, autohide)
+    end
+    player:get_meta():set_float("hbsprint:stamina", 20)
+  end
 end)
 
-minetest.register_globalstep(function(dtime)
-  sprint_timer = sprint_timer + dtime
-  stamina_timer = stamina_timer + dtime
-  breath_timer = breath_timer + dtime
-  if sprint_timer >= sprint_timer_step then
-    for _,player in ipairs(minetest.get_connected_players()) do
+local function sprint_step(player, dtime)
+  local name = player:get_player_name()
+
+  if minetest.get_player_privs(name).fast then
+    return
+  end
+
+  if stamina then
+    stamina_timer[name] = (stamina_timer[name] or 0) + dtime
+  end
+  if breath then
+    breath_timer[name] = (breath_timer[name] or 0) + dtime
+  end
+
   local ctrl = player:get_player_control()
-      local key_press = false
-      if key == "Use" and dir then
+  local key_press
+  if dir then
     key_press = ctrl.aux1 and ctrl.up and not ctrl.left and not ctrl.right
-      elseif key == "Use" and not dir then
+  else
     key_press = ctrl.aux1
   end
-      -- if key == "W" and dir then
-      --   key_press = ctrl.aux1 and ctrl.up or key_press and ctrl.up
-      -- elseif key == "W" then
-      --   key_press = ctrl.aux1 or key_press and key_tap
-      -- end
 
-      if key_press then
-        local name = player:get_player_name()
+  if not key_press then
+    stop_sprint(player)
+    if stamina and stamina_timer[name] >= replenish then
+      replenish_stamina(player)
+      stamina_timer[name] = 0
+    end
+    return
+  end
+
+  local ground_pos = player:get_pos()
+  ground_pos.y = math.floor(ground_pos.y)
+  -- check if player is reasonably near a walkable node
+  local ground
+  for _, y_off in ipairs({0, -1, -2}) do
+    local testpos = vector.add(ground_pos, {x=0, y=y_off, z=0})
+    local testnode = minetest.get_node_or_nil(testpos)
+    if testnode ~= nil and is_walkable(testnode) then
+      ground = testnode
+      break
+    end
+  end
+
+  local player_stamina = 1
+  if stamina then
+    player_stamina = player:get_meta():get_float("hbsprint:stamina")
+  end
   local hunger = 30
-        local pos = player:get_pos()
-        local ground = minetest.get_node_or_nil({x=pos.x, y=pos.y-1, z=pos.z})
-        local walkable = false
-        local player_stamina = tonumber(player:get_attribute("hbsprint:stamina"))
   if starve == "hbhunger" then
     hunger = tonumber(hbhunger.hunger[name])
   elseif starve == "hunger_ng" then
-          hunger = tonumber(player:get_attribute("hunger_ng:hunger"))
+    hunger = hunger_ng.get_hunger_information(name).hunger.exact
   end
-        if ground ~= nil then
-          local ground_def = minetest.registered_nodes[ground.name]
-          if ground_def then
-            walkable = minetest.registered_nodes[ground.name].walkable
-          end
-        end
-        if player_stamina > 0 and hunger > starve_limit and walkable then
+
+  if player_stamina > 0 and hunger > starve_limit and ground then
     start_sprint(player)
-          player:set_attribute("hbsprint:sprinting", "true")
     if stamina then drain_stamina(player) end
-          if starve then drain_hunger(player, hunger, name) end
-          if breath then
-            if breath_timer >= 2 then
+    if starve then drain_hunger(player, name) end
+    if breath and breath_timer[name] >= 2 then
       drain_breath(player)
-              breath_timer = 0
+      breath_timer[name] = 0
     end
-          end
-          if particles then create_particles(player, name, pos, ground) end
-        else
-          stop_sprint(player)
-          player:set_attribute("hbsprint:sprinting", "false")
+    if particles then
+      create_particles(player, name, ground)
     end
   else
     stop_sprint(player)
-        player:set_attribute("hbsprint:sprinting", "false")
-        if stamina_timer >= replenish then
-          if stamina then replenish_stamina(player) end
-          stamina_timer = 0
   end
 end
+
+minetest.register_globalstep(function(dtime)
+  sprint_timer = sprint_timer + dtime
+  if sprint_timer >= sprint_timer_step then
+    for _, player in ipairs(minetest.get_connected_players()) do
+      sprint_step(player, sprint_timer)
     end
     sprint_timer = 0
   end

mod.conf

@@ -1 +1,3 @@
 name = hbsprint
+optional_depends = player_monoids, hudbars, hbhunger, hunger_ng
+description = A flexible sprint mod supporting stamina, hunger and monoids.

settingtypes.txt

@@ -4,9 +4,6 @@ sprint_speed (Sprint speed multiplier) float 1.3
 #Sprint jump multiplier
 sprint_jump (Sprint jump multiplier) float 1.1
 
-#Use a key to sprint
-sprint_key (Sprint key) enum Use Use
-
 #Require player to move forward only to be able to sprint
 sprint_forward_only (Sprint forward only) bool true