Add the game

mods/wield3d/.gitignore

@@ -0,0 +1,6 @@
+## Generic ignorable patterns and files
+*~
+.*.swp
+*bak*
+tags
+*.vim

mods/wield3d/.luacheckrc

@@ -0,0 +1,13 @@
+allow_defined_top = true
+max_line_length = 80
+
+read_globals = {
+	"vector",
+	table = {fields = {"getn"}},
+
+	"core",
+	"minetest",
+}
+
+globals = {
+}

mods/wield3d/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Stuart Jones
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mods/wield3d/README.md

@@ -0,0 +1,24 @@
+3d wielded items [wield3d]
+==========================
+
+This is a mod for Luanti/Minetest which makes hand wielded items visible
+to other players.
+
+For engine version: 5.0.0 or later.
+
+![screenshot](screenshot.png)
+
+Settings: see [settingtypes.txt](settingtypes.txt) (or in the main menu)
+
+### Game Compatibility
+
+wield3d is generic and supports all games. However, certain items might not be
+shown perfectly, thus this mod includes specific improvements for the following games:
+
+ * Minetest Game
+
+### Known Issues
+
+Items occasionally disappear when viewing in 3rd person. This is a minetest engine bug and not the fault of the mod, turning 3rd person off then back on restores the view.
+
+Wield item switches direction at certain animation key-frames. I have yet to identify the true cause of this issue but a specially adapted version of the player model can be found [here](https://github.com/stujones11/minetest-models/tree/master/character/sam_viewer) that attempts to work around the problem.

mods/wield3d/init.lua

@@ -0,0 +1,211 @@
+--[[
+
+MIT License
+
+Copyright (c) 2019 stujones11, Stuart Jones
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+]]--
+
+wield3d = {}
+
+dofile(core.get_modpath(core.get_current_modname()) .. "/location.lua")
+
+local player_wielding = {}
+local has_wieldview = core.get_modpath("wieldview")
+local update_time = core.settings:get("wield3d_update_time")
+local verify_time = core.settings:get("wield3d_verify_time")
+local wield_scale = core.settings:get("wield3d_scale")
+
+update_time = update_time and tonumber(update_time) or 1
+verify_time = verify_time and tonumber(verify_time) or 10
+wield_scale = wield_scale and tonumber(wield_scale) or 0.25 -- default scale
+
+local location = {
+	"Arm_Right", -- default bone
+	{x = 0, y = 5.5, z = 3}, -- default position
+	{x = -90, y = 225, z = 90}, -- default rotation
+	{x = wield_scale, y = wield_scale},
+}
+
+local function add_wield_entity(player)
+	if not player or not player:is_player() then
+		return
+	end
+	local name = player:get_player_name()
+	local pos = player:get_pos()
+	if name and pos and not player_wielding[name] then
+		pos.y = pos.y + 0.5
+		local object = core.add_entity(pos, "wield3d:wield_entity", name)
+		if object then
+			object:set_attach(player, location[1], location[2], location[3])
+			object:set_properties({
+				textures = {"wield3d:hand"},
+				visual_size = location[4],
+			})
+			player_wielding[name] = {item = "", location = location}
+		end
+	end
+end
+
+local function sq_dist(a, b)
+	local x = a.x - b.x
+	local y = a.y - b.y
+	local z = a.z - b.z
+	return x * x + y * y + z * z
+end
+
+local wield_entity = {
+	initial_properties ={
+		physical = false,
+		collide_with_objects = false,
+		pointable = false,
+		static_save = false,
+		collisionbox = {-0.125,-0.125,-0.125, 0.125,0.125,0.125},
+		visual = "wielditem",
+		textures = {"wield3d:hand"}
+	},
+	wielder = nil,
+	timer = 0
+}
+
+function wield_entity:on_activate(staticdata)
+	if staticdata and staticdata ~= "" then
+		self.wielder = staticdata
+		return
+	end
+	self.object:remove()
+end
+
+function wield_entity:on_step(dtime)
+	if self.wielder == nil then
+		return
+	end
+	self.timer = self.timer + dtime
+	if self.timer < update_time then
+		return
+	end
+	local player = core.get_player_by_name(self.wielder)
+	if player == nil or not player:is_player() or
+			sq_dist(player:get_pos(), self.object:get_pos()) > 3 then
+		self.object:remove()
+		return
+	end
+	local wield = player_wielding[self.wielder]
+	local stack = player:get_wielded_item()
+	local item = stack:get_name() or ""
+	if wield and item ~= wield.item then
+		if has_wieldview then
+			local def = core.registered_items[item] or {}
+			if def.inventory_image ~= "" then
+				item = ""
+			end
+		end
+		wield.item = item
+		if item == "" then
+			item = "wield3d:hand"
+		end
+		local loc = wield3d.location[item] or location
+		if loc[1] ~= wield.location[1] or
+				not vector.equals(loc[2], wield.location[2]) or
+				not vector.equals(loc[3], wield.location[3]) then
+			self.object:set_attach(player, loc[1], loc[2], loc[3])
+			wield.location = {loc[1], loc[2], loc[3]}
+		end
+		self.object:set_properties({
+			textures = {item},
+			visual_size = loc[4],
+		})
+	end
+	self.timer = 0
+end
+
+local function table_iter(t)
+	local i = 0
+	local n = table.getn(t)
+	return function ()
+		i = i + 1
+		if i <= n then
+			return t[i]
+		end
+	end
+end
+
+local player_iter = nil
+
+local function verify_wielditems()
+	if player_iter == nil then
+		local names = {}
+		local tmp = {}
+		for player in table_iter(core.get_connected_players()) do
+			local name = player:get_player_name()
+			if name then
+				tmp[name] = true;
+				table.insert(names, name)
+			end
+		end
+		player_iter = table_iter(names)
+		-- clean-up player_wielding table
+		for name, wield in pairs(player_wielding) do
+			player_wielding[name] = tmp[name] and wield
+		end
+	end
+	 -- only deal with one player per server step
+	local name = player_iter()
+	if name then
+		local player = core.get_player_by_name(name)
+		if player and player:is_player() then
+			local pos = player:get_pos()
+			pos.y = pos.y + 0.5
+			local wielding = false
+			local objects = core.get_objects_inside_radius(pos, 1)
+			for _, object in pairs(objects) do
+				local entity = object:get_luaentity()
+				if entity and entity.wielder == name then
+					if wielding then
+						-- remove duplicates
+						object:remove()
+					end
+					wielding = true
+				end
+			end
+			if not wielding then
+				player_wielding[name] = nil
+				add_wield_entity(player)
+			end
+		end
+		return core.after(0, verify_wielditems)
+	end
+	player_iter = nil
+	core.after(verify_time, verify_wielditems)
+end
+
+core.after(verify_time, verify_wielditems)
+
+core.register_entity("wield3d:wield_entity", wield_entity)
+
+core.register_item("wield3d:hand", {
+	type = "none",
+	wield_image = "blank.png"
+})
+
+core.register_on_joinplayer(function(player)
+	core.after(2, add_wield_entity, player)
+end)

mods/wield3d/location.lua

@@ -0,0 +1,62 @@
+--[[
+
+MIT License
+
+Copyright (c) 2019 stujones11, Stuart Jones
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+]]--
+
+-- Wielded Item Location Overrides - [item_name] = {bone, position, rotation}
+
+local bone = "Arm_Right"
+local pos = {x=0, y=5.5, z=3}
+local scale = {x=0.25, y=0.25}
+local rx = -90
+local rz = 90
+
+wield3d.location = {
+	["default:torch"] = {bone, pos, {x=rx, y=180, z=rz}, scale},
+	["default:sapling"] = {bone, pos, {x=rx, y=180, z=rz}, scale},
+	["flowers:dandelion_white"] = {bone, pos, {x=rx, y=180, z=rz}, scale},
+	["flowers:dandelion_yellow"] = {bone, pos, {x=rx, y=180, z=rz}, scale},
+	["flowers:geranium"] = {bone, pos, {x=rx, y=180, z=rz}, scale},
+	["flowers:rose"] = {bone, pos, {x=rx, y=180, z=rz}, scale},
+	["flowers:tulip"] = {bone, pos, {x=rx, y=180, z=rz}, scale},
+	["flowers:viola"] = {bone, pos, {x=rx, y=180, z=rz}, scale},
+	["default:shovel_wood"] = {bone, pos, {x=rx, y=135, z=rz}, scale},
+	["default:shovel_stone"] = {bone, pos, {x=rx, y=135, z=rz}, scale},
+	["default:shovel_steel"] = {bone, pos, {x=rx, y=135, z=rz}, scale},
+	["default:shovel_bronze"] = {bone, pos, {x=rx, y=135, z=rz}, scale},
+	["default:shovel_mese"] = {bone, pos, {x=rx, y=135, z=rz}, scale},
+	["default:shovel_diamond"] = {bone, pos, {x=rx, y=135, z=rz}, scale},
+	["bucket:bucket_empty"] = {bone, pos, {x=rx, y=135, z=rz}, scale},
+	["bucket:bucket_water"] = {bone, pos, {x=rx, y=135, z=rz}, scale},
+	["bucket:bucket_lava"] = {bone, pos, {x=rx, y=135, z=rz}, scale},
+	["screwdriver:screwdriver"] = {bone, pos, {x=rx, y=135, z=rz}, scale},
+	["screwdriver:screwdriver1"] = {bone, pos, {x=rx, y=135, z=rz}, scale},
+	["screwdriver:screwdriver2"] = {bone, pos, {x=rx, y=135, z=rz}, scale},
+	["screwdriver:screwdriver3"] = {bone, pos, {x=rx, y=135, z=rz}, scale},
+	["screwdriver:screwdriver4"] = {bone, pos, {x=rx, y=135, z=rz}, scale},
+	["vessels:glass_bottle"] = {bone, pos, {x=rx, y=135, z=rz}, scale},
+	["vessels:drinking_glass"] = {bone, pos, {x=rx, y=135, z=rz}, scale},
+	["vessels:steel_bottle"] = {bone, pos, {x=rx, y=135, z=rz}, scale},
+}
+

mods/wield3d/mod.conf

@@ -0,0 +1,3 @@
+name = wield3d
+description = Adds 3d wield-items that are visible in third person view and to other players.
+min_minetest_version = 5.0

mods/wield3d/settingtypes.txt

@@ -0,0 +1,9 @@
+#    Time interval (in seconds) for refreshing wielded objects.
+wield3d_update_time (Wield item update time) float 1.0 0.0 5.0
+
+#    Time interval (in seconds) for performing sanity-checks on the wield item object.
+#    This restores vanished objects, or removes duplicates.
+wield3d_verify_time (Wield item verify time) float 10.0 1.0 30.0
+
+#    How large the wield item should be.
+wield3d_scale (Wield item scale) float 0.25 0.1 0.5