Minimap: Add 'map' mod with mapping kit item to enable minimap

In survival mode, use of the minimap requires the mapping kit item.
Minimap radar mode is always disabled in survival mode.

Minimap and minimap radar mode will be automatically enabled in creative mode
and for any player with the 'creative' privilege.

The 'map.update_hud_flags()' function is global so can be redefined by a mod for
alternative behaviour.

Author: paramat

mods/map/README.txt

@@ -0,0 +1,44 @@
+Minetest Game mod: map
+======================
+See license.txt for license information.
+
+Authors of source code
+----------------------
+paramat (MIT)
+
+Authors of media (textures)
+---------------------------
+TumeniNodes (CC BY-SA 3.0):
+  map_mapping_kit.png (map)
+
+paramat (CC BY-SA 3.0):
+  map_mapping_kit.png (compass and pen)
+
+Crafting
+--------
+map:mapping_kit
+
+default:glass G
+default:paper P
+default:stick S
+default:steel_ingot I
+default:wood W
+dye:black D
+
+GPS
+IPI
+WPD
+
+Usage
+-----
+In survival mode, use of the minimap requires the mapping kit item in your
+inventory.
+Once crafted, to instantly enable, 'use' (left click) the item, otherwise the
+minimap will be automatically enabled a few seconds later.
+Minimap radar mode is always disabled in survival mode.
+
+Minimap and minimap radar mode will be automatically enabled in creative mode
+and for any player with the 'creative' privilege.
+
+The 'map.update_hud_flags()' function is global so can be redefined by a mod for
+alternative behaviour.

mods/map/depends.txt

@@ -0,0 +1,3 @@
+default
+dye
+creative?

mods/map/init.lua

@@ -0,0 +1,81 @@
+-- Mod global namespace
+
+map = {}
+
+
+-- Cache creative mode setting
+
+local creative_mode_cache = minetest.settings:get_bool("creative_mode")
+
+
+-- Update HUD flags
+-- Global to allow overriding
+
+function map.update_hud_flags(player)
+	local creative_enabled =
+		(creative and creative.is_enabled_for(player:get_player_name())) or
+		creative_mode_cache
+
+	local minimap_enabled = creative_enabled or
+		player:get_inventory():contains_item("main", "map:mapping_kit")
+	local radar_enabled = creative_enabled
+
+	player:hud_set_flags({
+		minimap = minimap_enabled,
+		minimap_radar = radar_enabled
+	})
+end
+
+
+-- Set HUD flags 'on joinplayer'
+
+minetest.register_on_joinplayer(function(player)
+	map.update_hud_flags(player)
+end)
+
+
+-- Cyclic update of HUD flags
+
+local function cyclic_update()
+	for _, player in ipairs(minetest.get_connected_players()) do
+		map.update_hud_flags(player)
+	end
+	minetest.after(7, cyclic_update)
+end
+
+minetest.after(7, cyclic_update)
+
+
+-- Mapping kit item
+
+minetest.register_craftitem("map:mapping_kit", {
+	description = "Mapping Kit",
+	inventory_image = "map_mapping_kit.png",
+	stack_max = 1,
+	groups = {flammable = 3},
+	-- For instant update of HUD flags
+	on_use = function(itemstack, user, pointed_thing)
+		map.update_hud_flags(user)
+	end,
+})
+
+
+-- Crafting
+
+minetest.register_craft({
+	output = "map:mapping_kit",
+	recipe = {
+		{"default:glass", "default:paper", "default:stick"},
+		{"default:steel_ingot", "default:paper", "default:steel_ingot"},
+		{"default:wood", "default:paper", "dye:black"},
+	}
+})
+
+
+-- Fuel
+
+minetest.register_craft({
+	type = "fuel",
+	recipe = "map:mapping_kit",
+	burntime = 5,
+})

mods/map/license.txt

@@ -0,0 +1,60 @@
+License of source code
+----------------------
+
+The MIT License (MIT)
+Copyright (C) 2017 paramat
+
+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.
+
+For more details:
+https://opensource.org/licenses/MIT
+
+
+Licenses of media (textures)
+----------------------------
+
+Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
+Copyright (C) 2017 TumeniNodes
+Copyright (C) 2017 paramat
+
+You are free to:
+Share — copy and redistribute the material in any medium or format.
+Adapt — remix, transform, and build upon the material for any purpose, even commercially.
+The licensor cannot revoke these freedoms as long as you follow the license terms.
+
+Under the following terms:
+
+Attribution — You must give appropriate credit, provide a link to the license, and
+indicate if changes were made. You may do so in any reasonable manner, but not in any way
+that suggests the licensor endorses you or your use.
+
+ShareAlike — If you remix, transform, or build upon the material, you must distribute
+your contributions under the same license as the original.
+
+No additional restrictions — You may not apply legal terms or technological measures that
+legally restrict others from doing anything the license permits.
+
+Notices:
+
+You do not have to comply with the license for elements of the material in the public
+domain or where your use is permitted by an applicable exception or limitation.
+No warranties are given. The license may not give you all of the permissions necessary
+for your intended use. For example, other rights such as publicity, privacy, or moral
+rights may limit how you use the material.
+
+For more details:
+http://creativecommons.org/licenses/by-sa/3.0/