craftguide = { custom_crafts = {}, craft_types = {}, } local mt = minetest local player_data = {} local init_items = {} local searches = {} local progressive_mode = mt.settings:get_bool("craftguide_progressive_mode") local sfinv_only = mt.settings:get_bool("craftguide_sfinv_only") local reg_items = mt.registered_items local get_result = mt.get_craft_result local show_formspec = mt.show_formspec -- Intllib local S = dofile(mt.get_modpath("craftguide") .. "/intllib.lua") -- 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, concat = table.remove, table.maxn, table.sort, table.concat local vector_add, vector_mul = vector.add, vector.multiply local min, max, floor, ceil = math.min, math.max, math.floor, math.ceil local fmt = string.format local DEFAULT_SIZE = 10 local MIN_LIMIT, MAX_LIMIT = 10, 12 DEFAULT_SIZE = min(MAX_LIMIT, max(MIN_LIMIT, DEFAULT_SIZE)) local GRID_LIMIT = 5 local group_stereotypes = { wool = "wool:white", dye = "dye:white", water_bucket = "bucket:bucket_water", vessel = "vessels:glass_bottle", coal = "default:coal_lump", flower = "flowers:dandelion_yellow", mesecon_conductor_craftable = "mesecons:wire_00000000_off", } local function __func() return debug.getinfo(2, "n").name end function craftguide.register_craft_type(name, def) local func = "craftguide." .. __func() .. "(): " assert(name, func .. "'name' field missing") assert(def.description, func .. "'description' field missing") assert(def.icon, func .. "'icon' field missing") 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", }) function craftguide.register_craft(def) local func = "craftguide." .. __func() .. "(): " assert(def.type, func .. "'type' field missing") assert(def.width, func .. "'width' field missing") assert(def.output, func .. "'output' field missing") assert(def.items, func .. "'items' field missing") craftguide.custom_crafts[#craftguide.custom_crafts + 1] = def end craftguide.register_craft({ type = "digging", width = 1, output = "default:cobble", items = {"default:stone"}, }) local function get_recipe(output) local recipe = mt.get_craft_recipe(output) if recipe.items then return recipe end for i = 1, #craftguide.custom_crafts do local custom_craft = craftguide.custom_crafts[i] if custom_craft.output:match("%S*") == output then return custom_craft end end return {} end local function get_recipes(output) local recipes = mt.get_all_craft_recipes(output) or {} for i = 1, #craftguide.custom_crafts do local custom_craft = craftguide.custom_crafts[i] if custom_craft.output:match("%S*") == output then recipes[#recipes + 1] = custom_craft end end return recipes end local color_codes = { red = "#FF0000", yellow = "#FFFF00", } local function colorize(str, color) color = color or "yellow" return mt.colorize(color_codes[color], str) end local function get_fueltime(item) return get_result({method = "fuel", width = 1, items = {item}}).time end local function reset_data(data) data.show_usage = nil data.filter = "" data.input = nil data.pagenum = 1 data.rnum = 1 data.items = progressive_mode and data.init_filter_items or init_items end local function in_table(T) for i = 1, #T do if T[i] then return true end end end local function group_to_items(group) local items_with_group, c = {}, 0 for name, def in pairs(reg_items) do if def.groups[group:sub(7)] then c = c + 1 items_with_group[c] = name end end return items_with_group end local function item_in_inv(inv, item) return inv:contains_item("main", item) end local function extract_groups(str) return str:sub(7):split(",") end local function item_has_groups(item_groups, groups) for i = 1, #groups do local group = groups[i] if not item_groups[group] then return end end return true end local function groups_to_item(groups) if #groups == 1 then local group = groups[1] if group_stereotypes[group] then return group_stereotypes[group] elseif reg_items["default:" .. group] then return "default:" .. group end end for name, def in pairs(reg_items) do if item_has_groups(def.groups, groups) then return name end end return "" end local function 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 local function get_recipe_fs(iX, iY, xoffset, recipe_num, recipes, show_usage) if not recipes[1] then return "" end local fs = {} fs[#fs + 1] = fmt("button[%f,%f;%f,%f;%s;%s %u %s %u]", 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"), recipe_num, S("of"), #recipes) 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, btn_size, s_btn_size = 0, 1.1 if width > GRID_LIMIT or rows > GRID_LIMIT then fs[#fs + 1] = fmt("label[%f,%f;%s]", (iX / 2) - 2, iY + 2.2, S("Recipe is too big to be displayed (@1x@2)", width, rows)) return concat(fs) end for i, item 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 width > 3 or rows > 3 then btn_size = width > 3 and 3 / width or 3 / rows s_btn_size = btn_size X = btn_size * (i % width) + xoffset - 2.65 Y = btn_size * floor((i - 1) / width) + (iY + 3) - min(2, rows) end if X > rightest then rightest = X end local groups if item:sub(1,6) == "group:" then groups = extract_groups(item) item = groups_to_item(groups) end local label = groups and "\nG" or "" local tltp = get_tooltip(item, recipe_type, cooktime, groups) fs[#fs + 1] = fmt("item_image_button[%f,%f;%f,%f;%s;%s;%s]", X, Y + (sfinv_only and 0.7 or 0.2), btn_size, btn_size, item, item:match("%S*"), label) fs[#fs + 1] = tltp end local custom_recipe = craftguide.craft_types[recipe_type] if recipe_type == "cooking" or custom_recipe or (recipe_type == "normal" and width == 0) then local icon = recipe_type == "cooking" and "furnace" or "shapeless" fs[#fs + 1] = fmt("image[%f,%f;%f,%f;%s]", rightest + 1.2, iY + (sfinv_only and 2.2 or 1.7), 0.5, 0.5, custom_recipe and custom_recipe.icon or "craftguide_" .. icon .. ".png^[resize:16x16") fs[#fs + 1] = fmt("tooltip[%f,%f;%f,%f;%s]", rightest + 1.2, iY + (sfinv_only and 2.2 or 1.7), 0.5, 0.5, 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 arrow_X = rightest + (s_btn_size or 1.1) local output_X = arrow_X + 0.9 fs[#fs + 1] = fmt("image[%f,%f;%f,%f;%s]", arrow_X, iY + (sfinv_only and 2.85 or 2.35), 0.9, 0.7, "craftguide_arrow.png") if output == "BURN" then fs[#fs + 1] = fmt("image[%f,%f;%f,%f;%s]", output_X, iY + (sfinv_only and 2.68 or 2.18), 1.1, 1.1, "craftguide_fire.png") else fs[#fs + 1] = fmt("item_image_button[%f,%f;%f,%f;%s;%s;]", output_X, iY + (sfinv_only and 2.7 or 2.2), 1.1, 1.1, output, output_s) end fs[#fs + 1] = get_tooltip(output_s) local output_is_fuel = get_fueltime(output) > 0 if output_is_fuel then fs[#fs + 1] = fmt("image[%f,%f;%f,%f;%s]", output_X + 1, iY + (sfinv_only and 2.83 or 2.33), 0.6, 0.4, "craftguide_arrow.png") fs[#fs + 1] = fmt("image[%f,%f;%f,%f;%s]", output_X + 1.6, iY + (sfinv_only and 2.68 or 2.18), 0.6, 0.6, "craftguide_fire.png") end return concat(fs) end local function get_formspec(player_name) local data = player_data[player_name] local iY = sfinv_only and 4 or data.iX - 5 local ipp = data.iX * iY if not data.items then data.items = init_items end data.pagemax = max(1, ceil(#data.items / ipp)) local fs = {} if not sfinv_only then fs[#fs + 1] = "size[" .. (data.iX - 0.35) .. "," .. (iY + 4) .. ";]" fs[#fs + 1] = "tooltip[size_inc;" .. S("Increase window size") .. "]" fs[#fs + 1] = "tooltip[size_dec;" .. S("Decrease window size") .. "]" fs[#fs + 1] = "image_button[" .. (data.iX * 0.47) .. ",0.12;0.8,0.8;craftguide_zoomin_icon.png;size_inc;]" fs[#fs + 1] = "image_button[" .. ((data.iX * 0.47) + 0.6) .. ",0.12;0.8,0.8;craftguide_zoomout_icon.png;size_dec;]" end fs[#fs + 1] = [[ 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] ]] fs[#fs + 1] = "tooltip[search;" .. S("Search") .. "]" fs[#fs + 1] = "tooltip[clear;" .. S("Reset") .. "]" fs[#fs + 1] = "tooltip[prev;" .. S("Previous page") .. "]" fs[#fs + 1] = "tooltip[next;" .. S("Next page") .. "]" fs[#fs + 1] = "image_button[" .. (data.iX - (sfinv_only and 2.6 or 3.1)) .. ",0.12;0.8,0.8;craftguide_prev_icon.png;prev;]" fs[#fs + 1] = "label[" .. (data.iX - (sfinv_only and 1.7 or 2.2)) .. ",0.22;" .. colorize(data.pagenum) .. " / " .. data.pagemax .. "]" fs[#fs + 1] = "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;]" fs[#fs + 1] = "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 fs[#fs + 1] = fmt("label[%f,%f;%s]", (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 fs[#fs + 1] = fmt("item_image_button[%f,%f;%f,%f;%s;%s;]", X - (sfinv_only and 0 or (X * 0.05)), Y, 1.1, 1.1, name, name) end if data.input and reg_items[data.input] then local usage = data.show_usage fs[#fs + 1] = get_recipe_fs(data.iX, iY, xoffset, data.rnum, (usage and data.usages or data.recipes_item), usage) end fs = concat(fs) data.formspec = fs if sfinv_only then return fs else show_formspec(player_name, "craftguide", fs) 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) local recipes = recipes_f or get_recipes(item_name) local show_item_recipes = {} for i = 1, #recipes do show_item_recipes[i] = true for _, item in pairs(recipes[i].items) do local group_in_inv = false if item:sub(1,6) == "group:" then local groups = group_to_items(item) for j = 1, #groups do if item_in_inv(inv, groups[j]) then group_in_inv = true end end end if not group_in_inv and not item_in_inv(inv, item) then show_item_recipes[i] = false end end end for i = #show_item_recipes, 1, -1 do if not show_item_recipes[i] then remove(recipes, i) end end return recipes, in_table(show_item_recipes) end local function get_filter_items(data, player) local filter = data.filter if searches[filter] then data.items = searches[filter] return end local items_list = progressive_mode and data.init_filter_items or init_items local inv = player:get_inventory() local filtered_list, c = {}, 0 for i = 1, #items_list do local item = items_list[i] local item_desc = reg_items[item].description:lower() if filter ~= "" then if item:find(filter, 1, true) or item_desc:find(filter, 1, true) then c = c + 1 filtered_list[c] = item end elseif progressive_mode then local _, has_item = recipe_in_inv(inv, item) if has_item then c = c + 1 filtered_list[c] = item end end end if progressive_mode then if not data.items then data.init_filter_items = filtered_list end elseif filter ~= "" then -- Cache the results only if searched 2 times if searches[filter] == nil then searches[filter] = false else searches[filter] = filtered_list end end data.items = filtered_list end local function init_data(user, name) player_data[name] = {filter = "", pagenum = 1, iX = sfinv_only and 8 or DEFAULT_SIZE} if progressive_mode then get_filter_items(player_data[name], user) end end local function get_init_items() local c = 0 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 c = c + 1 init_items[c] = name end end sort(init_items) end mt.register_on_mods_loaded(get_init_items) local function item_in_recipe(item, recipe) local item_groups = reg_items[item].groups for _, recipe_item in pairs(recipe.items) do if recipe_item == item then return true elseif recipe_item:sub(1,6) == "group:" then local groups = extract_groups(recipe_item) if item_has_groups(item_groups, groups) then return true end end end end local function get_item_usages(item) local usages = {} for name, def in pairs(reg_items) do if not (def.groups.not_in_craft_guide == 1 or 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] if item_in_recipe(item, recipe) then usages[#usages + 1] = recipe end end end end return usages end local function get_fields(player, ...) 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 = player_data[player_name] if fields.clear then reset_data(data) show_fs(player, player_name) elseif fields.alternate then if #(data.show_usage and data.usages or data.recipes_item) == 1 then return end local next_i if data.show_usage then next_i = data.usages[data.rnum + 1] else next_i = data.recipes_item[data.rnum + 1] end data.rnum = next_i and data.rnum + 1 or 1 show_fs(player, player_name) elseif (fields.key_enter_field == "filter" or fields.search) and fields.filter ~= "" then local fltr = fields.filter:lower() if data.filter == fltr then return end data.filter = fltr data.pagenum = 1 get_filter_items(data, player) show_fs(player, player_name) elseif fields.prev or fields.next then data.pagenum = data.pagenum - (fields.prev and 1 or -1) if data.pagenum > data.pagemax then data.pagenum = 1 elseif data.pagenum == 0 then data.pagenum = data.pagemax end 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) show_fs(player, player_name) else for item in pairs(fields) do if item:find(":") then local is_fuel = get_fueltime(item) > 0 local recipes = get_recipes(item) local no_recipes = not next(recipes) if no_recipes and not is_fuel then return end if item ~= data.input then data.show_usage = nil else data.show_usage = not data.show_usage end if not progressive_mode and is_fuel and no_recipes then data.show_usage = true end if data.show_usage then data.usages = get_item_usages(item) if is_fuel then data.usages[#data.usages + 1] = { width = 1, type = "normal", items = {item}, output = "BURN", } end if not next(data.usages) then data.show_usage = nil end elseif progressive_mode then local inv = player:get_inventory() local has_item recipes, has_item = recipe_in_inv(inv, item, recipes) if not has_item then return end end data.input = item data.recipes_item = recipes data.rnum = 1 show_fs(player, player_name) end end end end if sfinv_only then sfinv.register_page("craftguide:craftguide", { title = "Craft Guide", get = function(self, player, context) local player_name = player:get_player_name() return sfinv.make_formspec( player, context, get_formspec(player_name) ) end, on_enter = function(self, player, context) local player_name = player:get_player_name() local data = player_data[player_name] if progressive_mode or not data then init_data(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) local function on_use(itemstack, user) local player_name = user:get_player_name() local data = player_data[player_name] if progressive_mode or not data then init_data(user, player_name) get_formspec(player_name) else show_formspec(player_name, "craftguide", data.formspec) end end mt.register_craftitem("craftguide:book", { description = S("Crafting Guide"), inventory_image = "craftguide_book.png", wield_image = "craftguide_book.png", stack_max = 1, groups = {book = 1}, on_use = function(itemstack, user) on_use(itemstack, user) end }) mt.register_node("craftguide:sign", { description = S("Crafting Guide Sign"), drawtype = "nodebox", tiles = {"craftguide_sign.png"}, inventory_image = "craftguide_sign_inv.png", wield_image = "craftguide_sign_inv.png", paramtype = "light", paramtype2 = "wallmounted", sunlight_propagates = true, groups = {wood = 1, oddly_breakable_by_hand = 1, flammable = 3}, node_box = { type = "wallmounted", wall_top = {-0.4375, 0.4375, -0.3125, 0.4375, 0.5, 0.3125}, wall_bottom = {-0.4375, -0.5, -0.3125, 0.4375, -0.4375, 0.3125}, wall_side = {-0.5, -0.3125, -0.4375, -0.4375, 0.3125, 0.4375} }, on_construct = function(pos) local meta = mt.get_meta(pos) meta:set_string("infotext", S("Crafting Guide Sign")) end, on_rightclick = function(pos, node, user, itemstack) on_use(itemstack, user) end }) mt.register_craft({ output = "craftguide:book", type = "shapeless", recipe = {"default:book"} }) mt.register_craft({ type = "fuel", recipe = "craftguide:book", burntime = 3 }) mt.register_craft({ output = "craftguide:sign", type = "shapeless", recipe = {"default:sign_wall_wood"} }) mt.register_craft({ type = "fuel", recipe = "craftguide:sign", burntime = 10 }) 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"), image = "craftguide_book.png", action = function(player) on_use(nil, player) end, }) end end 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] ", "red") .. S("No node pointed") elseif not player_data[name] then init_data(player, name) end local data = player_data[name] reset_data(data) local is_fuel = get_fueltime(node_name) > 0 local recipes = get_recipes(node_name) local no_recipes = not next(recipes) if no_recipes and not is_fuel then return false, colorize("[craftguide] ", "red") .. S("No recipe for this node:") .. " " .. colorize(node_name) end if is_fuel and no_recipes then data.usages = get_item_usages(node_name) if is_fuel then data.usages[#data.usages + 1] = { width = 1, type = "normal", items = {node_name}, output = "BURN", } end if next(data.usages) then data.show_usage = true end end data.input = node_name data.recipes_item = recipes return true, show_fs(player, name) end, }) end --[[ Custom recipes (>3x3) test code mt.register_craftitem("craftguide:custom_recipe_test", { description = "Custom Recipe Test", }) local cr = {} for x = 1, 6 do cr[x] = {} for i = 1, 10 - x do cr[x][i] = {} for j = 1, 10 - x do cr[x][i][j] = "group:wood" end end mt.register_craft({ output = "craftguide:custom_recipe_test", recipe = cr[x] }) end ]]