Add an API for custom recipes

.luacheckrc

@@ -4,5 +4,7 @@ allow_defined_top = true
 read_globals = {
 	"minetest",
 	"default",
+	"sfinv",
 	"sfinv_buttons",
+	"vector",
 }

LICENSE

@@ -1,4 +1,7 @@
-« Copyright © 2015-2017, Jean-Patrick Guerrero <jeanpatrick.guerrero@gmail.com>
+License of source code
+----------------------
+
+« 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:
 
@@ -7,3 +10,36 @@ The above copyright notice and this permission notice shall be included in all c
 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 X 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.
 
 Except as contained in this notice, the name of the <copyright holders> shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from the <copyright holders>. »
+
+Licenses of media (textures)
+----------------------------
+
+Copyright © Diego Martínez (kaeza): craftguide_*_icon.png (CC BY-SA 3.0)
+
+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/

README.md

@@ -1,14 +1,38 @@
 ## ![Preview1](http://i.imgur.com/fIPNYkb.png) Crafting Guide ##
 
-#### A Crafting Guide for Minetest that doesn't suck. ####
+#### `craftguide` is the most comprehensive crafting guide on Minetest. ####
+#### Consult the [Minetest Wiki](http://wiki.minetest.net/Crafting_guide) for more details. ####
 
-#### `craftguide` is the most comprehensive mod of its category. ####
+This crafting guide is a blue book named *"Crafting Guide"* or a wooden sign.
-#### Consult the [Minetest Wiki](http://wiki.minetest.net/Crafting_guide) for more details and comparisons. ####
 
-#### This crafting guide is usable with a blue book named *"Crafting Guide"*. ####
+This crafting guide features a **progressive mode**.
-
+The progressive mode is a Terraria-like system that only shows recipes you can craft from items in inventory.
-#### This crafting guide features two modes : Standard and Progressive. ####
-The Progressive mode is a Terraria-like system that only shows recipes you can craft from items in inventory.
 The progressive mode can be enabled with `craftguide_progressive_mode = true` in `minetest.conf`.
 
