Formspec improvements (fixes #39)

LICENSE

@@ -1,4 +1,4 @@
-« Copyright © 2015-2017, Jean-Patrick Guerrero <jeanpatrick.guerrero@gmail.com>
+« Copyright © 2015-2018, Jean-Patrick Guerrero <jeanpatrick.guerrero@gmail.com>
 
 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:
 

init.lua

@@ -17,13 +17,13 @@ craftguide.intllib = S
 -- https://github.com/kilbith/xdecor/blob/master/handlers/helpers.lua#L1
 local remove, maxn, sort = table.remove, table.maxn, table.sort
 local min, max, floor, ceil = math.min, math.max, math.floor, math.ceil
-local unpack = unpack
 
 local DEFAULT_SIZE = 10
 local MIN_LIMIT, MAX_LIMIT = 9, 12
 DEFAULT_SIZE = min(MAX_LIMIT, max(MIN_LIMIT, DEFAULT_SIZE))
 
 local GRID_LIMIT = 5
+local BUTTON_SIZE = 1.1
 
 local group_stereotypes = {
 	wool	     = "wool:white",
@@ -60,8 +60,7 @@ local function extract_groups(str)
 end
 
 local function colorize(str)
-	-- If client <= 0.4.14, don't colorize for compatibility.
-	return mt.colorize and mt.colorize("#FFFF00", str) or str
+	return mt.colorize("#FFFF00", str)
 end
 
 local function get_fueltime(item)
@@ -105,13 +104,16 @@ function craftguide:get_tooltip(item, recipe_type, cooktime, groups)
 	return has_extras and tooltip .. "]" or ""
 end
 
-function craftguide:get_recipe(iY, xoffset, recipe_num, recipes, show_usage)
+function craftguide:get_recipe(iX, iY, xoffset, recipe_num, recipes, show_usage)
 	local formspec, recipes_total = "", #recipes
 	if recipes_total > 1 then
 		formspec = formspec ..
-			"button[0," .. (iY + (sfinv_only and 3.8 or 3.3)) ..
+			"button[" .. (iX - (sfinv_only and 2 or 2.4)) .. "," ..
+				(iY + (sfinv_only and 3.9 or 3.3)) ..
 				";2,1;alternate;" .. S("Alternate") .. "]" ..
-			"label[0," .. (iY + (sfinv_only and 3.3 or 2.8)) .. ";" ..
+
+			"label[" .. (iX - (sfinv_only and 2 or 2.4)) .. "," ..
+				(iY + (sfinv_only and 3.5 or 2.9)) .. ";" ..
 				(show_usage and S("Usage") or S("Recipe")) .. " " ..
 				S("@1 of @2", recipe_num, recipes_total) .. "]"
 	end
@@ -123,11 +125,14 @@ function craftguide:get_recipe(iY, xoffset, recipe_num, recipes, show_usage)
 	if recipe_type == "cooking" or (recipe_type == "normal" and width == 0) then
 		local icon = recipe_type == "cooking" and "furnace" or "shapeless"
 		formspec = formspec ..
-			"image[" .. (xoffset - 0.8) .. "," .. (iY + (sfinv_only and 2.2 or 1.7)) ..
-				";0.5,0.5;craftguide_" .. icon .. ".png]"
+			"image[" .. (xoffset + 0.2) .. "," .. (iY + (sfinv_only and 2.2 or 1.7)) ..
+				";0.5,0.5;craftguide_" .. icon .. ".png" ..
+				(icon == "shapeless" and "^[transformFX" or "") .. "]"
 	end
 
-	if width == 0 then
+	if recipe_type == "cooking" then
+		width = 1
+	elseif width == 0 then
 		width = min(3, #items)
 	end
 
@@ -135,18 +140,17 @@ function craftguide:get_recipe(iY, xoffset, recipe_num, recipes, show_usage)
 
 	if recipe_type == "normal" and (width > GRID_LIMIT or rows > GRID_LIMIT) then
 		formspec = formspec ..
-			"label[" .. xoffset .. "," .. (iY + 2) .. ";" ..
+			"label[" .. xoffset .. "," .. (iY + 2.2) .. ";" ..
 				S("Recipe is too big to\nbe displayed (@1x@2)", width, rows) .. "]"
 	else
-		local btn_size = 1
 		for i, v in pairs(items) do
-			local X = (i - 1) % width + xoffset
+			local X = (i - 1) % width + xoffset - width
 			local Y = ceil(i / width + (iY + 2) - min(2, rows))
 
 			if recipe_type == "normal" and (width > 3 or rows > 3) then
-				btn_size = width > 3 and 3 / width or 3 / rows
-				X = btn_size * (i % width) + xoffset
-				Y = btn_size * floor((i - 1) / width) + (iY + 3) - min(2, rows)
+				BUTTON_SIZE = width > 3 and 3 / width or 3 / rows
+				X = BUTTON_SIZE * (i % width) + 0
+				Y = BUTTON_SIZE * floor((i - 1) / width) + (iY + 3) - min(2, rows)
 			end
 
 			local groups = extract_groups(v)
@@ -157,19 +161,33 @@ function craftguide:get_recipe(iY, xoffset, recipe_num, recipes, show_usage)
 			formspec = formspec ..
 				"item_image_button[" .. X .. "," ..
 					(Y + (sfinv_only and 0.7 or 0.2)) .. ";" ..
-					btn_size .. "," .. btn_size .. ";" .. item_r ..
+					BUTTON_SIZE .. "," .. BUTTON_SIZE .. ";" .. item_r ..
 					";" .. item_r .. ";" .. label .. "]" .. tltip
 		end
+
+		BUTTON_SIZE = 1.1
 	end
 
-	local output = recipes[recipe_num].output
-	return formspec ..
-		"image[" .. (xoffset - 1) .. "," .. (iY + (sfinv_only and 2.85 or 2.35)) ..
-			";0.9,0.7;craftguide_arrow.png]" ..
-		"item_image_button[" .. (xoffset - 2) .. "," ..
-				(iY + (sfinv_only and 2.7 or 2.2)) .. ";1,1;" ..
-			output .. ";" .. output .. ";]" ..
-			self:get_tooltip(output:match("%S+"))
+	local output = recipes[recipe_num].output:match("%S+")
+	formspec = formspec ..
+		"image[" .. (xoffset + 0.08) .. "," .. (iY + (sfinv_only and 2.85 or 2.35)) ..
+			";0.9,0.7;craftguide_arrow.png^[transformFX]" ..
+		"item_image_button[" .. (xoffset + 1) .. "," ..
+				(iY + (sfinv_only and 2.7 or 2.2)) .. ";" ..
+				BUTTON_SIZE .. "," .. BUTTON_SIZE .. ";" ..
+			output .. ";" .. output .. ";]" .. self:get_tooltip(output)
+
+	local output_is_fuel = get_fueltime(output) > 0
+	if output_is_fuel then
+		formspec = formspec ..
+			"image[" .. (xoffset + 2) .. "," ..
+				(iY + (sfinv_only and 2.85 or 2.35)) ..
+				";0.6,0.4;craftguide_arrow.png^[transformFX]" ..
+			"image[" .. (xoffset + 2.6) .. "," .. (iY + (sfinv_only and 2.68 or 2.18)) ..
+				";0.6,0.6;craftguide_fire.png]"
+	end
+
+	return formspec
 end
 
 function craftguide:get_formspec(player_name, is_fuel)
@@ -203,19 +221,20 @@ function craftguide:get_formspec(player_name, is_fuel)
 			"tooltip[clear;" .. S("Reset") .. "]" ..
 			"tooltip[prev;" .. S("Previous page") .. "]" ..
 			"tooltip[next;" .. S("Next page") .. "]" ..
-			"button[" .. (data.iX - 3.1) .. ",0;0.8,0.95;prev;<]" ..
-			"label[" .. (data.iX - 2.2) .. ",0.18;" ..
+			"button[" .. (data.iX - (sfinv_only and 2.6 or 3.1)) ..
+				"," .. (sfinv_only and 0.03 or 0) .. ";0.8,0.95;prev;<]" ..
+			"label[" .. (data.iX - (sfinv_only and 1.7 or 2.2)) .. "," ..
+				(sfinv_only and 0.21 or 0.18) .. ";" ..
 				colorize(data.pagenum) .. " / " .. data.pagemax .. "]" ..
-			"button[" .. (data.iX - 1.2) .. ",0;0.8,0.95;next;>]" ..
+			"button[" .. (data.iX - (sfinv_only and 0.7 or 1.2)) ..
+				"," .. (sfinv_only and 0.03 or 0) .. ";0.8,0.95;next;>]" ..
 			"field[0.3,0.32;2.5,1;filter;;" .. mt.formspec_escape(data.filter) .. "]"
 
-	local even_num = data.iX % 2 == 0
-	local xoffset = data.iX / 2 + (even_num and 0.5 or 0)
+	local xoffset = data.iX / 2.15
 
 	if not next(data.items) then
 		formspec = formspec ..
-			"label[" .. (xoffset - (even_num and 1.5 or 1)) .. ",2;" ..
-				S("No item to show") .. "]"
+			"label[" .. ((data.iX / 2) - 1) .. ",2;" .. S("No item to show") .. "]"
 	end
 
 	local first_item = (data.pagenum - 1) * ipp
@@ -226,24 +245,31 @@ function craftguide:get_formspec(player_name, is_fuel)
 		local Y = (i % ipp - X) / data.iX + 1
 
 		formspec = formspec ..
-			"item_image_button[" .. (X - (X * 0.05)) .. "," .. Y .. ";1.1,1.1;" ..
+			"item_image_button[" .. (X - (sfinv_only and 0 or (X * 0.05))) .. "," ..
+				Y .. ";" .. BUTTON_SIZE .. "," .. BUTTON_SIZE .. ";" ..
 				name .. ";" .. name .. "_inv;]"
 	end
 
 	if data.item and reg_items[data.item] then
 		if not data.recipes_item or (is_fuel and not get_recipe(data.item).items) then
 			formspec = formspec ..
-				"image[" .. (xoffset - 1) .. "," .. (iY + 2.35) ..
-					";0.9,0.7;craftguide_arrow.png]" ..
-				"item_image_button[" .. xoffset .. "," .. (iY + 2.2) ..
-					";1,1;" .. data.item .. ";" .. data.item .. ";]" ..
+				"image[" .. (xoffset + 0.08) .. "," ..
+					(iY + (sfinv_only and 2.85 or 2.35)) ..
+					";0.9,0.7;craftguide_arrow.png^[transformFX]" ..
+				"item_image_button[" .. (xoffset - 1) .. "," ..
+					(iY + (sfinv_only and 2.7 or 2.2)) ..
+					";" .. BUTTON_SIZE .. "," .. BUTTON_SIZE ..
+					";" .. data.item .. ";" .. data.item .. ";]" ..
 				self:get_tooltip(data.item) ..
-				"image[" .. (xoffset - 2) .. "," ..
-					(iY + 2.18) .. ";1,1;craftguide_fire.png]"
+				"image[" .. (xoffset + 1) .. "," ..
+					(iY + (sfinv_only and 2.68 or 2.18)) ..
+					";1.1,1.1;craftguide_fire.png]"
 		else
 			local show_usage = data.show_usage
 			formspec = formspec ..
-				self:get_recipe(iY, xoffset,
+				self:get_recipe(data.iX,
+						iY,
+						xoffset,
 						data.rnum,
 						(show_usage and data.usages or data.recipes_item),
 						show_usage)
@@ -407,25 +433,21 @@ function craftguide:get_item_usages(item)
 end
 
 local function get_fields(player, ...)
-	local args = {...}
-	local formname, fields
-
-	if #args == 1 then
-		formname = "craftguide"
-		fields = args[#args]
+	local args, formname, fields = {...}
+	if sfinv_only then
+		fields = args[1]
 	else
-		formname, fields = unpack(args)
+		formname, fields = args[1], args[2]
 	end
 
-	if formname ~= "craftguide" then return end
+	if not sfinv_only and formname ~= "craftguide" then return end
 	local player_name = player:get_player_name()
 	local data = datas[player_name]
 
 	local show_fs = function(is_fuel)
+		if sfinv_only then
 			local context = sfinv.get_or_create_context(player)
 			context.fuel = is_fuel
-
-		if sfinv_only then
 			sfinv.set_player_inventory_formspec(player, context)
 		else
 			craftguide:get_formspec(player_name, is_fuel)

settingtypes.txt

@@ -1,4 +1,4 @@
 #For enabling some options of craftguide.
 
 craftguide_progressive_mode	(Progressive Mode)	bool false
-craftguide_sfinv_only		(Sfinv only)		bool true
+craftguide_sfinv_only		(Sfinv only)		bool false