Add an API for custom recipes

README.md

@@ -30,7 +30,7 @@ craftguide.register_craft_type("digging", {
 ```Lua
 craftguide.register_craft({
 	type   = "digging",
-	output = "default:cobble 2",
+	output = "default:cobble",
 	items  = {"default:stone"},
 })
 ```

init.lua

@@ -1,4 +1,4 @@
-craftguide = {
+local craftguide = {
 	custom_crafts = {},
 	craft_types = {},
 }
@@ -86,7 +86,7 @@ local function reset_datas(data)
 	data.fuel       = nil
 end
 
-local function in_table(T)
+local function player_has_item(T)
 	for i = 1, #T do
 		if T[i] then
 			return true
@@ -110,7 +110,39 @@ local function item_in_inv(inv, item)
 	return inv:contains_item("main", item)
 end
 
-local function group_to_item(item)
+local show_fs = function(player, player_name)
+	if sfinv_only then
+		local context = sfinv.get_or_create_context(player)
+		sfinv.set_player_inventory_formspec(player, context)
+	else
+		craftguide:get_formspec(player_name)
+	end
+end
+
+local function init_datas(user, name)
+	datas[name] = {filter = "", pagenum = 1, iX = sfinv_only and 8 or DEFAULT_SIZE}
+	if progressive_mode then
+		craftguide:get_filter_items(datas[name], user)
+	end
+end
+
+local function add_custom_recipes(item, recipes)
+	for j = 1, #craftguide.custom_crafts do
+		local craft = craftguide.custom_crafts[j]
+		if craft.output:match("%S*") == item then
+			recipes[#recipes + 1] = {
+				width  = craftguide.craft_types[craft.type].width,
+				type   = craft.type,
+				items  = craft.items,
+				output = craft.output,
+			}
+		end
+	end
+
+	return recipes
+end
+
+function craftguide:group_to_item(item)
 	if item:sub(1,6) == "group:" then
 		local itemsub = item:sub(7)
 		if group_stereotypes[itemsub] then
@@ -129,7 +161,7 @@ local function group_to_item(item)
 	return item:sub(1,6) == "group:" and "" or item
 end
 
-local function get_tooltip(item, recipe_type, cooktime, groups)
+function craftguide:get_tooltip(item, recipe_type, cooktime, groups)
 	local tooltip, item_desc = "tooltip[" .. item .. ";", ""
 	local fueltime = get_fueltime(item)
 	local has_extras = groups or recipe_type == "cooking" or fueltime > 0
@@ -166,7 +198,7 @@ local function get_tooltip(item, recipe_type, cooktime, groups)
 	return has_extras and tooltip .. "]" or ""
 end
 
-local function _get_recipe(iX, 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 ..
@@ -214,20 +246,20 @@ local function _get_recipe(iX, iY, xoffset, recipe_num, recipes, show_usage)
 
 			local groups = extract_groups(v)
 			local label = groups and "\nG" or ""
-			local item_r = group_to_item(v)
-			local tltip = get_tooltip(item_r, recipe_type, cooktime, groups)
+			local item_r = self:group_to_item(v)
+			local tltip = self:get_tooltip(item_r, recipe_type, cooktime, groups)
 
 			formspec = formspec ..
 				"item_image_button[" .. X .. "," ..
 					(Y + (sfinv_only and 0.7 or 0.2)) .. ";" ..
 					BUTTON_SIZE .. "," .. BUTTON_SIZE .. ";" .. item_r ..
-					";" .. item_r:match("%S*") .. ";" .. label .. "]" .. tltip
+					";" .. item_r .. ";" .. label .. "]" .. tltip
 		end
 
 		BUTTON_SIZE = 1.1
 	end
 
-	local custom_recipe = craftguide.craft_types[recipe_type]
+	local custom_recipe = self.craft_types[recipe_type]
 	if recipe_type == "cooking" or (recipe_type == "normal" and width == 0) or
 			custom_recipe then
 		local icon   = recipe_type == "cooking" and "furnace" or "shapeless"
@@ -238,7 +270,7 @@ local function _get_recipe(iX, iY, xoffset, recipe_num, recipes, show_usage)
 		formspec = formspec ..
 			"image[" .. coords ..
 				(custom_recipe and custom_recipe.icon or
-				 "craftguide_" .. icon .. ".png^[resize:16x16") .. "]" ..
+				 "craftguide_" .. icon .. ".png") .. "]" ..
 			"tooltip[" .. coords ..
 				(custom_recipe and custom_recipe.description or
 					recipe_type:gsub("^%l", string.upper)) .. "]"
@@ -261,7 +293,7 @@ local function _get_recipe(iX, iY, xoffset, recipe_num, recipes, show_usage)
 				BUTTON_SIZE .. "," .. BUTTON_SIZE .. ";" ..
 				output .. ";" .. output_s .. ";]" ..
 
-		get_tooltip(output_s)
+		self:get_tooltip(output_s)
 
 	if output_is_fuel then
 		formspec = formspec ..
@@ -277,7 +309,7 @@ local function _get_recipe(iX, iY, xoffset, recipe_num, recipes, show_usage)
 	return formspec
 end
 
-local function get_formspec(player_name)
+function craftguide:get_formspec(player_name)
 	local data = datas[player_name]
 	local iY = sfinv_only and 4 or data.iX - 5
 	local ipp = data.iX * iY
@@ -353,7 +385,7 @@ local function get_formspec(player_name)
 					(iY + (sfinv_only and 2.85 or 2.35)) ..
 					";0.9,0.7;craftguide_arrow.png]" ..
 
-				get_tooltip(data.item) ..
+				self:get_tooltip(data.item) ..
 
 				"image[" .. (X + 2.1) .. "," ..
 					(iY + (sfinv_only and 2.68 or 2.18)) ..
@@ -361,7 +393,7 @@ local function get_formspec(player_name)
 		else
 			local show_usage = data.show_usage
 			formspec = formspec ..
-				_get_recipe(data.iX,
+				self:get_recipe(data.iX,
 						iY,
 						xoffset,
 						data.rnum,
@@ -379,16 +411,7 @@ local function get_formspec(player_name)
 	end
 end
 
-local show_fs = function(player, player_name)
-	if sfinv_only then
-		local context = sfinv.get_or_create_context(player)
-		sfinv.set_player_inventory_formspec(player, context)
-	else
-		get_formspec(player_name)
-	end
-end
-
-local function recipe_in_inv(inv, item_name, recipes_f)
+function craftguide:recipe_in_inv(inv, item_name, recipes_f)
 	local recipes = recipes_f or get_recipes(item_name) or {}
 	local show_item_recipes = {}
 
@@ -416,10 +439,53 @@ local function recipe_in_inv(inv, item_name, recipes_f)
 		end
 	end
 
-	return recipes, in_table(show_item_recipes)
+	return recipes, player_has_item(show_item_recipes)
 end
 
-local function get_filter_items(data, player)
+function craftguide:get_init_items()
+	local items_list, c = {}, 0
+	local function list(name)
+		c = c + 1
+		items_list[c] = name
+	end
+
+	for name, def in pairs(reg_items) do
+		local is_fuel = get_fueltime(name) > 0
+		if (not (def.groups.not_in_craft_guide == 1 or
+			 def.groups.not_in_creative_inventory == 1)) and
+		        (get_recipe(name).items or is_fuel) and
+			 def.description and def.description ~= "" then
+				list(name)
+		end
+	end
+
+	for i = 1, #self.custom_crafts do
+		local craft  = self.custom_crafts[i]
+		local output = craft.output:match("%S*")
+		local listed
+
+		for j = 1, #items_list do
+			local listed_item = items_list[j]
+			if output == listed_item then
+				listed = true
+				break
+			end
+		end
+
+		if not listed then
+			list(output)
+		end
+	end
+
+	sort(items_list)
+	datas.init_items = items_list
+end
+
+mt.register_on_mods_loaded(function()
+	craftguide:get_init_items()
+end)
+
+function craftguide:get_filter_items(data, player)
 	local filter = data.filter
 	if datas.searches[filter] then
 		data.items = datas.searches[filter]
@@ -440,7 +506,7 @@ local function get_filter_items(data, player)
 				filtered_list[counter] = item
 			end
 		elseif progressive_mode then
-			local _, has_item = recipe_in_inv(inv, item)
+			local _, has_item = self:recipe_in_inv(inv, item)
 			if has_item then
 				counter = counter + 1
 				filtered_list[counter] = item
@@ -464,73 +530,7 @@ local function get_filter_items(data, player)
 	data.items = filtered_list
 end
 
-local function init_datas(user, name)
-	datas[name] = {filter = "", pagenum = 1, iX = sfinv_only and 8 or DEFAULT_SIZE}
-	if progressive_mode then
-		get_filter_items(datas[name], user)
-	end
-end
-
-local function add_custom_recipes(item, recipes)
-	for j = 1, #craftguide.custom_crafts do
-		local craft = craftguide.custom_crafts[j]
-		if craft.output:match("%S*") == item then
-			recipes[#recipes + 1] = {
-				width  = craftguide.craft_types[craft.type].width,
-				type   = craft.type,
-				items  = craft.items,
-				output = craft.output,
-			}
-		end
-	end
-
-	return recipes
-end
-
-local function get_init_items()
-	local items_list, c = {}, 0
-	local function list(name)
-		c = c + 1
-		items_list[c] = name
-	end
-
-	for name, def in pairs(reg_items) do
-		local is_fuel = get_fueltime(name) > 0
-		if (not (def.groups.not_in_craft_guide == 1 or
-			 def.groups.not_in_creative_inventory == 1)) and
-		        (get_recipe(name).items or is_fuel) and
-			 def.description and def.description ~= "" then
-				list(name)
-		end
-	end
-
-	for i = 1, #craftguide.custom_crafts do
-		local craft  = craftguide.custom_crafts[i]
-		local output = craft.output:match("%S*")
-		local listed
-
-		for j = 1, #items_list do
-			local listed_item = items_list[j]
-			if output == listed_item then
-				listed = true
-				break
-			end
-		end
-
-		if not listed then
-			list(output)
-		end
-	end
-
-	sort(items_list)
-	datas.init_items = items_list
-end
-
-mt.register_on_mods_loaded(function()
-	get_init_items()
-end)
-
-local function get_item_usages(item)
+function craftguide:get_item_usages(item)
 	local usages = {}
 	for name, def in pairs(reg_items) do
 		if not (def.groups.not_in_craft_guide == 1 or
@@ -591,7 +591,7 @@ local function get_fields(player, ...)
 			fields.filter ~= "" then
 		data.filter = fields.filter:lower()
 		data.pagenum = 1
-		get_filter_items(data, player)
+		craftguide:get_filter_items(data, player)
 		show_fs(player, player_name)
 
 	elseif fields.prev or fields.next then
@@ -625,7 +625,7 @@ local function get_fields(player, ...)
 			if not next(recipes) and not is_fuel then return end
 
 			if not data.show_usage and item == data.item and not progressive_mode then
-				data.usages = get_item_usages(item)
+				data.usages = craftguide:get_item_usages(item)
 				if next(data.usages) then
 					data.show_usage = true
 					data.rnum = 1
@@ -635,9 +635,10 @@ local function get_fields(player, ...)
 			else
 				if progressive_mode then
 					local inv = player:get_inventory()
-					local has_item
-					recipes, has_item = recipe_in_inv(inv, item, recipes)
+					local _, has_item = craftguide:recipe_in_inv(inv, item)
+
 					if not has_item then return end
+					recipes = craftguide:recipe_in_inv(inv, item, recipes)
 				end
 
 				data.item          = item
@@ -661,7 +662,7 @@ if sfinv_only then
 			return sfinv.make_formspec(
 				player,
 				context,
-				get_formspec(player_name)
+				craftguide:get_formspec(player_name)
 			)
 		end,
 		on_enter = function(self, player, context)
@@ -679,13 +680,13 @@ if sfinv_only then
 else
 	mt.register_on_player_receive_fields(get_fields)
 
-	local function on_use(itemstack, user)
+	function craftguide:on_use(itemstack, user)
 		local player_name = user:get_player_name()
 		local data = datas[player_name]
 
 		if progressive_mode or not data then
 			init_datas(user, player_name)
-			get_formspec(player_name)
+			self:get_formspec(player_name)
 		else
 			show_formspec(player_name, "craftguide", data.formspec)
 		end
@@ -698,7 +699,7 @@ else
 		stack_max = 1,
 		groups = {book = 1},
 		on_use = function(itemstack, user)
-			on_use(itemstack, user)
+			craftguide:on_use(itemstack, user)
 		end
 	})
 
@@ -723,7 +724,7 @@ else
 			meta:set_string("infotext", S("Crafting Guide Sign"))
 		end,
 		on_rightclick = function(pos, node, user, itemstack)
-			on_use(itemstack, user)
+			craftguide:on_use(itemstack, user)
 		end
 	})
 
@@ -750,17 +751,17 @@ else
 		recipe = "craftguide:sign",
 		burntime = 10
 	})
+end
 
-	if rawget(_G, "sfinv_buttons") then
-		sfinv_buttons.register_button("craftguide", {
-			title = S("Crafting Guide"),
-			tooltip = S("Shows a list of available crafting recipes, cooking recipes and fuels"),
-			action = function(player)
-				on_use(nil, player)
-			end,
-			image = "craftguide_book.png",
-		})
-	end
+if rawget(_G, "sfinv_buttons") then
+	sfinv_buttons.register_button("craftguide", {
+		title = S("Crafting Guide"),
+		tooltip = S("Shows a list of available crafting recipes, cooking recipes and fuels"),
+		action = function(player)
+			craftguide:on_use(nil, player)
+		end,
+		image = "craftguide_book.png",
+	})
 end
 
 if not progressive_mode then