minetest_orienteering/init.lua

local S
if (minetest.get_modpath("intllib")) then
	dofile(minetest.get_modpath("intllib").."/intllib.lua")
	S = intllib.Getter(minetest.get_current_modname())
else
	S = function ( s ) return s end
end

local orienteering = {}
orienteering.playerhuds = {}
orienteering.settings = {}
orienteering.settings.speed_unit = S("m/s")
orienteering.settings.length_unit = S("m")
orienteering.settings.hud_pos = { x = 0.5, y = 0 }
orienteering.settings.hud_offset = { x = 0, y = 15 }
orienteering.settings.hud_alignment = { x = 0, y = 0 }

local set = tonumber(minetest.setting_get("orienteering_hud_pos_x"))
if set then orienteering.settings.hud_pos.x = set end
set = tonumber(minetest.setting_get("orienteering_hud_pos_y"))
if set then orienteering.settings.hud_pos.y = set end
set = tonumber(minetest.setting_get("orienteering_hud_offset_x"))
if set then orienteering.settings.hud_offset.x = set end
set = tonumber(minetest.setting_get("orienteering_hud_offset_y"))
if set then orienteering.settings.hud_offset.y = set end
set = minetest.setting_get("orienteering_hud_alignment")
if set == "left" then
	orienteering.settings.hud_alignment.x = 1
elseif set == "center" then
	orienteering.settings.hud_alignment.x = 0
elseif set == "right" then
	orienteering.settings.hud_alignment.x = -1
end

local o_lines = 4 -- Number of lines in HUD

-- Helper function to switch between 12h and 24 mode for the time
function toggle_time_mode(itemstack, user, pointed_thing)
	local name = user:get_player_name()
	if orienteering.playerhuds[name].twelve then
		orienteering.playerhuds[name].twelve = false
	else
		orienteering.playerhuds[name].twelve = true
	end
	update_hud_displays(user)
end

-- Displays height (Y)
minetest.register_tool("orienteering:altimeter", {
	description = S("Altimeter"),
	wield_image = "orienteering_altimeter.png",
	inventory_image = "orienteering_altimeter.png",
})

-- Displays X and Z coordinates
minetest.register_tool("orienteering:triangulator", {
	description = S("Triangulator"),
	wield_image = "orienteering_triangulator.png",
	inventory_image = "orienteering_triangulator.png",
})

-- Displays player yaw
-- TODO: calculate yaw difference between 2 points
minetest.register_tool("orienteering:compass", {
	description = S("Compass"),
	wield_image = "orienteering_compass_wield.png",
	inventory_image = "orienteering_compass_inv.png",
})

-- Displays player pitch
-- TODO: calculate pitch difference between 2 points
minetest.register_tool("orienteering:sextant", {
	description = S("Sextant"),
	wield_image = "orienteering_sextant_wield.png",
	inventory_image = "orienteering_sextant_inv.png",
})

-- Ultimate orienteering tool: Displays X,Y,Z, yaw, pitch, time, speed and enables the minimap
minetest.register_tool("orienteering:quadcorder", {
	description = S("Quadcorder"),
	wield_image = "orienteering_quadcorder.png",
	wield_scale = { x=1, y=1, z=3.5 },
	inventory_image = "orienteering_quadcorder.png",
	on_use = toggle_time_mode,
})

-- Displays game time
minetest.register_tool("orienteering:watch", {
	description = S("Watch"),
	wield_image = "orienteering_watch.png",
	inventory_image = "orienteering_watch.png",
	on_use = toggle_time_mode,
})

-- Displays speed
minetest.register_tool("orienteering:speedometer", {
	description = S("Speedometer"),
	wield_image = "orienteering_speedometer_wield.png",
	inventory_image = "orienteering_speedometer_inv.png",
})

-- Enables minimap
minetest.register_tool("orienteering:automapper", {
	description = S("Automapper"),
	wield_image = "orienteering_automapper_wield.png",
	wield_scale = { x=1, y=1, z=2 },
	inventory_image = "orienteering_automapper_inv.png",
})

-- Displays X,Y,Z coordinates, yaw and game time
minetest.register_tool("orienteering:gps", {
	description = S("GPS device"),
	wield_image = "orienteering_gps_wield.png",
	wield_scale = { x=1, y=1, z=2 },
	inventory_image = "orienteering_gps_inv.png",
	on_use = toggle_time_mode,
})

