Remove lumberjack privs, add further improvements

README.md

@@ -3,25 +3,48 @@
 A Mod for tree harvesting and planting!
 
 This mod fulfills several aspects:
-- New players are trained to always fell trees completely and replace them with saplings (education for sustainability)
+
-- Trained players with additional "skills" get lumberjack privs to fell trees more efficiently (based on ideas from TreeCapitator and several Timber mods)
+- New players are trained to always fell trees completely and replace them with
+  saplings (education for sustainability)
+- Trained players get lumberjack "skills" to fell trees more efficiently
+  (based on ideas from TreeCapitator and several Timber mods)
 - No parts of trees hanging in the air anymore
   
-This mod allows to completely fell trees by destroying only one block. The whole tree is harvested and moved to the players inventory. But therefore lumberjack privs are needed. New player normally will not get the necessary privs immediately, they have to harvest the tree from the top, block by block "to improve their skills".
 
-But there are three configuration possibilities:
+This mod allows to completely fell trees by destroying only one block.
-1. All players get directly lumberjack privs
+The whole tree is harvested and moved to the players inventory.
-2. Players have to collect points to get lumberjack privs
+But therefore some lumberjack skills are needed. New player normally will
-3. Players will never get lumberjack privs from the mod itself (but will be granted by means of other reasons)
+not get the necessary skills immediately, they have to harvest the tree from
+the top, block by block "to improve their skills".
+
+There are two configuration possibilities:
+
+1. All players get directly lumberjack skills
+2. Players have to collect points to get lumberjack skills
 
 Points have to be collected by harvesting tree blocks *AND* planting saplings.
-The default setting is 400 which means, you have to harvest more then 400 tree blocks and plant more then 66 (400/6) saplings to get lumberjack privs.
+The default setting is 400 which means, you have to harvest more then 400 tree
+blocks and plant more then 66 (400/6) saplings to get lumberjack skills.
 
-The configuration can be changed directly in the file 'settingtypes.txt' or by means of the Minetest GUI.
+The configuration can be changed directly in the file 'settingtypes.txt' or
+by means of the Minetest GUI.
+
+The mod provides two chat commands:
+
+- `/lumberjack` to retrieve your lumberjack skill status. This command can be used
+  by each player.
+- `/set_lumberjack_points <name> <points>` to set the lumberjack points of
+  a player. You need `server` privs to be able to use this command.
+  Ex1: `/set_lumberjack_points Tom 400` sets Tom back to starting conditions
+  Ex2: `/set_lumberjack_points Susan 0` gives Susan all lumberjack skills
 
 Some technical aspects:
-- 'param1' of the nodes data is used to distinguish between grown trees and placed tree blocks so that this mod will not have any impact to buildings or other objects based on tree blocks
+
-- an API function allows to register additional trees from other mods, which is quite simple
+- `param1` of the nodes data is used to distinguish between grown trees and
+  placed tree blocks so that this mod will not have any impact to buildings
+  or other objects based on tree blocks
+- an API function allows to register additional trees from other mods,
+  which is quite simple
 - the Ethereal mod is already supported, others will follow
 
 
@@ -29,8 +52,9 @@ Some technical aspects:
 default
 
 # License
-Copyright (C) 2018-2020 Joachim Stolberg  
+Copyright (C) 2018-2021 Joachim Stolberg
-Code: Licensed under the GNU LGPL version 2.1 or later. See LICENSE.txt and http://www.gnu.org/licenses/lgpl-2.1.txt  
+Code: Licensed under the GNU LGPL version 2.1 or later.
+See LICENSE.txt and http://www.gnu.org/licenses/lgpl-2.1.txt
 Sound is taken from Hybrid Dog (TreeCapitator)
 
 # History
@@ -42,4 +66,4 @@ v0.5 - 17/Apr/2018 - protection bug fixed, further improvements
 v0.6 - 07/Jan/2020 - screwdriver bugfix  
 v0.7 - 27/May/2020 - ethereal bugfix  
 v0.8 - 29/Jul/2020 - fake player bugfix  
-	
+v1.0 - 19/Mar/2021 - remove the lumberjack privs due to minetest engine issues

init.lua

@@ -3,7 +3,7 @@
 	lumberjack
 	==========
 
-	Copyright (C) 2018 Joachim Stolberg
+	Copyright (C) 2018-2021 Joachim Stolberg
 
 	LGPLv2.1+
 	See LICENSE.txt for more information
@@ -21,11 +21,14 @@
 
 lumberjack = {}
 
+-- Test MT 5.4 new string mode
+local CLIP = minetest.features.use_texture_alpha_string_modes and "clip" or true
+
 local MY_PARAM1_VAL = 7  -- to identify placed nodes
 
 -- Necessary number of points for dug trees and placed sapling to get lumberjack privs
 local LUMBERJACK_TREE_POINTS = tonumber(minetest.settings:get("lumberjack_points")) or 400
