Minetest 5.2+ required to use craftguide

init.lua

@@ -12,6 +12,11 @@ local toolrepair
 
 local progressive_mode = core.settings:get_bool("craftguide_progressive_mode")
 local sfinv_only = core.settings:get_bool("craftguide_sfinv_only") and rawget(_G, "sfinv")
+local enable_cache_progress_bar = core.settings:get_bool("craftguide_enable_cache_progress_bar")
+
+if enable_cache_progress_bar == nil then
+	enable_cache_progress_bar = true
+end
 
 local http = core.request_http_api()
 
@@ -47,9 +52,9 @@ local ES = function(...)
 	return ESC(S(...))
 end
 
-local maxn, sort, concat, copy, insert, remove =
+local maxn, sort, concat, copy, insert, remove, unpack =
 	table.maxn, table.sort, table.concat, table.copy,
-	table.insert, table.remove
+	table.insert, table.remove, unpack
 
 local fmt, find, gmatch, match, sub, split, upper, lower =
 	string.format, string.find, string.gmatch, string.match,
@@ -59,6 +64,8 @@ local min, max, floor, ceil = math.min, math.max, math.floor, math.ceil
 local pairs, next, type, tostring, io = pairs, next, type, tostring, io
 local vec_add, vec_mul = vector.add, vector.multiply
 
+local FORMSPEC_MINIMAL_VERSION = 3
+
 local ROWS  = 9
 local LINES = sfinv_only and 5 or 9
 local IPP   = ROWS * LINES
@@ -68,17 +75,20 @@ local XOFFSET = sfinv_only and 3.83 or 11.2
 local YOFFSET = sfinv_only and 4.9 or 1
 
 local PNG = {
-	bg       = "craftguide_bg.png",
-	bg_full  = "craftguide_bg_full.png",
-	search   = "craftguide_search_icon.png",
-	clear    = "craftguide_clear_icon.png",
-	prev     = "craftguide_next_icon.png^\\[transformFX",
-	next     = "craftguide_next_icon.png",
-	arrow    = "craftguide_arrow.png",
-	fire     = "craftguide_fire.png",
-	book     = "craftguide_book.png",
-	sign     = "craftguide_sign.png",
-	selected = "craftguide_selected.png",
+	bg        = "craftguide_bg.png",
+	bg_full   = "craftguide_bg_full.png",
+	search    = "craftguide_search_icon.png",
+	clear     = "craftguide_clear_icon.png",
+	prev      = "craftguide_next_icon.png^\\[transformFX",
+	next      = "craftguide_next_icon.png",
+	arrow     = "craftguide_arrow.png",
+	fire      = "craftguide_fire.png",
+	fire_anim = "craftguide_fire_anim.png",
+	book      = "craftguide_book.png",
+	sign      = "craftguide_sign.png",
+	nothing   = "craftguide_no.png",
+	selected  = "craftguide_selected.png",
+	furnace_anim = "craftguide_furnace_anim.png",
 
 	search_hover = "craftguide_search_icon_hover.png",
 	clear_hover  = "craftguide_clear_icon_hover.png",
@@ -94,10 +104,16 @@ local FMT = {
 	tooltip = "tooltip[%f,%f;%f,%f;%s]",
 	item_image = "item_image[%f,%f;%f,%f;%s]",
 	image_button = "image_button[%f,%f;%f,%f;%s;%s;%s]",
+	animated_image = "animated_image[%f,%f;%f,%f;;%s;%u;%u]",
 	item_image_button = "item_image_button[%f,%f;%f,%f;%s;%s;%s]",
 	arrow = "image_button[%f,%f;0.8,0.8;%s;%s;;;false;%s]",
 }
 
+local function get_fs_version(name)
+	local info = get_player_info(name)
+	return info and info.formspec_version or 1
+end
+
 local function mul_elem(elem, n)
 	local fstr, elems = "", {}
 
@@ -722,7 +738,10 @@ local function get_output_fs(data, fs, L)
 		local pos_x = L.rightest + L.btn_size + 0.1
 		local pos_y = YOFFSET + (sfinv_only and 0.25 or -0.45)
 
-		fs[#fs + 1] = fmt(FMT.image, pos_x, pos_y + L.spacing, 0.5, 0.5, icon)
+		if sub(icon, 1, 18) == "craftguide_furnace" then
+			fs[#fs + 1] = fmt(FMT.animated_image,
+				pos_x, pos_y + L.spacing, 0.5, 0.5, PNG.furnace_anim, 8, 180)
+		end
 
 		local tooltip = custom_recipe and custom_recipe.description or
 				L.shapeless and S"Shapeless" or S"Cooking"
@@ -738,19 +757,17 @@ local function get_output_fs(data, fs, L)
 		0.9, 0.7, PNG.arrow)
 
 	if L.recipe.type == "fuel" then
-		fs[#fs + 1] = fmt(FMT.image,
+		fs[#fs + 1] = fmt(FMT.animated_image,
 			output_X, YOFFSET + (sfinv_only and 0.7 or 0) + L.spacing,
-			1.1, 1.1, PNG.fire)
+			1.1, 1.1, PNG.fire_anim, 8, 180)
 	else
 		local item = L.recipe.output
 		item = clean_name(item)
 		local name = match(item, "%S*")
 
-		if data.fs_version >= 3 then
-			fs[#fs + 1] = fmt(FMT.image,
-				output_X, YOFFSET + (sfinv_only and 0.7 or 0) + L.spacing,
-				1.1, 1.1, PNG.selected)
-		end
+		fs[#fs + 1] = fmt(FMT.image,
+			output_X, YOFFSET + (sfinv_only and 0.7 or 0) + L.spacing,
+			1.1, 1.1, PNG.selected)
 
 		local _name = sfinv_only and name or fmt("_%s", name)
 
@@ -774,9 +791,9 @@ local function get_output_fs(data, fs, L)
 				output_X + 1, YOFFSET + (sfinv_only and 0.7 or 0.1) + L.spacing,
 				0.6, 0.4, PNG.arrow)
 