if minetest.get_modpath("default") ~= nil then
	-- Register crafts
	minetest.register_craft({
		output = "orienteering:altimeter",
		recipe = {
			{"default:glass"},
			{"default:steel_ingot"},
			{"default:steel_ingot"},
		}
	})
	minetest.register_craft({
		output = "orienteering:triangulator",
		recipe = {
			{"", "default:bronze_ingot", ""}, 
			{"default:bronze_ingot", "", "default:bronze_ingot"}, 
		}
	})
	minetest.register_craft({
		output = "orienteering:sextant",
		recipe = {
			{"", "default:gold_ingot", ""}, 
			{"default:gold_ingot", "default:gold_ingot", "default:gold_ingot"}, 
		}
	})
	minetest.register_craft({
		output = "orienteering:compass",
		recipe = {
			{"", "default:copper_ingot", ""}, 
			{"default:copper_ingot", "group:stick", "default:copper_ingot"}, 
			{"", "default:copper_ingot", ""}, 
		}
	})
	minetest.register_craft({
		output = "orienteering:speedometer",
		recipe = {
			{"", "default:gold_ingot", ""},
			{"default:steel_ingot", "group:stick", "default:steel_ingot"},
			{"", "default:steel_ingot", ""},
		}
	})
	minetest.register_craft({
		output = "orienteering:automapper",
		recipe = {
			{"default:gold_ingot", "default:gold_ingot", "default:gold_ingot"},
			{"default:mese_crystal", "default:obsidian_shard", "default:mese_crystal"},
			{"default:gold_ingot", "default:gold_ingot", "default:gold_ingot"}
		}
	})
	minetest.register_craft({
		output = "orienteering:gps",
		recipe = {
			{ "default:gold_ingot", "orienteering:triangulator", "default:gold_ingot" },
			{ "orienteering:compass", "default:bronze_ingot", "orienteering:watch" },
                        { "default:steel_ingot", "orienteering:altimeter", "default:steel_ingot" }
		}
	})
	minetest.register_craft({
		output = "orienteering:quadcorder",
		recipe = {
			{ "default:gold_ingot", "default:gold_ingot", "default:gold_ingot" },
			{ "orienteering:speedometer", "default:diamond", "orienteering:automapper", },
                        { "orienteering:sextant", "default:diamond", "orienteering:gps" }
		}
	})
	minetest.register_craft({
		output = "orienteering:watch",
		recipe = {
			{ "default:copper_ingot" },
			{ "default:glass" },
			{ "default:copper_ingot" }
		}
	})

end



function update_automapper(player)
	local inv = player:get_inventory()
	if inv:contains_item("main", "orienteering:automapper") or inv:contains_item("main", "orienteering:quadcorder") then
		player:hud_set_flags({minimap = true})
	else
		player:hud_set_flags({minimap = false})
	end
end



function init_hud(player)
	update_automapper(player)
	local name = player:get_player_name()
	orienteering.playerhuds[name] = {}
	for i=1, o_lines do
		orienteering.playerhuds[name]["o_line"..i] = player:hud_add({
			hud_elem_type = "text",
			text = "",
			position = orienteering.settings.hud_pos,
			offset = { x = orienteering.settings.hud_offset.x, y = orienteering.settings.hud_offset.y + 20*(i-1) },
			alignment = orienteering.settings.hud_alignment,
			number = 0xFFFFFF,
			scale= { x = 100, y = 20 },
		})
	end
	orienteering.playerhuds[name].twelve = false
end

function update_hud_displays(player)
	local name = player:get_player_name()
	local inv = player:get_inventory()
	local gps, altimeter, triangulator, compass, sextant, watch, speedometer, quadcorder

	if inv:contains_item("main", "orienteering:gps") then
		gps = true
	end
	if inv:contains_item("main", "orienteering:altimeter") then
		altimeter = true
	end
	if inv:contains_item("main", "orienteering:triangulator") then
		triangulator = true
	end
	if inv:contains_item("main", "orienteering:compass") then
		compass = true
	end
	if inv:contains_item("main", "orienteering:sextant") then
		sextant = true
	end
	if inv:contains_item("main", "orienteering:watch") then
		watch = true
	end
	if inv:contains_item("main", "orienteering:speedometer") then
		speedometer = true
	end
	if inv:contains_item("main", "orienteering:quadcorder") then
		quadcorder = true
	end

	local str_pos, str_angles, str_time, str_speed
	local pos = vector.apply(player:getpos(), math.floor)
	if (altimeter and triangulator) or gps or quadcorder then
		str_pos = string.format(S("Coordinates: X=%d, Y=%d, Z=%d"), pos.x, pos.y, pos.z)
	elseif altimeter then
		str_pos = string.format(S("Height: Y=%d"), pos.y)
	elseif triangulator then
		str_pos = string.format(S("Coordinates: X=%d, Z=%d"), pos.x, pos.z)
	else
		str_pos = ""
	end

	local yaw = (player:get_look_yaw()-math.pi*0.5)/(2*math.pi)*360
	local pitch = player:get_look_pitch()/math.pi*180
	if ((compass or gps) and sextant) or quadcorder then
		str_angles = string.format(S("Yaw: %.1f°, pitch: %.1f°"), yaw, pitch)
	elseif compass or gps then
		str_angles = string.format(S("Yaw: %.1f°"), yaw)
	elseif sextant then
		str_angles = string.format(S("Pitch: %.1f°"), pitch)
	else
		str_angles = ""
	end

	local time = minetest.get_timeofday()
	if watch or gps or quadcorder then
		local totalminutes = time * 1440
		local hours = math.floor(totalminutes / 60)
		local minutes = math.floor(math.fmod(totalminutes, 60))
		local twelve = orienteering.playerhuds[name].twelve
		if twelve then
			local ampm
			if hours == 12 and minutes == 0 then
				str_time = S("Time: noon")
			elseif hours == 0 and minutes == 0 then
				str_time = S("Time: midnight")
			else
				if hours >= 12 then ampm = S("p.m.") else ampm = S("a.m.") end
				hours = math.fmod(hours, 12)
				if hours == 0 then hours = 12 end
				str_time = string.format(S("Time: %i:%02i %s"), hours, minutes, ampm)
			end
		else
			str_time = string.format(S("Time: %02i:%02i"), hours, minutes)
		end
	else
		str_time = ""
	end

	local speed_hor, speed_ver
	local v
	local attach = player:get_attach()
	if attach == nil then
		v = player:get_player_velocity()
	else
		v = attach:getvelocity()
	end
	speed_ver = v.y
	v.y = 0
	speed_hor = vector.length(v)

	if speedometer or quadcorder then
		local u = orienteering.settings.speed_unit
		str_speed = string.format(S("Speed: hor.: %.1f %s, vert.: %.1f %s"), speed_hor, u, speed_ver, u)
	else
		str_speed = ""
	end

	local strs = { str_pos, str_angles, str_time, str_speed }
	local line = 1
	for i=1, o_lines do
		if strs[i] ~= "" then
			player:hud_change(orienteering.playerhuds[name]["o_line"..line], "text", strs[i])
			line = line + 1
		end
	end
	for l=line, o_lines do
		player:hud_change(orienteering.playerhuds[name]["o_line"..l], "text", "")
	end