-![Preview2](http://i.imgur.com/3q7rVSo.png)
+`craftguide` is also integrated in `sfinv` (Minetest Game inventory) when you enable it with
+`craftguide_sfinv_only = true` in `minetest.conf`.
+
+Use the command `/craft` to show the recipe(s) of the pointed node.
+
+---
+
+`craftguide` has an API to register **custom recipes**. Demos:
+#### Registering a custom crafting type ####
+```Lua
+craftguide.register_craft_type("digging", {
+	description = S("Digging"),
+	icon  = "default_tool_steelpick.png",
+	width = 1,
+})
+```
+
+#### Registering a custom crafting recipe ####
+```Lua
+craftguide.register_craft({
+	type   = "digging",
+	output = "default:cobble",
+	items  = {"default:stone"},
+})
+```
+
+![Preview2](https://i.imgur.com/bToFH38.png)

depends.txt

@@ -1,2 +1,3 @@
+sfinv?
 sfinv_buttons?
 intllib?

init.lua

@@ -1,10 +1,19 @@
-local craftguide, datas, mt = {}, {searches = {}}, minetest
+local craftguide = {
+	custom_crafts = {},
+	craft_types = {},
+}
+
+local mt = minetest
+local datas = {searches = {}}
+
 local progressive_mode = mt.settings:get_bool("craftguide_progressive_mode")
+local sfinv_only       = mt.settings:get_bool("craftguide_sfinv_only")
+
 local get_recipe, get_recipes = mt.get_craft_recipe, mt.get_all_craft_recipes
 local get_result, show_formspec = mt.get_craft_result, mt.show_formspec
 local reg_items = mt.registered_items
 
-craftguide.path = minetest.get_modpath("craftguide")
+craftguide.path = mt.get_modpath("craftguide")
 
 -- Intllib
 local S = dofile(craftguide.path .. "/intllib.lua")
@@ -13,13 +22,15 @@ craftguide.intllib = S
 -- Lua 5.3 removed `table.maxn`, use this alternative in case of breakage:
 -- https://github.com/kilbith/xdecor/blob/master/handlers/helpers.lua#L1
 local remove, maxn, sort = table.remove, table.maxn, table.sort
+local vector_add, vector_mul = vector.add, vector.multiply
 local min, max, floor, ceil = math.min, math.max, math.floor, math.ceil
 
 local DEFAULT_SIZE = 10
-local MIN_LIMIT, MAX_LIMIT = 9, 12
+local MIN_LIMIT, MAX_LIMIT = 10, 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",
@@ -31,216 +42,48 @@ local group_stereotypes = {
 	mesecon_conductor_craftable = "mesecons:wire_00000000_off",
 }
 
-function craftguide:group_to_item(item)
-	if item:sub(1,6) == "group:" then
-		local itemsub = item:sub(7)
-		if group_stereotypes[itemsub] then
-			item = group_stereotypes[itemsub]
-		elseif reg_items["default:" .. itemsub] then
-			item = item:gsub("group:", "default:")
-		else
-			for name, def in pairs(reg_items) do
-				if def.groups[item:match("[^,:]+$")] then
-					item = name
-				end
-			end
-		end
-	end
-
-	return item:sub(1,6) == "group:" and "" or item
-end
-
 local function extract_groups(str)
 	if str:sub(1,6) ~= "group:" then return end
 	return str:sub(7):split(",")
 end
 
+function craftguide.register_craft_type(name, def)
+	if not craftguide.craft_types[name] then
+		craftguide.craft_types[name] = def
+	end
+end
+
+craftguide.register_craft_type("digging", {
+	description = S("Digging"),
+	icon  = "default_tool_steelpick.png",
+	width = 1,
+})
+
+function craftguide.register_craft(def)
+	craftguide.custom_crafts[#craftguide.custom_crafts + 1] = def
+end
+
+craftguide.register_craft({
+	type   = "digging",
+	output = "default:cobble",
+	items  = {"default:stone"},
+})
+
 local function colorize(str)
-	-- If client <= 0.4.14, don't colorize for compatibility.
+	return mt.colorize("#FFFF00", str)
-	return mt.colorize and mt.colorize("#FFFF00", str) or str
 end
 
 local function get_fueltime(item)
 	return get_result({method = "fuel", width = 1, items = {item}}).time
 end
 
-function craftguide:get_tooltip(item, recipe_type, cooktime, groups)
+local function reset_datas(data)
-	local tooltip, item_desc = "tooltip[" .. item .. ";", ""
+	data.show_usage = nil
-	local fueltime = get_fueltime(item)
+	data.filter     = ""
-	local has_extras = groups or recipe_type == "cooking" or fueltime > 0
+	data.item       = nil
-
+	data.pagenum    = 1
-	if reg_items[item] then
+	data.rnum       = 1
-		if not groups then
+	data.fuel       = nil
-			item_desc = reg_items[item].description
-		end
-	else
-		return tooltip .. S("Unknown Item (@1)", item) .. "]"
-	end
-
-	if groups then
-		local groupstr = ""
-		for i = 1, #groups do
-			groupstr = groupstr ..
-				colorize(groups[i]) .. (groups[i + 1] and ", " or "")
-		end
-
-		tooltip = tooltip .. S("Any item belonging to the group(s)") .. ": " .. groupstr
-	end
-
-	if recipe_type == "cooking" then
-		tooltip = tooltip .. item_desc .. "\n"
-				.. S("Cooking time") .. ": " .. colorize(cooktime)
-	end
-
-	if fueltime > 0 then
-		tooltip = tooltip .. item_desc .. "\n"
-				.. S("Burning time") .. ": " .. colorize(fueltime)
-	end
-
-	return has_extras and tooltip .. "]" or ""
-end
-
-function craftguide:get_recipe(iY, xoffset, tooltip, item, recipe_num, recipes, show_usage)
-	local formspec, recipes_total = "", #recipes
-	if recipes_total > 1 then
-		formspec = formspec ..
-			"button[0," .. (iY + 3.3) .. ";2,1;alternate;" .. S("Alternate") .. "]" ..
-			"label[0," .. (iY + 2.8) .. ";" ..
-				(show_usage and S("Usage") or S("Recipe")) .. " " ..
-				 S("@1 of @2", recipe_num, recipes_total) .. "]"
-	end
-
-	local recipe_type = recipes[recipe_num].type
-	local items = recipes[recipe_num].items
-	local width = recipes[recipe_num].width
-
-	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 + 1.7)  ..
-				";0.5,0.5;craftguide_" .. icon .. ".png]"
-	end
-
-	if width == 0 then
-		width = min(3, #items)
-	end
-
-	local rows = ceil(maxn(items) / width)
-
-	if recipe_type == "normal" and (width > GRID_LIMIT or rows > GRID_LIMIT) then
-		formspec = formspec ..
-			"label[" .. xoffset .. "," .. (iY + 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 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)
-			end
-
-			local groups = extract_groups(v)
-			local label = groups and "\nG" or ""
-			local item_r = self:group_to_item(v)
-			local tltip = self:get_tooltip(item_r, recipe_type, width, groups)
-
-			formspec = formspec ..
-				"item_image_button[" .. X .. "," .. (Y + 0.2) .. ";" ..
-					btn_size .. "," .. btn_size .. ";" .. item_r ..
-					";" .. item_r .. ";" .. label .. "]" .. tltip
-		end
-	end
-
-	local output = recipes[recipe_num].output
-	return formspec ..
-		"image[" .. (xoffset - 1) .. "," .. (iY + 2.35) ..
-			";0.9,0.7;craftguide_arrow.png]" ..
-		"item_image_button[" .. (xoffset - 2) .. "," .. (iY + 2.2) .. ";1,1;" ..
-			output .. ";" .. item .. ";]" .. tooltip
-end
-
-function craftguide:get_formspec(player_name, is_fuel)
-	local data = datas[player_name]
-	local iY = data.iX - 5
-	local ipp = data.iX * iY
-
-	if not data.items then
-		data.items = datas.init_items
-	end
-
-	data.pagemax = max(1, ceil(#data.items / ipp))
-
-	local formspec = "size[" .. (data.iX - 0.35) .. "," .. (iY + 4) .. ";]" .. [[
-			background[1,1;1,1;craftguide_bg.png;true]
-			button[2.4,0.23;0.8,0.5;search;?]
-			button[3.05,0.23;0.8,0.5;clear;X]
-			field_close_on_enter[filter;false]
-		]] ..
-			"tooltip[search;" .. S("Search") .. "]" ..
-			"tooltip[clear;" .. S("Reset") .. "]" ..
-			"tooltip[size_inc;" .. S("Increase window size") .. "]" ..
-			"tooltip[size_dec;" .. S("Decrease window size") .. "]" ..
-			"tooltip[prev;" .. S("Previous page") .. "]" ..
-			"tooltip[next;" .. S("Next page") .. "]" ..
-			"button[" .. (data.iX * 0.48) .. ",-0.02;0.7,1;size_inc;+]" ..
-			"button[" .. ((data.iX * 0.48) + 0.5) ..
-				",-0.02;0.7,1;size_dec;-]" ..
-			"button[" .. (data.iX - 3.1) .. ",0;0.8,0.95;prev;<]" ..
-			"label[" .. (data.iX - 2.2) .. ",0.18;" ..
-				colorize(data.pagenum) .. " / " .. data.pagemax .. "]" ..
-			"button[" .. (data.iX - 1.2) .. ",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)
-
-	if not next(data.items) then
-		formspec = formspec ..
-			"label[" .. (xoffset - (even_num and 1.5 or 1)) .. ",2;" ..
-				S("No item to show") .. "]"
-	end
-
-	local first_item = (data.pagenum - 1) * ipp
-	for i = first_item, first_item + ipp - 1 do
-		local name = data.items[i + 1]
-		if not name then break end
-		local X = i % data.iX
-		local Y = (i % ipp - X) / data.iX + 1
-
-		formspec = formspec ..
-			"item_image_button[" .. (X - (X * 0.05)) .. "," .. Y .. ";1.1,1.1;" ..
-				name .. ";" .. name .. "_inv;]"
-	end
-
-	if data.item and reg_items[data.item] then
-		local tooltip = self:get_tooltip(data.item)
-		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 .. ";]" ..
-				tooltip ..
-				"image[" .. (xoffset - 2) .. "," ..
-					(iY + 2.18) .. ";1,1;craftguide_fire.png]"
-		else
-			local show_usage = data.show_usage
-			formspec = formspec ..
-				self:get_recipe(iY, xoffset, tooltip,
-						data.item,
-						data.rnum,
-						(show_usage and data.usages or data.recipes_item),
-						show_usage)
-		end
-	end
-
-	data.formspec = formspec
-	show_formspec(player_name, "craftguide", formspec)
 end
 
 local function player_has_item(T)
@@ -267,6 +110,307 @@ local function item_in_inv(inv, item)
 	return inv:contains_item("main", item)
 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
+		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
+			item = group_stereotypes[itemsub]
+		elseif reg_items["default:" .. itemsub] then
+			item = item:gsub("group:", "default:")
+		else
+			for name, def in pairs(reg_items) do
+				if def.groups[item:match("[^,:]+$")] then
+					item = name
+				end
+			end
+		end
+	end
+
+	return item:sub(1,6) == "group:" and "" or item
+end
+
+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
+
+	if reg_items[item] then
+		if not groups then
+			item_desc = reg_items[item].description
+		end
+	else
+		return tooltip .. S("Unknown Item (@1)", item) .. "]"
+	end
+
+	if groups then
+		local groupstr = ""
+		for i = 1, #groups do
+			groupstr = groupstr ..
+				colorize(groups[i]) .. (groups[i + 1] and ", " or "")
+		end
+
+		tooltip = tooltip ..
+			S("Any item belonging to the group(s)") .. ": " .. groupstr
+	end
+
+	if recipe_type == "cooking" then
+		tooltip = tooltip .. item_desc .. "\n" ..
+			S("Cooking time") .. ": " .. colorize(cooktime)
+	end
+
+	if fueltime > 0 then
+		tooltip = tooltip .. item_desc .. "\n" ..
+			S("Burning time") .. ": " .. colorize(fueltime)
+	end
+
+	return has_extras and tooltip .. "]" or ""
+end
+
+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[" .. (iX - (sfinv_only and 2.2 or 2.6)) .. "," ..
+				(iY + (sfinv_only and 3.9 or 3.3)) .. ";2.2,1;alternate;" ..
+				(show_usage and S("Usage") or S("Recipe")) .. " " ..
+				S("@1 of @2", recipe_num, recipes_total) .. "]"
+	end
+
+	local recipe_type = recipes[recipe_num].type
+	local items = recipes[recipe_num].items
+	local width = recipes[recipe_num].width
+
+	local cooktime = width
+	if recipe_type == "cooking" then
+		width = 1
+	elseif width == 0 then
+		width = min(3, #items)
+	end
+
+	local rows = ceil(maxn(items) / width)
+	local rightest, s_btn_size = 0
+
+	if recipe_type ~= "fuel" and (width > GRID_LIMIT or rows > GRID_LIMIT) then
+		formspec = formspec ..
+			"label[" .. ((iX / 2) - 2) .. "," .. (iY + 2.2) .. ";" ..
+				S("Recipe is too big to be displayed (@1x@2)", width, rows) .. "]"
+		return formspec
+	else
+		for i, v in pairs(items) do
+			local X = ceil((i - 1) % width + xoffset - width) -
+				 (sfinv_only and 0 or 0.2)
+			local Y = ceil(i / width + (iY + 2) - min(2, rows))
+
+			if recipe_type ~= "fuel" and (width > 3 or rows > 3) then
+				BUTTON_SIZE = width > 3 and 3 / width or 3 / rows
+				s_btn_size = BUTTON_SIZE
+				X = BUTTON_SIZE * (i % width) + xoffset - 2.65
+				Y = BUTTON_SIZE * floor((i - 1) / width) + (iY + 3) - min(2, rows)
+			end
+
+			if X > rightest then
+				rightest = X
+			end
+
+			local groups = extract_groups(v)
+			local label = groups and "\nG" or ""
+			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 .. ";" .. label .. "]" .. tltip
+		end
+
+		BUTTON_SIZE = 1.1
+	end
+
+	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"
+		local coords = (rightest + 1.2) .. "," ..
+			       (iY + (sfinv_only and 2.2 or 1.7)) ..
+			       ";0.5,0.5;"
+
+		formspec = formspec ..
+			"image[" .. coords ..
+				(custom_recipe and custom_recipe.icon or
+				 "craftguide_" .. icon .. ".png") .. "]" ..
+			"tooltip[" .. coords ..
+				(custom_recipe and custom_recipe.description or
+					recipe_type:gsub("^%l", string.upper)) .. "]"
+	end
+
+	local output   = recipes[recipe_num].output
+	local output_s = output:match("%S+")
+	local output_is_fuel = get_fueltime(output) > 0
+
+	local arrow_X  = rightest + (s_btn_size or BUTTON_SIZE)
+	local output_X = arrow_X + 0.9
+
+	formspec = formspec ..
+		"image[" .. arrow_X .. "," ..
+			(iY + (sfinv_only and 2.85 or 2.35)) ..
+			";0.9,0.7;craftguide_arrow.png]" ..
+
+		"item_image_button[" .. output_X .. "," ..
+				(iY + (sfinv_only and 2.7 or 2.2)) .. ";" ..
+				BUTTON_SIZE .. "," .. BUTTON_SIZE .. ";" ..
+				output .. ";" .. output_s .. ";]" ..
+
+		self:get_tooltip(output_s)
+
+	if output_is_fuel then
+		formspec = formspec ..
+			"image[" .. (output_X + 1) .. "," ..
+				(iY + (sfinv_only and 2.83 or 2.33)) ..
+				";0.6,0.4;craftguide_arrow.png]" ..
+
+			"image[" .. (output_X + 1.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)
+	local data = datas[player_name]
+	local iY = sfinv_only and 4 or data.iX - 5
+	local ipp = data.iX * iY
+
+	if not data.items then
+		data.items = datas.init_items
+	end
+
+	data.pagemax = max(1, ceil(#data.items / ipp))
+
+	local formspec = ""
+	if not sfinv_only then
+		formspec = formspec ..
+			"size[" .. (data.iX - 0.35) .. "," .. (iY + 4) .. ";]" ..
+			"background[1,1;1,1;craftguide_bg.png;true]" ..
+			"tooltip[size_inc;" .. S("Increase window size") .. "]" ..
+			"tooltip[size_dec;" .. S("Decrease window size") .. "]" ..
+			"image_button[" .. (data.iX * 0.47) ..
+				",0.12;0.8,0.8;craftguide_zoomin_icon.png;size_inc;]" ..
+			"image_button[" .. ((data.iX * 0.47) + 0.6) ..
+				",0.12;0.8,0.8;craftguide_zoomout_icon.png;size_dec;]"
+	end
+
+	formspec = formspec .. [[
+			image_button[2.4,0.12;0.8,0.8;craftguide_search_icon.png;search;]
+			image_button[3.05,0.12;0.8,0.8;craftguide_clear_icon.png;clear;]
+			field_close_on_enter[filter;false]
+		]] ..
+			"tooltip[search;" .. S("Search") .. "]" ..
+			"tooltip[clear;" .. S("Reset") .. "]" ..
+			"tooltip[prev;" .. S("Previous page") .. "]" ..
+			"tooltip[next;" .. S("Next page") .. "]" ..
+			"image_button[" .. (data.iX - (sfinv_only and 2.6 or 3.1)) ..
+				",0.12;0.8,0.8;craftguide_prev_icon.png;prev;]" ..
+			"label[" .. (data.iX - (sfinv_only and 1.7 or 2.2)) .. ",0.22;" ..
+				colorize(data.pagenum) .. " / " .. data.pagemax .. "]" ..
+			"image_button[" .. (data.iX - (sfinv_only and 0.7 or 1.2) -
+				(data.iX >= 11 and 0.08 or 0)) ..
+				",0.12;0.8,0.8;craftguide_next_icon.png;next;]" ..
+			"field[0.3,0.32;2.5,1;filter;;" .. mt.formspec_escape(data.filter) .. "]"
+
+	local xoffset = data.iX / 2.15
+
+	if not next(data.items) then
+		formspec = formspec ..
+			"label[" .. ((data.iX / 2) - 1) .. ",2;" .. S("No item to show") .. "]"
+	end
+
+	local first_item = (data.pagenum - 1) * ipp
+	for i = first_item, first_item + ipp - 1 do
+		local name = data.items[i + 1]
+		if not name then break end
+		local X = i % data.iX
+		local Y = (i % ipp - X) / data.iX + 1
+
+		formspec = formspec ..
+			"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 (data.fuel and not get_recipe(data.item).items) then
+			local X = floor(xoffset) - (sfinv_only and 0 or 0.2)
+			formspec = formspec ..
+				"item_image_button[" .. X .. "," ..
+					(iY + (sfinv_only and 2.7 or 2.2)) ..
+					";" .. BUTTON_SIZE .. "," .. BUTTON_SIZE ..
+					";" .. data.item .. ";" .. data.item .. ";]" ..
+
+				"image[" .. (X + 1.1) .. "," ..
+					(iY + (sfinv_only and 2.85 or 2.35)) ..
+					";0.9,0.7;craftguide_arrow.png]" ..
+
+				self:get_tooltip(data.item) ..
+
+				"image[" .. (X + 2.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(data.iX,
+						iY,
+						xoffset,
+						data.rnum,
+						(show_usage and data.usages or data.recipes_item),
+						show_usage)
+		end
+	end
+
+	data.formspec = formspec
+
+	if sfinv_only then
+		return formspec
+	else
+		show_formspec(player_name, "craftguide", formspec)
+	end
+end
+
 function craftguide:recipe_in_inv(inv, item_name, recipes_f)
 	local recipes = recipes_f or get_recipes(item_name) or {}
 	local show_item_recipes = {}
@@ -299,15 +443,37 @@ function craftguide:recipe_in_inv(inv, item_name, recipes_f)
 end
 
 function craftguide:get_init_items()
-	local items_list, counter = {}, 0
+	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
+		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
 
-			counter = counter + 1
+	for i = 1, #self.custom_crafts do
-			items_list[counter] = name
+		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
 
@@ -315,6 +481,10 @@ function craftguide:get_init_items()
 	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
@@ -363,8 +533,9 @@ end
 function craftguide:get_item_usages(item)
 	local usages = {}
 	for name, def in pairs(reg_items) do
-		if not (def.groups.not_in_creative_inventory == 1) and
+		if not (def.groups.not_in_craft_guide == 1 or
-		  (get_recipe(name).items) and def.description and def.description ~= "" then
+			def.groups.not_in_creative_inventory == 1) and
+		   get_recipe(name).items and def.description and def.description ~= "" then
 			local recipes = get_recipes(name)
 			for i = 1, #recipes do
 				local recipe = recipes[i]
@@ -388,20 +559,22 @@ function craftguide:get_item_usages(item)
 	return usages
 end
 
-mt.register_on_player_receive_fields(function(player, formname, fields)
+local function get_fields(player, ...)
-	if formname ~= "craftguide" then return end
+	local args, formname, fields = {...}
+	if sfinv_only then
+		fields = args[1]
+	else
+		formname, fields = args[1], args[2]
+	end
+
+	if not sfinv_only and formname ~= "craftguide" then return end
 	local player_name = player:get_player_name()
 	local data = datas[player_name]
 
 	if fields.clear then
-		data.show_usage = nil
+		reset_datas(data)
-		data.filter     = ""
-		data.item       = nil
-		data.pagenum    = 1
-		data.rnum       = 1
-
 		data.items = progressive_mode and data.init_filter_items or datas.init_items
-		craftguide:get_formspec(player_name)
+		show_fs(player, player_name)
 
 	elseif fields.alternate then
 		local num
@@ -412,14 +585,14 @@ mt.register_on_player_receive_fields(function(player, formname, fields)
 		end
 
 		data.rnum = num and data.rnum + 1 or 1
-		craftguide:get_formspec(player_name)
+		show_fs(player, player_name)
 
 	elseif (fields.key_enter_field == "filter" or fields.search) and
 			fields.filter ~= "" then
 		data.filter = fields.filter:lower()
 		data.pagenum = 1
 		craftguide:get_filter_items(data, player)
-		craftguide:get_formspec(player_name)
+		show_fs(player, player_name)
 
 	elseif fields.prev or fields.next then
 		data.pagenum = data.pagenum - (fields.prev and 1 or -1)
@@ -430,23 +603,26 @@ mt.register_on_player_receive_fields(function(player, formname, fields)
 			data.pagenum = data.pagemax
 		end
 
-		craftguide:get_formspec(player_name)
+		show_fs(player, player_name)
 
 	elseif (fields.size_inc and data.iX < MAX_LIMIT) or
 			(fields.size_dec and data.iX > MIN_LIMIT) then
 		data.pagenum = 1
 		data.iX = data.iX - (fields.size_dec and 1 or -1)
-		craftguide:get_formspec(player_name)
+		show_fs(player, player_name)
 
 	else for item in pairs(fields) do
 		if item:find(":") then
 			if item:sub(-4) == "_inv" then
 				item = item:sub(1,-5)
+			elseif item:find("%s") then
+				item = item:match("%S*")
 			end
 
 			local is_fuel = get_fueltime(item) > 0
-			local recipes = get_recipes(item)
+			local recipes = get_recipes(item) or {}
-			if not recipes and not is_fuel then return end
+			recipes = add_custom_recipes(item, recipes)
+			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 = craftguide:get_item_usages(item)
@@ -455,7 +631,7 @@ mt.register_on_player_receive_fields(function(player, formname, fields)
 					data.rnum = 1
 				end
 
-				craftguide:get_formspec(player_name)
+				show_fs(player, player_name)
 			else
 				if progressive_mode then
 					local inv = player:get_inventory()
@@ -469,35 +645,54 @@ mt.register_on_player_receive_fields(function(player, formname, fields)
 				data.recipes_item  = recipes
 				data.rnum          = 1
 				data.show_usage    = nil
+				data.fuel          = is_fuel
 
-				craftguide:get_formspec(player_name, is_fuel)
+				show_fs(player, player_name)
 			end
 		end
 	     end
 	end
-end)
+end
 
-function craftguide:on_use(itemstack, user)
+if sfinv_only then
-	if not datas.init_items then
+	sfinv.register_page("craftguide:craftguide", {
-		self:get_init_items()
+		title = "Craft Guide",
-	end
+		get = function(self, player, context)
+			local player_name = player:get_player_name()
+			return sfinv.make_formspec(
+				player,
+				context,
+				craftguide:get_formspec(player_name)
+			)
+		end,
+		on_enter = function(self, player, context)
+			local player_name = player:get_player_name()
+			local data = datas[player_name]
 
+			if progressive_mode or not data then
+				init_datas(player, player_name)
+			end
+		end,
+		on_player_receive_fields = function(self, player, context, fields)
+			get_fields(player, fields)
+		end,
+	})
+else
+	mt.register_on_player_receive_fields(get_fields)
+
+	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
-		datas[player_name] = {filter = "", pagenum = 1, iX = DEFAULT_SIZE}
+			init_datas(user, player_name)
-		if progressive_mode then
-			self:get_filter_items(datas[player_name], user)
-		end
-
 			self:get_formspec(player_name)
 		else
 			show_formspec(player_name, "craftguide", data.formspec)
 		end
-end
+	end
 
-mt.register_craftitem("craftguide:book", {
+	mt.register_craftitem("craftguide:book", {
 		description = S("Crafting Guide"),
 		inventory_image = "craftguide_book.png",
 		wield_image = "craftguide_book.png",
@@ -506,9 +701,9 @@ mt.register_craftitem("craftguide:book", {
 		on_use = function(itemstack, user)
 			craftguide:on_use(itemstack, user)
 		end
-})
+	})
 
-mt.register_node("craftguide:sign", {
+	mt.register_node("craftguide:sign", {
 		description = S("Crafting Guide Sign"),
 		drawtype = "nodebox",
 		tiles = {"craftguide_sign.png"},
@@ -525,37 +720,38 @@ mt.register_node("craftguide:sign", {
 			wall_side   = {-0.5, -0.3125, -0.4375, -0.4375, 0.3125, 0.4375}
 		},
 		on_construct = function(pos)
-		local meta = minetest.get_meta(pos)
+			local meta = mt.get_meta(pos)
 			meta:set_string("infotext", S("Crafting Guide Sign"))
 		end,
 		on_rightclick = function(pos, node, user, itemstack)
 			craftguide:on_use(itemstack, user)
 		end
-})
+	})
 
-mt.register_craft({
+	mt.register_craft({
 		output = "craftguide:book",
 		type = "shapeless",
 		recipe = {"default:book"}
-})
+	})
 
-mt.register_craft({
+	mt.register_craft({
 		type = "fuel",
 		recipe = "craftguide:book",
 		burntime = 3
-})
+	})
 
-mt.register_craft({
+	mt.register_craft({
 		output = "craftguide:sign",
 		type = "shapeless",
 		recipe = {"default:sign_wall_wood"}
-})
+	})
 
-mt.register_craft({
+	mt.register_craft({
 		type = "fuel",
 		recipe = "craftguide:sign",
 		burntime = 10
-})
+	})
+end
 
 if rawget(_G, "sfinv_buttons") then
 	sfinv_buttons.register_button("craftguide", {
@@ -568,7 +764,56 @@ if rawget(_G, "sfinv_buttons") then
 	})
 end
 
-mt.register_alias("xdecor:crafting_guide", "craftguide:book")
+if not progressive_mode then
+	mt.register_chatcommand("craft", {
+		description = S("Show recipe(s) of the pointed node"),
+		func = function(name)
+			local player = mt.get_player_by_name(name)
+			local ppos   = player:get_pos()
+			local dir    = player:get_look_dir()
+			local eye_h  = {x = ppos.x, y = ppos.y + 1.625, z = ppos.z}
+			local node_name
+
+			for i = 1, 10 do
+				local look_at = vector_add(eye_h, vector_mul(dir, i))
+				local node = mt.get_node(look_at)
+
+				if node.name ~= "air" then
+					node_name = node.name
+					break
+				end
+			end
+
+			if not node_name then
+				return false, colorize("[craftguide] ") .. S("No node pointed")
+			elseif not datas[name] then
+				init_datas(player, name)
+			end
+
+			local data    = datas[name]
+			local is_fuel = get_fueltime(node_name) > 0
+			local recipes = get_recipes(node_name) or {}
+			recipes = add_custom_recipes(node_name, recipes)
+
+			if not next(recipes) and not is_fuel then
+				return false, colorize("[craftguide] ") ..
+					S("No recipe for this node:") .. " " ..
+					colorize(node_name)
+			end
+
+			data.show_usage   = nil
+			data.filter       = ""
+			data.item         = node_name
+			data.pagenum      = 1
+			data.rnum         = 1
+			data.recipes_item = recipes
+			data.items        = datas.init_items
+			data.fuel         = is_fuel
+
+			return true, show_fs(player, name)
+		end,
+	})
+end
 
 --[[ Custom recipes (>3x3) test code
 

settingtypes.txt

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