-			fs[#fs + 1] = fmt(FMT.image,
+			fs[#fs + 1] = fmt(FMT.animated_image,
 				output_X + 1.6, YOFFSET + (sfinv_only and 0.55 or 0) + L.spacing,
-				0.6, 0.6, PNG.fire)
+				0.6, 0.6, PNG.fire_anim, 8, 180)
 		end
 	end
 end
@@ -860,7 +877,7 @@ local function get_grid_fs(data, fs, rcp, spacing)
 			end
 		end
 
-		if data.fs_version >= 3 and not large_recipe then
+		if not large_recipe then
 			fs[#fs + 1] = fmt(FMT.image,
 				X, Y + (sfinv_only and 0.7 or 0), btn_size, btn_size, PNG.selected)
 		end
@@ -898,17 +915,16 @@ local function get_grid_fs(data, fs, rcp, spacing)
 end
 
 local function get_panels(data, fs)
-	local start_y = data.fs_version >= 3 and (sfinv_only and 0.33 or 0) or 0.33
+	local start_y = sfinv_only and 0.33 or 0
 
 	local panels = {
 		{dat = data.usages or {}, height = 3.5},
 		{dat = data.recipes or {}, height = 3.5},
 	}
 
-	if data.fs_version >= 3 and not sfinv_only then
-		panels.favs = {dat = {}, height = 2.19}
-
-	elseif sfinv_only then
+	if not sfinv_only then
+		panels.favs = {height = 2.19}
+	else
 		panels = data.show_usages and
 			{{dat = data.usages}} or {{dat = data.recipes}}
 	end
@@ -921,7 +937,7 @@ local function get_panels(data, fs)
 			fs[#fs + 1] = fmt("background9[8.1,%f;6.6,%f;%s;false;%d]",
 				-0.2 + spacing, v.height, PNG.bg_full, 10)
 
-			if data.fs_version >= 3 and k == 2 then
+			if k == 2 then
 				local fav = is_fav(data)
 				local nfavs = #data.favs
 
@@ -941,7 +957,7 @@ local function get_panels(data, fs)
 			end
 		end
 
-		local rn = #v.dat
+		local rn = v.dat and #v.dat or -1
 		local _rn = tostring(rn)
 		local xu = tostring(data.unum) .. _rn
 		local xr = tostring(data.rnum) .. _rn
