Add maps catalog (#381)

This allows maps to have a description, a valid viewable license, screenshot, etc.

mods/ctf/ctf_map/init.lua

@@ -11,18 +11,19 @@ function ctf_map.can_cross(player)
 	return false
 end
 
-dofile(minetest.get_modpath("ctf_map") .. "/nodes.lua")
+local modpath = minetest.get_modpath("ctf_map")
-dofile(minetest.get_modpath("ctf_map") .. "/emerge.lua")
+dofile(modpath .. "/nodes.lua")
-dofile(minetest.get_modpath("ctf_map") .. "/barrier.lua")
+dofile(modpath .. "/emerge.lua")
-dofile(minetest.get_modpath("ctf_map") .. "/base.lua")
+dofile(modpath .. "/barrier.lua")
+dofile(modpath .. "/base.lua")
 
 if minetest.get_modpath("ctf") then
-	dofile(minetest.get_modpath("ctf_map") .. "/chest.lua")
+	dofile(modpath .. "/chest.lua")
-	dofile(minetest.get_modpath("ctf_map") .. "/schem_map.lua")
+	dofile(modpath .. "/give_initial_stuff.lua")
-	dofile(minetest.get_modpath("ctf_map") .. "/give_initial_stuff.lua")
+	dofile(modpath .. "/schem_map.lua")
+	dofile(modpath .. "/maps_catalog.lua")
 
-	assert(ctf_match)
 	ctf_match.register_on_build_time_end(ctf_map.remove_middle_barrier)
 else
-	dofile(minetest.get_modpath("ctf_map") .. "/map_maker.lua")
+	dofile(modpath .. "/map_maker.lua")
 end

mods/ctf/ctf_map/maps_catalog.lua

@@ -0,0 +1,113 @@
+-- Maps Catalog Formspec
+
+local indices = {}
+
+local function show_catalog(name, idx)
+	indices[name] = idx
+
+	-- Select map to be displayed
+	local map = ctf_map.available_maps[idx]
+
+	local fs = "size[10,8]"
+
+	fs = fs .. "container[0,0]"
+	fs = fs .. "box[0,0;9.8,1;#111]"
+	if idx > 1 then
+		fs = fs .. "button[0.5,0.1;1,1;btn_prev;<---]"
+	end
+	if idx < #ctf_map.available_maps then
+		fs = fs .. "button[8.5,0.1;1,1;btn_next;--->]"
+	end
+
+	-- Map name and author
+	fs = fs .. "label[3,0;" .. minetest.formspec_escape(map.name) .. "]"
+	fs = fs .. "label[5,0.5;" .. "(by " .. minetest.formspec_escape(map.author) .. ")]"
+	fs = fs .. "container_end[]"
+
+	-- List of maps
+	fs = fs .. "textlist[0,1.2;3.5,6.8;maps_list;"
+	for i, v in pairs(ctf_map.available_maps) do
+		local mname = v.name
+
+		-- If entry corresponds to selected map, highlight in yellow
+		if i == idx then
+			mname = "#FFFF00" .. mname
+		end
+
+		fs = fs .. mname
+		if i < #ctf_map.available_maps then
+			fs = fs .. ","
+		end
+	end
+	fs = fs .. ";" .. idx .. ";false]"
+
+	-- Display screenshot if present, and move other elements down
+	local y = 1
+	if map.screenshot then
+		fs = fs .. "image[4,1.5;6.5,3.5;" .. map.screenshot .. "]"
+		y = y + 4
+	end
+
+	-- Other fields
+	fs = fs .. "container[3.5," .. y + 0.5 .. "]"
+	fs = fs .. "label[0.5,0;HINT: " ..
+			minetest.formspec_escape(map.hint or "---") .. "]"
+	fs = fs .. "label[0.5,0.5;LICENSE: " ..
+			minetest.formspec_escape(map.license or "---") .. "]"
+	fs = fs .. "container_end[]"
+
+	minetest.show_formspec(name, "ctf_map:maps_catalog", fs)
+end
+
+minetest.register_on_player_receive_fields(function(player, formname, fields)
+	if not player or formname ~= "ctf_map:maps_catalog" then
+		return
+	end
+
+	local name = player:get_player_name()
+
+	if fields.btn_prev then
+		show_catalog(name, indices[name] - 1)
+	elseif fields.btn_next then
+		show_catalog(name, indices[name] + 1)
+	end
+
+	if fields.maps_list then
+		local evt = minetest.explode_textlist_event(fields.maps_list)
+		if evt.type ~= "INV" then
+			show_catalog(name, evt.index)
+		end
+	end
+end)
+
+minetest.register_chatcommand("maps", {
+	privs = {interact = true},
+	func = function(name, param)
+		if not minetest.get_player_by_name(name) then
+			return false, "You must be online to view the maps catalog!"
+		end
+
+		-- Set param to nil if it's empty
+		if param and param:trim() == "" then
+			param = nil
+		end
+
+		local idx
+
+		-- If arg. supplied, set idx to index of the matching map name
+		-- or path. Else, set to indices[name] or index of current map
+		if param then
+			for i, map in pairs(ctf_map.available_maps) do
+				if map.name:find(param) or map.path:find(param) then
+					idx = i
+					break
+				end
+			end
+		else
+			idx = indices[name] or ctf_map.map.idx
+		end
+
+		show_catalog(name, idx or 1)
+		return true
+	end
+})

mods/ctf/ctf_map/schem_map.lua

@@ -59,123 +59,38 @@ local next_idx
 minetest.register_chatcommand("set_next", {
 	privs = { ctf_admin = true },
 	func = function(name, param)
-		for i, mname in pairs(ctf_map.available_maps) do
+		for i, map in pairs(ctf_map.available_maps) do
-			if mname:lower():find(param, 1, true) then
+			if map.name:lower():find(param, 1, true) or
+					map.path:lower():find(param, 1, true) then
 				next_idx = i
-				return true, "Selected " .. mname
+				return true, "Selected " .. map.name
 			end
 		end
+
+		return false, "Couldn't find any matches"
 	end,
 })
 
-
+local function load_map_meta(idx, path)
-local function search_for_maps()
+	print("load_map_meta: Loading map meta from \"" .. path .. "\"")
-	local files_hash = {}
+	local conf_path = mapdir .. path .. ".conf"
-
-	local dirs = minetest.get_dir_list(mapdir, true)
-	table.insert(dirs, ".")
-	for _, dir in pairs(dirs) do
-		if dir ~= ".git" then
-			local files = minetest.get_dir_list(mapdir .. dir, false)
-			for i=1, #files do
-				local parts = files[i]:split(".")
-				local filename = parts[1]
-				local extension = parts[2]
-				if extension == "mts" then
-					files_hash[dir .. "/" .. filename] = true
-				else
-					if extension ~= "conf" and extension ~= "md"
-							and files[i] ~= ".git" then
-						error("Map extension is not '.mts': " .. files[i])
-					end
-				end
-			end
-		end
-	end
-
-	ctf_map.available_maps = {}
-	for key, _ in pairs(files_hash) do
-		local conf = Settings(mapdir .. "/" .. key .. ".conf")
-		minetest.log("error", "ctf.maps." .. key:gsub("%./", ""):gsub("/", "."))
-		local val = minetest.settings:get("ctf.maps." .. key:gsub("%./", ""):gsub("/", "."))
-		if not conf:get_bool("disabled", false) and val ~= "false" then
-			table.insert(ctf_map.available_maps, key)
-		end
-	end
-	if next(ctf_map.available_maps) == nil then
-		error("No maps found in directory " .. mapdir)
-	end
-	return ctf_map.available_maps
-end
-
-search_for_maps()
-
-minetest.register_chatcommand("maps_reload", {
-	privs = { ctf_admin = true },
-	func = function(name, param)
-		local maps = search_for_maps()
-		next_idx = nil
-		return true, #maps .. " maps found: " .. table.concat(maps, ", ")
-	end,
-})
-
-
-function ctf_map.place_map(map)
-	ctf_map.emerge_with_callbacks(nil, map.pos1, map.pos2, function()
-		local schempath = mapdir .. map.schematic
-		local res = minetest.place_schematic(map.pos1, schempath,
-				map.rotation == "z" and "0" or "90")
-
-		assert(res)
-
-		for _, value in pairs(ctf_map.map.teams) do
-			ctf_map.place_base(value.color, value.pos)
-		end
-
-		local seed = minetest.get_mapgen_setting("seed")
-		for _, chestzone in pairs(ctf_map.map.chests) do
-			minetest.log("warning", "Placing " .. chestzone.n .. " chests from " ..
-					minetest.pos_to_string(chestzone.from) .. " to "..
-					minetest.pos_to_string(chestzone.to))
-			place_chests(chestzone.from, chestzone.to, seed, chestzone.n)
-		end
-
-		minetest.after(2, function()
-			local msg = map_str
-			if map.hint then
-				msg = msg .. "\n" .. map.hint
-			end
-			minetest.chat_send_all(msg)
-			if minetest.global_exists("irc") and irc.connected then
-				irc:say("Map: " .. map.name)
-			end
-		end)
-
-		minetest.after(10, function()
-			minetest.fix_light(ctf_map.map.pos1, ctf_map.map.pos2)
-		end)
-	end, nil)
-end
-
-function ctf_match.load_map_meta(idx, name)
 	local offset    = vector.new(600 * idx, 0, 0)
-	local conf_path = mapdir .. name .. ".conf"
 	local meta      = Settings(conf_path)
 
-	if meta:get("r") == nil then
+	if not meta:get("r") then
-		error("Map was not properly configured: " .. conf_path)
+		error("Map was not properly configured " .. conf_path)
 	end
 
 	local initial_stuff = meta:get("initial_stuff")
 	local treasures = meta:get("treasures")
 	treasures = treasures and treasures:split(";")
 	local map = {
-		idx           = idx,
 		name          = meta:get("name"),
 		author        = meta:get("author"),
 		hint          = meta:get("hint"),
 		rotation      = meta:get("rotation"),
-		schematic     = name .. ".mts",
+		screenshot    = meta:get("screenshot"),
+		schematic     = path .. ".mts",
 		initial_stuff = initial_stuff and initial_stuff:split(","),
 		treasures     = treasures,
 		r             = tonumber(meta:get("r")),
@@ -190,8 +105,6 @@ function ctf_match.load_map_meta(idx, name)
 	map.pos1 = vector.add(offset, { x = -map.r, y = -map.h / 2, z = -map.r })
 	map.pos2 = vector.add(offset, { x =  map.r, y = map.h / 2,  z =  map.r })
 
-	map_str = "Map: " .. map.name .. " by " .. map.author
-
 	-- Read teams from config
 	local i = 1
 	while meta:get("team." .. i) do
@@ -305,6 +218,98 @@ function ctf_match.load_map_meta(idx, name)
 	return map
 end
 
+local function load_maps()
+	local files_hash = {}
+
+	local dirs = minetest.get_dir_list(mapdir, true)
+	table.insert(dirs, ".")
+	for _, dir in pairs(dirs) do
+		if dir ~= ".git" then
+			local files = minetest.get_dir_list(mapdir .. dir, false)
+			for i = 1, #files do
+				local parts = files[i]:split(".")
+				local filename = parts[1]
+				local extension = parts[2]
+				if extension == "mts" then
+					files_hash[dir .. "/" .. filename] = true
+				else
+					if extension ~= "conf" and extension ~= "md"
+							and files[i] ~= ".git" then
+						error("Map extension is not '.mts': " .. files[i])
+					end
+				end
+			end
+		end
+	end
+
+	local idx = 1
+	ctf_map.available_maps = {}
+	for key, _ in pairs(files_hash) do
+		local conf = Settings(mapdir .. "/" .. key .. ".conf")
+		local val = minetest.settings:get("ctf.maps." .. key:gsub("%./", ""):gsub("/", "."))
+		if not conf:get_bool("disabled", false) and val ~= "false" then
+			local map = load_map_meta(idx, key)
+			map.path = key
+			table.insert(ctf_map.available_maps, map)
+			minetest.log("action", "Found map '" .. map.name .. "'")
+			minetest.log("info", dump(map))
+			idx = idx + 1
+		end
+	end
+	if not next(ctf_map.available_maps) then
+		error("No maps found in directory " .. mapdir)
+	end
+	return ctf_map.available_maps
+end
+
+load_maps()
+
+minetest.register_chatcommand("maps_reload", {
+	privs = { ctf_admin = true },
+	func = function(name, param)
+		local maps = load_maps()
+		next_idx = nil
+		return true, #maps .. " maps found: " .. table.concat(maps, ", ")
+	end,
+})
+
+local function place_map(map)
+	ctf_map.emerge_with_callbacks(nil, map.pos1, map.pos2, function()
+		local schempath = mapdir .. map.schematic
+		local res = minetest.place_schematic(map.pos1, schempath,
+				map.rotation == "z" and "0" or "90")
+
+		assert(res)
+
+		for _, value in pairs(ctf_map.map.teams) do
+			ctf_map.place_base(value.color, value.pos)
+		end
+
+		local seed = minetest.get_mapgen_setting("seed")
+		for _, chestzone in pairs(ctf_map.map.chests) do
+			minetest.log("warning", "Placing " .. chestzone.n .. " chests from " ..
+					minetest.pos_to_string(chestzone.from) .. " to "..
+					minetest.pos_to_string(chestzone.to))
+			place_chests(chestzone.from, chestzone.to, seed, chestzone.n)
+		end
+
+		minetest.after(2, function()
+			local msg = "Map: " .. map.name .. " by " .. map.author
+			if map.hint then
+				msg = msg .. "\n" .. map.hint
+			end
+			minetest.chat_send_all(msg)
+			if minetest.global_exists("irc") and irc.connected then
+				irc:say("Map: " .. map.name)
+			end
+		end)
+
+		minetest.after(10, function()
+			minetest.fix_light(ctf_map.map.pos1, ctf_map.map.pos2)
+		end)
+	end, nil)
+end
+
 ctf_match.register_on_new_match(function()
 	minetest.clear_objects({ mode = "quick" })
 
@@ -323,11 +328,12 @@ ctf_match.register_on_new_match(function()
 	next_idx = (idx % #ctf_map.available_maps) + 1
 
 	-- Load meta data
-	local name = ctf_map.available_maps[idx]
+	ctf_map.map = ctf_map.available_maps[idx]
-	ctf_map.map = ctf_match.load_map_meta(idx, name)
+	ctf_map.map.idx = idx
 
+	map_str = "Map: " .. ctf_map.map.name .. " by " .. ctf_map.map.author
 	-- Place map
-	ctf_map.place_map(ctf_map.map)
+	place_map(ctf_map.map)
 end)
 
 function ctf_match.create_teams()