-local LUMBERJACK_SAPL_POINTS = LUMBERJACK_TREE_POINTS / 6
+local LUMBERJACK_SAPL_POINTS = math.floor(LUMBERJACK_TREE_POINTS / 6)
 
 local lTrees = {} -- List of registered tree items
 
@@ -35,12 +38,11 @@ local lTrees = {} -- List of registered tree items
 local function chopper_tool(digger)
 	if digger and digger:is_player() then
 		local tool = digger:get_wielded_item()
-		if tool:get_name() == "screwdriver:screwdriver" then
-			return true
-		end
 		if tool then
 			local caps = tool:get_tool_capabilities()
-			return caps.groupcaps and caps.groupcaps.choppy
+			if caps.groupcaps and caps.groupcaps.choppy and caps.groupcaps.choppy.maxlevel then
+				return caps.groupcaps.choppy.maxlevel < 3
+			end
 		end 
 	end
 	return false
@@ -92,7 +94,7 @@ local function add_wear(digger, node, num_nodes)
 end
 
 --
--- Remove all treen nodes including steps in the given area
+-- Remove all tree nodes including steps in the given area
 --
 local function remove_items(pos1, pos2, name)
 	local cnt = 0
@@ -120,47 +122,52 @@ end
 --
 -- Check for the necessary number of points and grant lumberjack privs if level is reached
 --
-local function check_points(player)
-	local player_attributes = player:get_meta()
-	local points
 
-	if player_attributes:get("lumberjack_tree_points") then
+local function get_points(player)
-		points = player_attributes:get_float("lumberjack_tree_points")
+	if player and player.is_player and player:is_player() then
-	else
+		local meta = player:get_meta()
-		points = LUMBERJACK_TREE_POINTS
+		
+		if not meta:contains("lumberjack_tree_points") then
+			meta:set_int("lumberjack_tree_points", LUMBERJACK_TREE_POINTS)
+		end
+		if not meta:contains("lumberjack_sapl_points") then
+			meta:set_int("lumberjack_sapl_points", LUMBERJACK_SAPL_POINTS)
 		end
 		
-	if player_attributes:get("lumberjack_sapl_points") then
+		local tree_points = meta:get_int("lumberjack_tree_points")
-		points = points	+ player_attributes:get_float("lumberjack_sapl_points")
+		local sapl_points = meta:get_int("lumberjack_sapl_points")
-	else
-		points = points	+ LUMBERJACK_SAPL_POINTS
-	end
 		
-	if points > 0 then
+		return tree_points, sapl_points
+	end
+end
+
+local function is_lumberjack(player, tree_points, sapl_points)
+	if not tree_points or not sapl_points then
 		return false
-	elseif points == 0 then
+	elseif tree_points > 0 or sapl_points > 0 then
-		local privs = minetest.get_player_privs(player:get_player_name())
+		return false
-		privs.lumberjack = true
+	elseif tree_points == 0 or sapl_points == 0 then
-		minetest.set_player_privs(player:get_player_name(), privs)
+		local meta = player:get_meta()
-		player_attributes:get_float("lumberjack_tree_points", "-1")
+		if not meta:contains("is_lumberjack") then
-		player_attributes:get_float("lumberjack_sapl_points", "-1")
+			meta:set_int("is_lumberjack", 1)
-		minetest.chat_send_player(player:get_player_name(), "You got lumberjack privs now")
+			local player_name = player:get_player_name()
-		minetest.log("action", player:get_player_name().." got lumberjack privs")
+			minetest.chat_send_player(player_name, "You're a real lumberjack now!")
+			minetest.log("action", player_name.." got lumberjack privs")
+		end
 	end
 	return true
 end
 
 --
--- Maintain lumberjack points and grant lumberjack privs if level is reached
+-- Maintain lumberjack points
 --
-local function needed_points(digger)
+local function after_dig_tree(digger)
-	local digger_attributes = digger:get_meta()
+	local tree_points, sapl_points = get_points(digger)
-	local points = digger_attributes:get_float("lumberjack_tree_points") or LUMBERJACK_TREE_POINTS
+	if tree_points then
-	if points > 0 then
+		tree_points = tree_points - 1
-		digger_attributes:set_float("lumberjack_tree_points", points - 1)
+		local meta = digger:get_meta()
-	end
+		meta:set_int("lumberjack_tree_points", tree_points)
-	if points == 0 then
+		is_lumberjack(digger, tree_points, sapl_points)
-		return check_points(digger)
 	end
 	return false
 end
@@ -169,15 +176,12 @@ end
 -- Decrement sapling points
 --
 local function after_place_sapling(pos, placer)
-	if placer and placer.is_player and placer:is_player() and placer.get_meta then
+	local tree_points, sapl_points = get_points(placer)
-		local placer_attributes = placer:get_meta()
+	if sapl_points then
-		local points = placer_attributes:get_float("lumberjack_sapl_points") or LUMBERJACK_SAPL_POINTS
+		sapl_points = sapl_points - 1
-		if points > 0 then
+		local meta = placer:get_meta()
-			placer_attributes:set_float("lumberjack_sapl_points", points - 1)
+		meta:set_int("lumberjack_sapl_points", sapl_points)
-		end
+		is_lumberjack(placer, tree_points, sapl_points)
-		if points == 0 then
-			check_points(placer)
-		end
 	end
 end	
 