@@ -949,10 +965,15 @@ local function get_panels(data, fs)
 		xr = max(-0.3, -((#xr - 3) * 0.05))
 
 		local is_recipe = sfinv_only and not data.show_usages or k == 2
-		local lbl
+		local lbl = ""
 
 		if not sfinv_only and rn == 0 then
-			lbl = clr("#f00", is_recipe and ES"No recipes" or ES"No usages")
+			fs[#fs + 1] = fmt(FMT.image,
+				XOFFSET - 0.7, YOFFSET - 0.4 + spacing, 2, 2, PNG.nothing)
+
+			fs[#fs + 1] = fmt(FMT.tooltip,
+				XOFFSET - 0.7, YOFFSET - 0.4 + spacing, 2, 2,
+				is_recipe and ES"No recipes" or ES"No usages")
 
 		elseif (not sfinv_only and is_recipe) or
 				(sfinv_only and not data.show_usages) then
@@ -978,25 +999,18 @@ local function get_panels(data, fs)
 			local x_arrow = XOFFSET + (sfinv_only and 1.7 or 1)
 			local y_arrow = YOFFSET + (sfinv_only and 3.3 or 1.4 + spacing)
 
-			if data.fs_version >= 3 then
-				fs[#fs + 1] = fmt(mul_elem(FMT.arrow, 2),
-					x_arrow + (is_recipe and xr or xu), y_arrow,
-						PNG.prev, prev_name, "",
-					x_arrow + 1.8, y_arrow, PNG.next, next_name, "")
-			else
-				fs[#fs + 1] = fmt(mul_elem(FMT.arrow, 2),
-					x_arrow + (is_recipe and xr or xu),
-						y_arrow, PNG.prev, prev_name, PNG.prev_hover,
-					x_arrow + 1.8, y_arrow, PNG.next, next_name, PNG.next_hover)
-			end
+			fs[#fs + 1] = fmt(mul_elem(FMT.arrow, 2),
+				x_arrow + (is_recipe and xr or xu), y_arrow,
+					PNG.prev, prev_name, "",
+				x_arrow + 1.8, y_arrow, PNG.next, next_name, "")
 		end
 
-		local rcp = is_recipe and v.dat[data.rnum] or v.dat[data.unum]
+		local rcp = v.dat and (is_recipe and v.dat[data.rnum] or v.dat[data.unum])
 		if rcp then
 			get_grid_fs(data, fs, rcp, spacing)
 		end
 
-		if k == "favs" and data.fs_version >= 3 and not sfinv_only then
+		if k == "favs" and not sfinv_only then
 			fs[#fs + 1] = fmt(FMT.label, 8.3, spacing - 0.1, ES"Bookmarks")
 
 			for i = 1, #data.favs do
@@ -1032,45 +1046,32 @@ local function make_fs(data)
 	end
 
 	fs[#fs + 1] = fmt([[
-		field[0.25,0.2;%f,1;filter;;%s]
+		style[filter;border=false]
+		field[0.4,0.2;2.5,1;filter;;%s]
 		field_close_on_enter[filter;false]
+		box[0,0;2.4,0.6;#ffffff25]
 	]],
-	sfinv_only and 2.76 or 2.72, ESC(data.filter))
+	ESC(data.filter))
 
-	if data.fs_version >= 3 then
-		fs[#fs + 1] = fmt([[
-			style_type[image_button;border=false]
-			style_type[item_image_button;border=false;bgimg_hovered=%s;bgimg_pressed=%s]
-			style[search;fgimg=%s;fgimg_hovered=%s]
-			style[clear;fgimg=%s;fgimg_hovered=%s]
-			style[prev_page;fgimg=%s;fgimg_hovered=%s;fgimg_pressed=%s]
-			style[next_page;fgimg=%s;fgimg_hovered=%s;fgimg_pressed=%s]
-		]],
-		PNG.selected, PNG.selected,
-		PNG.search, PNG.search_hover,
-		PNG.clear, PNG.clear_hover,
-		PNG.prev, PNG.prev_hover, PNG.prev_hover,
-		PNG.next, PNG.next_hover, PNG.next_hover)
+	fs[#fs + 1] = fmt([[
+		style_type[image_button;border=false]
+		style_type[item_image_button;border=false;bgimg_hovered=%s;bgimg_pressed=%s]
+		style[search;fgimg=%s;fgimg_hovered=%s]
+		style[clear;fgimg=%s;fgimg_hovered=%s]
+		style[prev_page;fgimg=%s;fgimg_hovered=%s;fgimg_pressed=%s]
+		style[next_page;fgimg=%s;fgimg_hovered=%s;fgimg_pressed=%s]
+	]],
+	PNG.selected, PNG.selected,
+	PNG.search, PNG.search_hover,
+	PNG.clear, PNG.clear_hover,
+	PNG.prev, PNG.prev_hover, PNG.prev_hover,
+	PNG.next, PNG.next_hover, PNG.next_hover)
 