end

minetest.register_on_newplayer(init_hud)
minetest.register_on_joinplayer(init_hud)

minetest.register_on_leaveplayer(function(player)
	orienteering.playerhuds[player:get_player_name()] = nil
end)

local updatetimer = 0
minetest.register_globalstep(function(dtime)
	updatetimer = updatetimer + dtime
	if updatetimer > 0.1 then
		local players = minetest.get_connected_players()
		for i=1, #players do
			update_automapper(players[i])
			update_hud_displays(players[i])
		end
		updatetimer = updatetimer - dtime
	end
end)

if minetest.get_modpath("awards") ~= nil and minetest.get_modpath("default") ~= nil then
	awards.register_achievement("orienteering_quadcorder", {
		title = S("Master of Orienteering"),
		description = S("Craft a quadcorder."),
		icon = "orienteering_quadcorder.png",
		trigger = {
			type = "craft",
			item = "orienteering:quadcorder",
			target = 1
		}
	})
end

if minetest.get_modpath("doc_items") ~= nil then
	doc.sub.items.set_items_longdesc({
		["orienteering:compass"] = S("It shows you your yaw (horizontal viewing angle) in degrees."),
		["orienteering:sextant"] = S("It shows you your pitch (vertical viewing angle) in degrees."),
		["orienteering:altimeter"] = S("It shows you your current elevation (Y)."),
		["orienteering:triangulator"] = S("It shows you the coordinates of your current position in the horizontal plane (X and Z)."),
		["orienteering:gps"] = S("The GPS device shows you your coordinates (X, Y and Z), your yaw (horizontal viewing angle) and the time."),
		["orienteering:speedometer"] = S("It shows you your current horizontal (“hor.”) and vertical (“ver.”) speed in meters per second, where one meter is the side length of a single cube."),
		["orienteering:watch"] = S("It shows you the current time."),
		["orienteering:quadcorder"] = S("This is the ultimate orientieering tool. It shows you your coordinates (X, Y and Z), shows your yaw and pitch (horizontal and vertical viewing angles), the current time, your current speed and it enables you to access the minimap."),
		["orienteering:automapper"] = S("The automapper automatically creates a map of the area around you and enables you to view a minimap of your surroundings. It also has a built-in radar."),
	})

	local use = S("Put this tool anywhere in your player inventory to see the data it provides.")
	local use_watch = S("Put the watch anywhere in your player inventory to see the time. Leftclick to toggle between the 24-hour and 12-hour display.")
	local use_time = S("Put this tool anywhere in your player inventory to make use of its functionality. Leftclick to toggle between 24-hour and 12-hour display for the time feature.")
	local use_automapper = S("If you put an automapper in your player inventory, you will be able to access the minimap. By default the minimap can be opened with [F7].")

	doc.sub.items.set_items_usagehelp({
		["orienteering:compass"] = use,
		["orienteering:sextant"] = use,
		["orienteering:altimeter"] = use,
		["orienteering:triangulator"] = use,
		["orienteering:gps"] = use_time,
		["orienteering:speedometer"] = use,
		["orienteering:watch"] = use_watch,
		["orienteering:quadcorder"] = use_time,
		["orienteering:automapper"] = use_automapper,
	})
end