@@ -219,6 +223,8 @@ end
 local function after_dig_node(pos, oldnode, oldmetadata, digger)
 	-- Player placed node?
 	if oldnode.param1 ~= 0 then return end
+	
+	after_dig_tree(digger)
 	remove_steps(pos)
 	-- don't remove whole tree?
 	if not digger or digger:get_player_control().sneak then	return end
@@ -256,32 +262,27 @@ local function can_dig(pos, digger)
 	if not digger then
 		return true
 	end
-	if minetest.is_protected(pos, digger:get_player_name()) then
+	local name = digger:get_player_name()
+	if minetest.is_protected(pos, name) then
 		return false
 	end
-	if minetest.check_player_privs(digger:get_player_name(), "lumberjack") then
+	local tree_points, sapl_points = get_points(digger)
+	if is_lumberjack(digger, tree_points, sapl_points) then
 		if chopper_tool(digger) then
 			return true
-		else
-			minetest.chat_send_player(digger:get_player_name(), "[Lumberjack Mod] You have to use an axe")
-			return false
 		end
 	end
 	local node = minetest.get_node(pos)
 	if node.param1 ~= 0 then 
 		return true
 	end
-	if is_top_tree_node(pos, node.name) or needed_points(digger) then
+	if is_top_tree_node(pos, node.name) then
 		return true
 	end
-	minetest.chat_send_player(digger:get_player_name(), "[Lumberjack Mod] From the top, please")
+	minetest.chat_send_player(name, "[Lumberjack Mod] From the top, please")
 	return false
 end
 
-minetest.register_privilege("lumberjack", 
-	{description = "Gives you the rights to fell a tree at once", 
-	give_to_singleplayer = true})
-
 minetest.register_node("lumberjack:step", {
 	description = "Lumberjack Step",
 	drawtype = "nodebox",
@@ -296,7 +297,7 @@ minetest.register_node("lumberjack:step", {
 	is_ground_content = false,
 	climbable = true,
 	paramtype = "light",
-	use_texture_alpha = true,
+	use_texture_alpha = CLIP,
 	sunlight_propagates = true,
 	walkable = false,
 	pointable = false,
@@ -350,6 +351,46 @@ function lumberjack.register_tree(tree_name, sapling_name, radius, stem_height_m
 	lTrees[tree_name] = {radius=radius, height_min=stem_height_min, choppy=data.groups.choppy}
 end
 
+minetest.register_chatcommand("lumberjack", {
+	description = "Output your lumberjack points",
+	func = function(name, param)
+		local tree_points, sapl_points = get_points(minetest.get_player_by_name(name))
+		if tree_points > 0 and sapl_points > 0 then
+			return true, "You need further " .. tree_points .. " tree " .. " and " .. sapl_points .. " sapling points."
+		elseif tree_points > 0 then
+			return true, "You need further " .. tree_points .. " tree points."
+		elseif sapl_points > 0 then
+			return true, "You need further " .. sapl_points .. " sapling points."
+		else
+			return true, "You are already a lumberjack."
+		end
+	end
+})
+
+minetest.register_chatcommand("set_lumberjack_points", {
+	params = "<name> <tree-points>",
+	description = "Give a player lumberjack points",
+	privs = {server = true},
+	func = function(name, param)
+		local param_name, points = param:match("^(%S+)%s+(%d+)$")
+		if param_name and points then
+			local tree_points = tonumber(points) or 0
+			local sapl_points = math.floor(tree_points / 6)
+			local player = minetest.get_player_by_name(param_name)
+			if player then
+				local meta = player:get_meta()
+				meta:set_int("lumberjack_tree_points", tree_points)
+				meta:set_int("lumberjack_sapl_points", sapl_points)
+				meta:set_string("is_lumberjack", "")
+				return true, "Player " .. param_name .. " now has " .. tree_points .. " tree and " .. sapl_points .. " sapling points."
+			end
+			return true, "Player " .. param_name .. "is unknown!"
+		end
+		return false
+	end
+})
+
+	
 lumberjack.register_tree("default:tree", "default:sapling", 1, 2)
 lumberjack.register_tree("default:jungletree", "default:junglesapling", 1, 5)
 lumberjack.register_tree("default:acacia_tree", "default:acacia_sapling", 2, 3)

settingtypes.txt

@@ -1,5 +1,4 @@
 # Settings for Lumberjack privs
 # 0  = Every player has lumberjack privs from the beginning.
-# -1 = No player gets lumberjack privs. The priv has to come from somewhere else.
 # >0 = Player has to collect the number points to get lumberjack privs (default 400).
 lumberjack_points (needed points to get lumberjack privs) int 400