-		fs[#fs + 1] = fmt(mul_elem(FMT.image_button, 4),
-			sfinv_only and 2.6 or 2.54, -0.06, 0.85, 0.85, "", "search", "",
-			sfinv_only and 3.3 or 3.25, -0.06, 0.85, 0.85, "", "clear", "",
-			sfinv_only and 5.45 or (ROWS * 6.83) / 11, -0.06, 0.85, 0.85, "", "prev_page", "",
-			sfinv_only and 7.2  or (ROWS * 8.75) / 11, -0.06, 0.85, 0.85, "", "next_page", "")
-	else
-		fs[#fs + 1] = fmt([[
-			image_button[%f,-0.06;0.85,0.85;%s;search;;;false;%s]
-			image_button[%f,-0.06;0.85,0.85;%s;clear;;;false;%s]
-			]],
-			sfinv_only and 2.6 or 2.54, PNG.search, PNG.search_hover,
-			sfinv_only and 3.3 or 3.25, PNG.clear, PNG.clear_hover)
-
-		fs[#fs + 1] = fmt(mul_elem(FMT.arrow, 2),
-			sfinv_only and 5.45 or (ROWS * 6.83) / 11, -0.05,
-				PNG.prev, "prev_page", PNG.prev_hover,
-			sfinv_only and 7.2 or (ROWS * 8.75) / 11, -0.05,
-				PNG.next, "next_page", PNG.next_hover)
-	end
+	fs[#fs + 1] = fmt(mul_elem(FMT.image_button, 4),
+		sfinv_only and 2.6 or 2.54, -0.06, 0.85, 0.85, "", "search", "",
+		sfinv_only and 3.3 or 3.25, -0.06, 0.85, 0.85, "", "clear", "",
+		sfinv_only and 5.45 or (ROWS * 6.83) / 11, -0.06, 0.85, 0.85, "", "prev_page", "",
+		sfinv_only and 7.2  or (ROWS * 8.75) / 11, -0.06, 0.85, 0.85, "", "next_page", "")
 
 	data.pagemax = max(1, ceil(#data.items / IPP))
 
@@ -1099,7 +1100,7 @@ local function make_fs(data)
 		local X = i % ROWS
 		local Y = (i % IPP - X) / ROWS + 1
 
-		if data.fs_version >= 3 and data.query_item == item then
+		if data.query_item == item then
 			fs[#fs + 1] = fmt(FMT.image,
 				X - (X * (sfinv_only and 0.12 or 0.14)) - 0.05,
 				Y - (Y * 0.1) - 0.1,
@@ -1138,16 +1139,6 @@ craftguide.register_craft_type("digging_chance", {
 	icon = "default_tool_mesepick.png",
 })
 
-local function sfind(str, filter)
-	if filter == "" then
-		return 0
-	end
-
-	if find(str, filter, 1, true) then
-		return #str - #filter
-	end
-end
-
 local function search(data)
 	local filter = data.filter
 
@@ -1169,28 +1160,30 @@ local function search(data)
 		end
 	end
 
-	local filtered_list, order, c = {}, {}, 0
+	local filtered_list, c = {}, 0
 
 	for i = 1, #data.items_raw do
 		local item = data.items_raw[i]
 		local def  = reg_items[item]
 		local desc = (def and def.description) and lower(def.description) or ""
+		local search_in = fmt("%s %s", item, desc)
 		local to_add
 
 		if search_filter then
 			for filter_name, values in pairs(filters) do
-				local func = search_filters[filter_name]
-				to_add = func(item, values) and (search_filter == "" or
-					(sfind(item, search_filter) or sfind(desc, search_filter)))
+				if values then
+					local func = search_filters[filter_name]
+					to_add = func(item, values) and (search_filter == "" or
+						find(search_in, search_filter, 1, true))
+				end
 			end
 		else
-			to_add = sfind(item, filter) or sfind(desc, filter)
+			to_add = find(search_in, filter, 1, true)
 		end
 
 		if to_add then
 			c = c + 1
 			filtered_list[c] = item
-			order[item] = to_add
 		end
 	end
 
@@ -1203,10 +1196,6 @@ local function search(data)
 		end
 	end
 
-	sort(filtered_list, function(a, b)
-		return order[a] < order[b]
-	end)
-
 	data.items = filtered_list
 end
 
@@ -1463,17 +1452,19 @@ local function get_init_items()
 		last_str = str
 	end
 
-	local full_char, empty_char = "▰", "▱"
+	local full_char, empty_char = "#", " "
 
 	for name, def in pairs(reg_items) do
 		ic = ic + 1
-		local percent, bar, len = (ic * 100) / it, "", 20
+		local percent, bar, len = (ic * 100) / it, "[", 20
 
 		for i = 1, len do
 			bar = bar .. (i <= percent / (100 / len) and full_char or empty_char)
 		end
 
-		iop(fmt("[craftguide] Caching data  %s  %u%%\r", bar, percent))
+		if enable_cache_progress_bar then
+			iop(fmt("[craftguide] Caching data  %s  %u%%\r", bar .. "]", percent))
+		end
 
 		if show_item(def) then
 			if not fuel_cache[name] then
@@ -1520,7 +1511,7 @@ local function init_data(name)
 		items      = init_items,
 		items_raw  = init_items,
 		favs       = {},
-		fs_version = get_player_info(name).formspec_version,
+		fs_version = get_fs_version(name),
 	}
 end
 
@@ -1640,7 +1631,7 @@ if sfinv_only then
 
 		is_in_nav = function(self, player, context)
 			local name = player:get_player_name()
-			return get_player_info(name).formspec_version >= 2
+			return get_fs_version(name) >= FORMSPEC_MINIMAL_VERSION
 		end,
 
 		get = function(self, player, context)
@@ -1676,9 +1667,18 @@ else
 		local name = user:get_player_name()
 		local data = pdata[name]
 
-		if data.fs_version == 1 then
-			return msg(name, "Your Minetest client is outdated. " ..
-				"Get the latest version on minetest.net to use the Crafting Guide.")
+		if data.fs_version < FORMSPEC_MINIMAL_VERSION then
+			local fs = fmt([[
+				size[6.6,1.3]
+				image[0,0;1,1;%s]
+				label[1,0;%s]
+				button_exit[2.8,0.8;1,1;;OK]
+			]],
+			PNG.nothing,
+			"Your Minetest client is outdated.\n" ..
+			"Get the latest version on minetest.net to use the Crafting Guide.")
+
+			return show_formspec(name, "craftguide", fs)
 		end
 
 		if next(recipe_filters) then
@@ -1709,7 +1709,7 @@ else
 		paramtype = "light",
 		paramtype2 = "wallmounted",
 		sunlight_propagates = true,
-		groups = {oddly_breakable_by_hand = 1, flammable = 3},
+		groups = {choppy = 1, attached_node = 1, oddly_breakable_by_hand = 1, flammable = 3},
 		node_box = {
 			type = "wallmounted",
 			wall_top    = {-0.5, 0.4375, -0.5, 0.5, 0.5, 0.5},
@@ -1986,10 +1986,7 @@ if progressive_mode then
 		}
 	end)
 
-	local to_save = {
-		"inv_items",
-		"known_recipes",
-	}
+	local to_save = {"inv_items", "known_recipes"}
 
 	local function save_meta(player)
 		local meta = player:get_meta()

settingtypes.txt

@@ -2,4 +2,7 @@
 craftguide_progressive_mode	(Progressive Mode)	bool false
 
 # Integration in the default Minetest Game inventory.
-craftguide_sfinv_only		(Sfinv only)		bool false
+craftguide_sfinv_only		(Sfinv only)		bool false
+
+# Display the cache-building progress bar in the server console.
+craftguide_enable_cache_progress_bar	(Enable console cache progress bar)	bool true