Add debug_mode setting + cleanup

.github/workflows/luacheck.yml

@@ -0,0 +1,21 @@
+name: Luacheck
+
+on: [push, pull_request]
+
+jobs:
+
+  luacheck:
+    runs-on: ubuntu-20.04
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Setup ‘lua’
+      uses: leafo/gh-actions-lua@v8
+      with:
+        luaVersion: 5.1
+    - name: Setup ‘luarocks’
+      uses: leafo/gh-actions-luarocks@v4
+    - name: Setup ‘luacheck’
+      run: luarocks install luacheck
+    - name: Run ‘luacheck’ linter
+      run: lua luacheck.lua .

README.md

@@ -1,6 +1,6 @@
-# i3
+![logo](https://user-images.githubusercontent.com/7883281/145490041-d91d6bd6-a654-438d-b208-4d5736845ab7.png)
 
-[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs) [![GitHub Release](https://img.shields.io/github/release/minetest-mods/i3.svg?style=flat)]() [![ContentDB](https://content.minetest.net/packages/jp/i3/shields/downloads/)](https://content.minetest.net/packages/jp/i3/) [![PayPal](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.me/jpg84240)
+[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs) [![GitHub Release](https://img.shields.io/github/release/minetest-mods/i3.svg?style=flat)]() ![workflow](https://github.com/minetest-mods/i3/actions/workflows/luacheck.yml/badge.svg) [![ContentDB](https://content.minetest.net/packages/jp/i3/shields/downloads/)](https://content.minetest.net/packages/jp/i3/) [![PayPal](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.me/jpg84240)
 
 #### **`i3`** is a next-generation inventory for Minetest.
 

init.lua

@@ -1,26 +1,42 @@
+print[[
+
+	Powered by
+
+	██╗██████╗
+	██║╚════██╗
+	██║ █████╔╝
+	██║ ╚═══██╗
+	██║██████╔╝
+	╚═╝╚═════╝
+]]
+
 local modpath = core.get_modpath"i3"
+local http = core.request_http_api()
 local _loadfile = dofile(modpath .. "/src/operators.lua")
 
 local function lf(path)
-	return _loadfile(modpath .. path)
+	return assert(_loadfile(modpath .. path))
 end
 
 i3 = {
-	modules = {},
+	settings = {
-	http = core.request_http_api(),
+		debug_mode = false,
+		max_favs = 6,
+		min_fs_version = 4,
+		item_btn_size = 1.1,
+		drop_bag_on_die = true,
+		save_interval = 600, -- Player data save interval (in seconds)
 
-	MAX_FAVS = 6,
+		hud_speed = 1,
-	INV_SIZE = 4*9,
+		hud_timer_max = 1.5,
-	HOTBAR_LEN = 9,
-	ITEM_BTN_SIZE = 1.1,
-	DROP_BAG_ON_DIE = true,
-	MIN_FORMSPEC_VERSION = 4,
-	SAVE_INTERVAL = 600, -- Player data save interval (in seconds)
 
-	HUD_TIMER_MAX = 1.5,
+		damage_enabled   = core.settings:get_bool"enable_damage",
-	HUD_SPEED = 1,
+		progressive_mode = core.settings:get_bool"i3_progressive_mode",
+		legacy_inventory = core.settings:get_bool"i3_legacy_inventory",
+		item_compression = core.settings:get_bool("i3_item_compression", true),
+	},
 
-	SUBCAT = {
+	categories = {
 		"bag",
 		"armor",
 		"skins",
@@ -28,7 +44,7 @@ i3 = {
 		"waypoints",
 	},
 
-	META_SAVES = {
+	saves = { -- Metadata to save
 		bag = true,
 		home = true,
 		waypoints = true,
@@ -37,21 +53,6 @@ i3 = {
 		known_recipes = true,
 	},
 
-	-- Caches
-	init_items = {},
-	fuel_cache = {},
-	usages_cache = {},
-	recipes_cache = {},
-	cubes = {},
-	plants = {},
-
-	tabs = {},
-	craft_types = {},
-
-	recipe_filters = {},
-	search_filters = {},
-	sorting_methods = {},
-
 	files = {
 		api = lf"/src/api.lua",
 		bags = lf"/src/bags.lua",
@@ -66,21 +67,30 @@ i3 = {
 		model_alias = lf"/src/model_aliases.lua",
 		progressive = lf"/src/progressive.lua",
 		styles = lf"/src/styles.lua",
-
-		tests = {
-			tabs = lf"/tests/test_tabs.lua",
-			operators = lf"/tests/test_operators.lua",
-			compression = lf"/tests/test_compression.lua",
-			custom_recipes = lf"/tests/test_custom_recipes.lua",
-		}
 	},
 
-	progressive_mode = core.settings:get_bool"i3_progressive_mode",
+	-- Caches
-	item_compression = core.settings:get_bool("i3_item_compression", true),
+	init_items = {},
+	fuel_cache = {},
+	usages_cache = {},
+	recipes_cache = {},
+
+	tabs = {},
+	cubes = {},
+	plants = {},
+	modules = {},
+	craft_types = {},
+
+	recipe_filters = {},
+	search_filters = {},
+	sorting_methods = {},
 }
 
+i3.settings.hotbar_len = i3.settings.legacy_inventory and 8 or 9
+i3.settings.inv_size   = 4 * i3.settings.hotbar_len
+
 i3.files.common()
-i3.files.api()
+i3.files.api(http)
 i3.files.compress()
 i3.files.groups()
 i3.files.callbacks()
@@ -93,7 +103,7 @@ i3.data = dslz(storage:get_string"data") or {}
 
 local init_bags = i3.files.bags()
 local init_detached = i3.files.detached()
-local fill_caches = i3.files.caches()
+local fill_caches = i3.files.caches(http)
 local init_hud = i3.files.hud()
 
 local function get_lang_code(info)
@@ -105,10 +115,9 @@ local function get_formspec_version(info)
 end
 
 local function outdated(name)
-	local fs = ("size[6.3,1.3]image[0,0;1,1;i3_book.png]label[1,0;%s]button_exit[2.6,0.8;1,1;;OK]"):format(
+	core.show_formspec(name, "i3_outdated",
-		"Your Minetest client is outdated.\nGet the latest version on minetest.net to play the game.")
+		("size[6.5,1.3]image[0,0;1,1;i3_book.png]label[1,0;%s]button_exit[2.6,0.8;1,1;;OK]"):format(
-
+		"Your Minetest client is outdated.\nGet the latest version on minetest.net to play the game."))
-	core.show_formspec(name, "i3_outdated", fs)
 end
 
 if rawget(_G, "armor") then
@@ -178,7 +187,7 @@ local function init_data(player, info)
 	data.fs_version      = info.formspec_version
 
 	local inv = player:get_inventory()
-	inv:set_size("main", i3.INV_SIZE)
+	inv:set_size("main", i3.settings.inv_size)
 
 	core.after(0, set_fs, player)
 end
@@ -188,7 +197,7 @@ local function save_data(player_name)
 
 	for name, v in pairs(_data) do
 	for dat in pairs(v) do
-		if not i3.META_SAVES[dat] then
+		if not i3.saves[dat] then
 			_data[name][dat] = nil
 
 			if player_name and i3.data[player_name] then
@@ -210,7 +219,7 @@ core.register_on_joinplayer(function(player)
 	local name = player:get_player_name()
 	local info = core.get_player_information and core.get_player_information(name)
 
-	if not info or get_formspec_version(info) < i3.MIN_FORMSPEC_VERSION then
+	if not info or get_formspec_version(info) < i3.settings.min_fs_version then
 		return outdated(name)
 	end
 
@@ -229,16 +238,18 @@ core.register_on_shutdown(save_data)
 
 local function routine()
 	save_data()
-	core.after(i3.SAVE_INTERVAL, routine)
+	core.after(i3.settings.save_interval, routine)
 end
 
-core.after(i3.SAVE_INTERVAL, routine)
+core.after(i3.settings.save_interval, routine)
 
-if i3.progressive_mode then
+if i3.settings.progressive_mode then
 	i3.files.progressive()
 end
 
---i3.files.tests.tabs()
+if i3.settings.debug_mode then
---i3.files.tests.operators()
+	lf("/tests/test_tabs.lua")()
---i3.files.tests.compression()
+	lf("/tests/test_operators.lua")()
---i3.files.tests.custom_recipes()
+	lf("/tests/test_compression.lua")()
+	lf("/tests/test_custom_recipes.lua")()
+end

settingtypes.txt

@@ -2,4 +2,7 @@
 i3_progressive_mode    (Learn crafting recipes progressively)    bool false
 
 # Regroup the items of the same type in the item list.
-i3_item_compression    (Regroup items of the same type)    bool true
+i3_item_compression    (Regroup items of the same type)          bool true
+
+# Set the inventory size to common chests size (8*4).
+i3_legacy_inventory    (Legacy inventory size)                   bool false

src/api.lua

@@ -1,3 +1,4 @@
+local http = ...
 local make_fs = i3.files.gui()
 
 IMPORT("gmatch", "split")
@@ -21,14 +22,8 @@ end
 function i3.register_craft(def)
 	local width, c = 0, 0
 
-	if true_str(def.url) then
+	if http and true_str(def.url) then
-		if not i3.http then
+		http.fetch({url = def.url}, function(result)
-			return err(fmt([[i3.register_craft(): Unable to reach %s.
-				No HTTP support for this mod: add it to the `secure.http_mods` or
-				`secure.trusted_mods` setting.]], def.url))
-		end
-
-		i3.http.fetch({url = def.url}, function(result)
 			if result.succeeded then
 				local t = core.parse_json(result.data)
 				if is_table(t) then
@@ -56,7 +51,7 @@ function i3.register_craft(def)
 		def.result = nil
 	end
 
-	if not true_str(def.output) then
+	if not true_str(def.output) and not def.url then
 		return err "i3.register_craft: output missing"
 	end
 
@@ -74,9 +69,7 @@ function i3.register_craft(def)
 		end
 
 		local cp = copy(def.grid)
-		sort(cp, function(a, b)
+		sort(cp, function(a, b) return #a > #b end)
-			return #a > #b
-		end)
 
 		width = #cp[1]
 
@@ -91,26 +84,29 @@ function i3.register_craft(def)
 			def.items[c] = def.key[symbol]
 		end
 	else
-		local items, len = def.items, #def.items
+		local items = copy(def.items)
+		local lines = {}
 		def.items = {}
 
-		for i = 1, len do
+		for i = 1, #items do
-			local rlen = #split(items[i], ",")
+			lines[i] = split(items[i], ",", true)
 
-			if rlen > width then
+			if #lines[i] > width then
-				width = rlen
+				width = #lines[i]
 			end
 		end
 
-		for i = 1, len do
+		for i = 1, #items do
-			while #split(items[i], ",") < width do
+			while #lines[i] < width do
-				items[i] = fmt("%s,", items[i])
+				insert(lines[i], items[i])
 			end
 		end
 
-		for name in gmatch(concat(items, ","), "[%s%w_:]+") do
+		for _, line in ipairs(lines) do
-			c++
+			for _, v in ipairs(line) do
-			def.items[c] = clean_name(name)
+				c++
+				def.items[c] = clean_name(v)
+			end
 		end
 	end
 
@@ -154,10 +150,11 @@ function i3.add_search_filter(name, f)
 end
 
 function i3.get_recipes(item)
-	return {
+	item = core.registered_aliases[item] or item
-		recipes = i3.recipes_cache[item],
+	local recipes = i3.recipes_cache[item]
-		usages = i3.usages_cache[item]
+	local usages = i3.usages_cache[item]
-	}
+
+	return {recipes = recipes, usages = usages}
 end
 
 function i3.set_fs(player)

src/caches.lua

@@ -1,4 +1,6 @@
+local PNG = i3.files.styles()
 local replacements = {fuel = {}}
+local http = ...
 
 IMPORT("maxn", "copy", "insert", "sort", "match", "sub")
 IMPORT("is_group", "extract_groups", "item_has_groups", "groups_to_items")
@@ -269,13 +271,13 @@ local function init_recipes()
 	resolve_aliases(_select)
 	sort(i3.init_items)
 
-	if i3.http and true_str(i3.export_url) then
+	if http and true_str(i3.export_url) then
 		local post_data = {
 			recipes = i3.recipes_cache,
 			usages  = i3.usages_cache,
 		}
 
-		i3.http.fetch_async {
+		http.fetch_async {
 			url = i3.export_url,
 			post_data = core.write_json(post_data),
 		}
@@ -284,29 +286,25 @@ end
 
 local function get_cube(tiles)
 	if not true_table(tiles) then
-		return "i3_blank.png"
+		return PNG.blank
 	end
 
-	local t = copy(tiles)
+	local top = tiles[1] or PNG.blank
-	local texture
+	if is_table(top) then
-
+		top = top.name or top.image
-	for k, v in pairs(t) do
-		if type(v) == "table" then
-			t[k] = v.name
-		end
 	end
 
-	-- Tiles: up, down, right, left, back, front
+	local left = tiles[3] or top or PNG.blank
-	-- Inventory cube: up, front, right
+	if is_table(left) then
-	if #t <= 2 then
+		left = left.name or left.image
-		texture = draw_cube(t[1], t[1], t[1])
-	elseif #t <= 5 then
-		texture = draw_cube(t[1], t[3], t[3])
-	else -- Full tileset
-		texture = draw_cube(t[1], t[6], t[3])
 	end
 
-	return texture
+	local right = tiles[5] or left or PNG.blank
+	if is_table(right) then
+		right = right.name or right.image
+	end
+
+	return draw_cube(top, left, right)
 end
 
 local function init_cubes()

src/callbacks.lua

@@ -56,7 +56,7 @@ i3.new_tab("inventory", {
 
 		for field in pairs(fields) do
 			if sub(field, 1, 4) == "btn_" then
-				data.subcat = indexof(i3.SUBCAT, sub(field, 5))
+				data.subcat = indexof(i3.categories, sub(field, 5))
 				break
 
 			elseif sub(field, 1, 3) == "cb_" then
@@ -229,6 +229,9 @@ i3.new_tab("inventory", {
 			})
 
 			data.scrbar_inv += 1000
+
+		elseif fields.hide_debug_grid then
+			data.hide_debug_grid = not data.hide_debug_grid
 		end
 
 		return set_fs(player)
@@ -376,13 +379,12 @@ local function rcp_fields(player, data, fields)
 		data.scrbar_usg = 1
 
 	elseif fields.fav then
-		local fav, i = is_fav(data.favs, data.query_item)
+		local fav = is_fav(data)
-		local total = #data.favs
 
-		if total < i3.MAX_FAVS and not fav then
+		if #data.favs < i3.settings.max_favs and not fav then
-			data.favs[total + 1] = data.query_item
+			insert(data.favs, data.query_item)
 		elseif fav then
-			remove(data.favs, i)
+			remove(data.favs, fav)
 		end
 
 	elseif fields.export_rcp or fields.export_usg then
@@ -423,7 +425,8 @@ core.register_on_player_receive_fields(function(player, formname, fields)
 	local name = player:get_player_name()
 
 	if formname == "i3_outdated" then
-		return false, core.kick_player(name, S"Come back when your client is up-to-date.")
+		return false, core.kick_player(name,
+			S"Come back when your Minetest client is up-to-date (www.minetest.net).")
 	elseif formname ~= "" then
 		return false
 	end
@@ -479,7 +482,7 @@ core.register_on_dieplayer(function(player)
 	local data = i3.data[name]
 	if not data then return end
 
-	if i3.DROP_BAG_ON_DIE then
+	if i3.settings.drop_bag_on_die then
 		local bagstack = ItemStack(data.bag)
 		spawn_item(player, bagstack)
 	end

src/common.lua

@@ -1,5 +1,6 @@
 local ItemStack = ItemStack
 local loadstring = loadstring
+local reg_items = core.registered_items
 local translate = core.get_translated_string
 local vec_new, vec_add, vec_mul = vector.new, vector.add, vector.multiply
 local sort, concat, insert = table.sort, table.concat, table.insert
@@ -99,7 +100,7 @@ local function search(data)
 
 	for i = 1, #data.items_raw do
 		local item = data.items_raw[i]
-		local def = core.registered_items[item]
+		local def = reg_items[item]
 		local desc = lower(translate(data.lang_code, def and def.description)) or ""
 		local search_in = fmt("%s %s", item, desc)
 		local temp, j, to_add = {}, 1
@@ -250,7 +251,7 @@ local function groups_to_items(groups, get_all)
 	if not get_all and #groups == 1 then
 		local group = groups[1]
 		local stereotype = i3.group_stereotypes[group]
-		local def = core.registered_items[stereotype]
+		local def = reg_items[stereotype]
 
 		if valid_item(def) then
 			return stereotype
@@ -259,7 +260,7 @@ local function groups_to_items(groups, get_all)
 
 	local names = {}
 
-	for name, def in pairs(core.registered_items) do
+	for name, def in pairs(reg_items) do
 		if valid_item(def) and item_has_groups(def.groups, groups) then
 			if get_all then
 				insert(names, name)
@@ -281,24 +282,19 @@ local function apply_recipe_filters(recipes, player)
 end
 
 local function compression_active(data)
-	return i3.item_compression and not next(i3.recipe_filters) and data.filter == ""
+	return i3.settings.item_compression and not next(i3.recipe_filters) and data.filter == ""
 end
 
 local function compressible(item, data)
 	return compression_active(data) and i3.compress_groups[item]
 end
 
-local function is_fav(favs, query_item)
+local function is_fav(data)
-	local fav, i
+	for i = 1, #data.favs do
-	for j = 1, #favs do
+		if data.favs[i] == data.query_item then
-		if favs[j] == query_item then
+			return i
-			fav = true
-			i = j
-			break
 		end
 	end
-
-	return fav, i
 end
 
 local function sort_by_category(data)
@@ -340,9 +336,9 @@ local function spawn_item(player, stack)
 end
 
 local function get_recipes(player, item)
-	local clean_item = core.registered_aliases[item] or item
+	item = core.registered_aliases[item] or item
-	local recipes = i3.recipes_cache[clean_item]
+	local recipes = i3.recipes_cache[item]
-	local usages = i3.usages_cache[clean_item]
+	local usages = i3.usages_cache[item]
 
 	if recipes then
 		recipes = apply_recipe_filters(recipes, player)
@@ -351,7 +347,6 @@ local function get_recipes(player, item)
 	local no_recipes = not recipes or #recipes == 0
 	if no_recipes and not usages then return end
 	usages = apply_recipe_filters(usages, player)
-
 	local no_usages = not usages or #usages == 0
 
 	return not no_recipes and recipes or nil,
@@ -539,7 +534,7 @@ local function sort_inventory(player, data)
 	local inv = player:get_inventory()
 	local list = inv:get_list"main"
 	local size = inv:get_size"main"
-	local start_i = data.ignore_hotbar and 10 or 1
+	local start_i = data.ignore_hotbar and (i3.settings.hotbar_len + 1) or 1
 
 	if true_table(data.drop_items) then
 		list = drop_items(player, inv, list, start_i, data.drop_items)
@@ -584,6 +579,7 @@ local function get_detached_inv(name, player_name)
 	}
 end
 
+-- Much faster implementation of `unpack`
 local function createunpack(n)
 	local ret = {"local t = ... return "}
 

src/gui.lua

@@ -1,4 +1,5 @@
-local damage_enabled = core.settings:get_bool"enable_damage"
+local damage_enabled = i3.settings.damage_enabled
+local hotbar_len = i3.settings.hotbar_len
 
 local model_aliases = i3.files.model_alias()
 local PNG, styles, fs_elements, colors = i3.files.styles()
@@ -6,9 +7,9 @@ local PNG, styles, fs_elements, colors = i3.files.styles()
 local sprintf = string.format
 local VoxelArea, VoxelManip = VoxelArea, VoxelManip
 
-IMPORT("clr", "ESC", "check_privs")
 IMPORT("find", "match", "sub", "upper")
 IMPORT("vec_new", "vec_sub", "vec_round")
+IMPORT("clr", "ESC", "msg", "check_privs")
 IMPORT("min", "max", "floor", "ceil", "round")
 IMPORT("reg_items", "reg_tools", "reg_entities")
 IMPORT("get_bag_description", "get_detached_inv")
@@ -16,7 +17,7 @@ IMPORT("S", "ES", "translate", "ItemStack", "toupper")
 IMPORT("groups_to_items", "compression_active", "compressible")
 IMPORT("true_str", "is_fav", "is_num", "get_group", "str_to_pos")
 IMPORT("maxn", "sort", "concat", "copy", "insert", "remove", "unpack")
-IMPORT("get_sorting_idx", "is_group", "extract_groups", "item_has_groups")
+IMPORT("get_sorting_idx", "is_group", "extract_groups", "item_has_groups", "get_recipes")
 
 local function fmt(elem, ...)
 	if not fs_elements[elem] then
@@ -122,20 +123,22 @@ local function get_stack_max(inv, data, is_recipe, rcp)
 end
 
 local function get_inv_slots(fs)
-	local inv_x, inv_y, size, spacing = 0.22, 6.9, 1, 0.1
+	local inv_x = i3.settings.legacy_inventory and 0.75 or 0.22
+	local inv_y = 6.9
+	local size, spacing = 1, 0.1
 
 	fs"style_type[box;colors=#77777710,#77777710,#777,#777]"
 
-	for i = 0, i3.HOTBAR_LEN - 1 do
+	for i = 0, hotbar_len - 1 do
 		fs("box", i * size + inv_x + (i * spacing), inv_y, size, size, "")
 	end
 
 	fs(fmt("style_type[list;size=%f;spacing=%f]", size, spacing),
-	   fmt("list[current_player;main;%f,%f;%u,1;]", inv_x, inv_y, i3.HOTBAR_LEN))
+	   fmt("list[current_player;main;%f,%f;%u,1;]", inv_x, inv_y, hotbar_len))
 
 	fs(fmt("style_type[list;size=%f;spacing=%f]", size, spacing),
 	   fmt("list[current_player;main;%f,%f;%u,%u;%u]", inv_x, inv_y + 1.15,
-		i3.HOTBAR_LEN, i3.INV_SIZE / i3.HOTBAR_LEN, i3.HOTBAR_LEN),
+		hotbar_len, i3.settings.inv_size / hotbar_len, hotbar_len),
 	   "style_type[list;size=1;spacing=0.15]")
 
 	fs"listring[current_player;craft]listring[current_player;main]"
@@ -219,16 +222,26 @@ local function get_award_list(data, fs, ctn_len, yextra, award_list, awards_unlo
 	end
 end
 
-local function get_isometric_view(fs, pos, X, Y)
+local function get_isometric_view(fs, pos, X, Y, t, cubes, depth, high)
-	pos = vec_round(pos)
+	pos   = vec_round(pos)
-	local width = 8
+	cubes = cubes or 0
+	depth = depth or -1
+	high  = high or math.huge
 
-	local pos1 = vec_new(pos.x - width, pos.y - 1, pos.z - width)
+	t = t or {}
-	local pos2 = vec_new(pos.x + width, pos.y + 3, pos.z + width)
+	t[depth] = {}
-	core.emerge_area(pos1, pos2)
+
+	local width = 8
+	local base_height = 4
+	local base_depth = depth == -1
+	local max_depth = -7
+	local height = base_depth and (base_height - 1) or depth
+
+	local pos1 = vec_new(pos.x - width, pos.y + depth, pos.z - width)
+	local pos2 = vec_new(pos.x + width, pos.y + height, pos.z + width)
 
 	local vm = VoxelManip(pos1, pos2)
-	local emin, emax = vm:read_from_map(pos1, pos2)
+	local emin, emax = vm:get_emerged_area()
 	local area = VoxelArea:new{MinEdge = emin, MaxEdge = emax}
 	local data = vm:get_data()
 
@@ -243,15 +256,45 @@ local function get_isometric_view(fs, pos, X, Y)
 
 			local size = 0.25
 			local x = 2 + (size / 2 * (p.z - p.x))
-			local y = 1.15 + (size / 4 * (p.x + p.z - 2 * p.y))
+			local y = 1 + (size / 4 * (p.x + p.z - 2 * p.y))
+
+			if y < high then
+				high = y
+			end
 
 			if plant then
 				size -= 0.05
 			end
 
-			insert(fs, fmt("image[%f,%f;%.1f,%.1f;%s]", x + X, y + Y, size, size, img))
+			cubes++
+			insert(t[depth], {x + X, y + Y, size, size, img})
 		end
 	end
+
+	local maxc = ((width * 2) ^ 2) * base_height
+
+	if cubes < maxc and depth > max_depth then
+		-- if there's not enough map to preview, go deeper
+		depth -= 1
+		return get_isometric_view(fs, pos, X, Y, t, cubes, depth, high)
+	end
+
+	local shift = -0.3 - high
+
+	for i = max_depth, 0 do
+		local dth = t[i]
+		if dth then
+			dth[0] = #dth
+			for j = 1, dth[0] do
+				local params = dth[j]
+				      params[2] += shift
+				insert(fs, fmt("image[%f,%f;%.1f,%.1f;%s]", unpack(params)))
+			end
+		end
+	end
+
+	shift += (base_depth and 0.45 or 0.95)
+	fs("image", 2.7, Y + shift, 0.3, 0.3, PNG.flag)
 end
 
 local function get_waypoint_fs(fs, data, player, yextra, ctn_len)
@@ -262,6 +305,7 @@ local function get_waypoint_fs(fs, data, player, yextra, ctn_len)
 	fs(fmt("tooltip[waypoint_add;%s]", ES"Add waypoint"))
 
 	if #data.waypoints == 0 then return end
+	fs("style_type[label;font=bold;font_size=17]")
 
 	for i, v in ipairs(data.waypoints) do
 		local y = yextra + 1.35 + (i - (i * 0.3))
@@ -276,8 +320,6 @@ local function get_waypoint_fs(fs, data, player, yextra, ctn_len)
 			waypoint_name = snip(waypoint_name, lim)
 		end
 
-		fs"style_type[label;font_size=17]"
-
 		local hex = fmt("%02x", v.color)
 
 		while #hex < 6 do
@@ -332,11 +374,10 @@ local function get_waypoint_fs(fs, data, player, yextra, ctn_len)
 
 			local pos = str_to_pos(data.waypoints[i].pos)
 			get_isometric_view(fs, pos, 0.6, y - 2.5)
-			fs("image", 2.7, y - 1.5, 0.3, 0.3, PNG.flag)
 		end
 	end
 
-	fs"style_type[label;font_size=16]"
+	fs"style_type[label;font=normal;font_size=16]"
 end
 
 local function get_bag_fs(fs, data, name, esc_name, bag_size, yextra)
@@ -414,7 +455,7 @@ local function get_container(fs, data, player, yoffset, ctn_len, award_list, awa
 
 	local yextra = damage_enabled and 5.5 or 5
 
-	for i, title in ipairs(i3.SUBCAT) do
+	for i, title in ipairs(i3.categories) do
 		local btn_name = fmt("btn_%s", title)
 		fs(fmt("style[btn_%s;fgimg=%s;fgimg_hovered=%s;content_offset=0]", title,
 			data.subcat == i and PNG[fmt("%s_hover", title)] or PNG[title],
@@ -640,11 +681,11 @@ local function get_inventory_fs(player, data, fs)
 		max_val += (award_list_nb * 13)
 
 	elseif data.subcat == 5 then
-		local wp_nb = #data.waypoints
+		local wp = #data.waypoints
 
-		if wp_nb > 0 then
+		if wp > 0 then
-			local mul = (wp_nb > 8 and 7) or (wp_nb > 4 and 6) or 5
+			local mul = (wp > 8 and 7) or (wp > 4 and 6) or 5
-			max_val += 11 + (wp_nb * mul)
+			max_val += 11 + (wp * mul)
 		end
 	end
 
@@ -750,7 +791,8 @@ local function get_tooltip(item, info, pos)
 	end
 
 	if pos then
-		return fmt("tooltip", pos.x, pos.y, i3.ITEM_BTN_SIZE, i3.ITEM_BTN_SIZE, ESC(tooltip))
+		local btn_size = i3.settings.item_btn_size
+		return fmt("tooltip", pos.x, pos.y, btn_size, btn_size, ESC(tooltip))
 	end
 
 	return fmt("tooltip[%s;%s]", item, ESC(tooltip))
@@ -758,37 +800,49 @@ end
 
 local function get_output_fs(fs, data, rcp, is_recipe, shapeless, right, btn_size, _btn_size)
 	local custom_recipe = i3.craft_types[rcp.type]
+	local cooking = rcp.type == "cooking"
+	local fuel = rcp.type == "fuel"
 
-	if custom_recipe or shapeless or rcp.type == "cooking" then
+	if custom_recipe or shapeless or cooking then
-		local icon = custom_recipe and custom_recipe.icon or shapeless and "shapeless" or "furnace"
+		local icon, tooltip = PNG.blank
 
-		if not custom_recipe then
+		if custom_recipe and true_str(custom_recipe.icon) then
-			icon = fmt("i3_%s.png^\\[resize:16x16", icon)
+			icon = fmt("%s^\\[resize:16x16", custom_recipe.icon)
+		elseif shapeless then
+			icon = PNG.shapeless
 		end
 
 		local pos_x = right + btn_size + 0.42
 		local pos_y = data.yoffset + 0.9
 
-		if sub(icon, 1, 10) == "i3_furnace" then
+		if cooking then
 			fs("animated_image", pos_x, pos_y, 0.5, 0.5, PNG.furnace_anim, 8, 180)
 		else
 			fs("image", pos_x, pos_y, 0.5, 0.5, icon)
 		end
 
-		local tooltip = custom_recipe and custom_recipe.description or
+		if custom_recipe and true_str(custom_recipe.description) then
-				shapeless and S"Shapeless" or S"Cooking"
+			tooltip = custom_recipe.description
+		elseif shapeless then
+			tooltip = S"Shapeless"
+		elseif cooking then
+			tooltip = S"Cooking"
+		end
 
-		fs("tooltip", pos_x, pos_y, 0.5, 0.5, ESC(tooltip))
+		if tooltip then
+			fs("tooltip", pos_x, pos_y, 0.5, 0.5, ESC(tooltip))
+		end
 	end
 
-	local arrow_X = right + 0.2 + (_btn_size or i3.ITEM_BTN_SIZE)
+	local BTN_SIZE = i3.settings.item_btn_size
+	local arrow_X = right + 0.2 + (_btn_size or BTN_SIZE)
 	local X = arrow_X + 1.2
 	local Y = data.yoffset + 1.4
 
 	fs("image", arrow_X, Y + 0.06, 1, 1, PNG.arrow)
 
-	if rcp.type == "fuel" then
+	if fuel then
-		fs("animated_image", X + 0.05, Y, i3.ITEM_BTN_SIZE, i3.ITEM_BTN_SIZE, PNG.fire_anim, 8, 180)
+		fs("animated_image", X + 0.05, Y, BTN_SIZE, BTN_SIZE, PNG.fire_anim, 8, 180)
 		return
 	end
 
@@ -797,17 +851,17 @@ local function get_output_fs(fs, data, rcp, is_recipe, shapeless, right, btn_siz
 	local name  = item:get_name()
 	local count = item:get_count()
 	local wear  = item:get_wear()
-	local bt_s  = i3.ITEM_BTN_SIZE * 1.2
+	local bt_s  = BTN_SIZE * 1.2
 	local _name = fmt("_%s", name)
 	local pos
 
 	if meta:get_string"color" ~= "" or meta:get_string"palette_index" ~= "" then
 		local rcp_usg = is_recipe and "rcp" or "usg"
 
-		fs(fmt("style_type[list;size=%f]", i3.ITEM_BTN_SIZE))
+		fs(fmt("style_type[list;size=%f]", BTN_SIZE))
 		fs"listcolors[#bababa50;#bababa99]"
 		fs(fmt("list[detached:i3_output_%s_%s;main;%f,%f;1,1;]", rcp_usg, data.player_name, X + 0.11, Y))
-		fs("button",  X + 0.11, Y, i3.ITEM_BTN_SIZE, i3.ITEM_BTN_SIZE, _name, "")
+		fs("button",  X + 0.11, Y, BTN_SIZE, BTN_SIZE, _name, "")
 
 		local inv = get_detached_inv(fmt("output_%s", rcp_usg), data.player_name)
 		inv:set_stack("main", 1, item)
@@ -815,7 +869,7 @@ local function get_output_fs(fs, data, rcp, is_recipe, shapeless, right, btn_siz
 	else
 		fs("image", X, Y - 0.11, bt_s, bt_s, PNG.slot)
 		fs("item_image_button",
-			X + 0.11, Y, i3.ITEM_BTN_SIZE, i3.ITEM_BTN_SIZE,
+			X + 0.11, Y, BTN_SIZE, BTN_SIZE,
 			fmt("%s %u %u", name, count * (is_recipe and data.scrbar_rcp or data.scrbar_usg or 1), wear),
 			_name, "")
 	end
@@ -847,7 +901,8 @@ end
 
 local function get_grid_fs(fs, data, rcp, is_recipe)
 	local width = rcp.width or 1
-	local right, btn_size, _btn_size = 0, i3.ITEM_BTN_SIZE
+	local right = 0
+	local btn_size, _btn_size = i3.settings.item_btn_size
 	local cooktime, shapeless
 
 	if rcp.type == "cooking" then
@@ -1038,8 +1093,7 @@ local function get_model_fs(fs, data, def, model_alias)
 					hex = "0" .. hex
 				end
 
-				_name = fmt("%s^[multiply:%s", v.name,
+				_name = fmt("%s^[multiply:%s", v.name, fmt("#%s%s", sub(hex, 3), sub(hex, 1, 2)))
-					fmt("#%s%s", sub(hex, 3), sub(hex, 1, 2)))
 			else
 				_name = fmt("%s^[multiply:%s", v.name, v.color)
 			end
@@ -1060,11 +1114,12 @@ local function get_model_fs(fs, data, def, model_alias)
 end
 
 local function get_header(fs, data)
-	local fav = is_fav(data.favs, data.query_item)
+	local fav = is_fav(data)
 	local nfavs = #data.favs
+	local max_favs = i3.settings.max_favs
 	local star_x, star_y, size = data.inv_width + 0.3, data.yoffset + 0.2, 0.4
 
-	if nfavs < i3.MAX_FAVS or (nfavs == i3.MAX_FAVS and fav) then
+	if nfavs < max_favs or (nfavs == max_favs and fav) then
 		local fav_marked = fmt("i3_fav%s.png", fav and "_off" or "")
 		fs(fmt("style[fav;fgimg=%s;fgimg_hovered=%s;fgimg_pressed=%s]",
 			fmt("i3_fav%s.png", fav and "" or "_off"), fav_marked, fav_marked))
@@ -1145,7 +1200,7 @@ local function get_export_fs(fs, data, is_recipe, is_usage, max_stacks_rcp, max_
 		fmt("craft_%s", name), ES("Craft (×@1)", stack_fs))
 end
 
-local function get_rcp_extra(player, fs, data, panel, is_recipe, is_usage)
+local function get_rcp_extra(fs, data, player, panel, is_recipe, is_usage)
 	fs"container[0,0.075]"
 	local rn = panel.rcp and #panel.rcp
 
@@ -1184,7 +1239,7 @@ local function get_rcp_extra(player, fs, data, panel, is_recipe, is_usage)
 	fs"container_end[]"
 end
 
-local function get_items_fs(fs, data, full_height)
+local function hide_items(player, data)
 	if compression_active(data) then
 		local new = {}
 
@@ -1198,11 +1253,32 @@ local function get_items_fs(fs, data, full_height)
 		data.items = new
 	end
 
+	if not core.is_creative_enabled(data.player_name) then
+		local new = {}
+
+		for i = 1, #data.items do
+			local item = data.items[i]
+			local recipes, usages = get_recipes(player, item)
+
+			if recipes or usages then
+				insert(new, item)
+			end
+		end
+
+		data.items = new
+	end
+end
+
+local function get_items_fs(fs, data, player, full_height)
+	hide_items(player, data)
+
 	local items = data.alt_items or data.items or {}
 	local rows, lines = 8, 12
 	local ipp = rows * lines
 	local size = 0.85
 
+	fs("bg9", data.inv_width + 0.1, 0, 7.9, full_height, PNG.bg_full, 10)
+
 	fs(fmt("box[%f,0.2;4.05,0.6;#bababa25]", data.inv_width + 0.3),
 	   "set_focus[filter]",
 	   fmt("field[%f,0.2;2.95,0.6;filter;;%s]", data.inv_width + 0.35, ESC(data.filter)),
@@ -1237,10 +1313,10 @@ local function get_items_fs(fs, data, full_height)
 			local name = _compressed and item:sub(2) or item
 
 			local X = i % rows
-			X -= (X * 0.045) + data.inv_width + 0.28
+			      X -= (X * 0.045) + data.inv_width + 0.28
 
 			local Y = round((i % ipp - X) / rows + 1, 0)
-			Y -= (Y * 0.085) + 0.95
+			      Y -= (Y * 0.085) + 0.95
 
 			insert(fs, fmt("item_image_button", X, Y, size, size, name, item, ""))
 
@@ -1272,6 +1348,7 @@ local function get_items_fs(fs, data, full_height)
 end
 
 local function get_favs(fs, data)
+	local btn_size = i3.settings.item_btn_size
 	fs("label", data.inv_width + 0.4, data.yoffset + 0.4, ES"Bookmarks")
 
 	for i = 1, #data.favs do
@@ -1280,54 +1357,34 @@ local function get_favs(fs, data)
 		local Y = data.yoffset + 0.8
 
 		if data.query_item == item then
-			fs("image", X, Y, i3.ITEM_BTN_SIZE, i3.ITEM_BTN_SIZE, PNG.slot)
+			fs("image", X, Y, btn_size, btn_size, PNG.slot)
 		end
 
-		fs("item_image_button", X, Y, i3.ITEM_BTN_SIZE, i3.ITEM_BTN_SIZE, item, item, "")
+		fs("item_image_button", X, Y, btn_size, btn_size, item, item, "")
 	end
 end
 
-local function get_panels(player, data, fs, full_height)
+local function get_panels(fs, data, player)
-	local _title   = {name = "title", height = 1.4}
+	local title   = {name = "title", height = 1.4, func = get_header}
-	local _favs    = {name = "favs",  height = 2.23}
+	local favs    = {name = "favs", height = 2.23, func = get_favs}
-	local _items   = {name = "items", height = full_height}
+	local recipes = {name = "recipes", rcp = data.recipes, height = 4.045, func = get_rcp_extra}
-	local _recipes = {name = "recipes", rcp = data.recipes, height = 4.045}
+	local usages  = {name = "usages", rcp = data.usages, height = 4.045, func = get_rcp_extra}
-	local _usages  = {name = "usages",  rcp = data.usages,  height = 4.045}
+	local panels  = {title, recipes, usages, favs}
-	local panels
+	data.yoffset  = 0
 
-	if data.query_item then
+	for i, panel in ipairs(panels) do
-		panels = {_title, _recipes, _usages, _favs}
+		if i > 1 then
-	else
+			data.yoffset += panels[i - 1].height + 0.1
-		panels = {_items}
-	end
-
-	for idx = 1, #panels do
-		local panel = panels[idx]
-		data.yoffset = 0
-
-		if idx > 1 then
-			for _idx = idx - 1, 1, -1 do
-				data.yoffset = data.yoffset + panels[_idx].height + 0.1
-			end
 		end
 
 		fs("bg9", data.inv_width + 0.1, data.yoffset, 7.9, panel.height, PNG.bg_full, 10)
 
 		local is_recipe, is_usage = panel.name == "recipes", panel.name == "usages"
-
+		panel.func(fs, data, player, panel, is_recipe, is_usage)
-		if is_recipe or is_usage then
-			get_rcp_extra(player, fs, data, panel, is_recipe, is_usage)
-		elseif panel.name == "items" then
-			get_items_fs(fs, data, full_height)
-		elseif panel.name == "title" then
-			get_header(fs, data)
-		elseif panel.name == "favs" then
-			get_favs(fs, data)
-		end
 	end
 end
 
-local function get_tabs_fs(player, data, fs, full_height)
+local function get_tabs_fs(fs, player, data, full_height)
 	local tab_len, tab_hgh, c, over = 3, 0.5, 0
 	local _tabs = copy(i3.tabs)
 
@@ -1376,6 +1433,10 @@ local function get_tabs_fs(player, data, fs, full_height)
 end
 
 local function get_debug_grid(data, fs, full_height)
+	fs"style[hide_debug_grid;noclip=true]"
+	fs("button", -2, full_height - 1, 2, 1, "hide_debug_grid", "Toggle grid")
+	if data.hide_debug_grid then return end
+
 	fs("style_type[label;font_size=8;noclip=true]")
 	local spacing, i = 0.2, 1
 
@@ -1399,7 +1460,7 @@ local function get_debug_grid(data, fs, full_height)
 end
 
 local function make_fs(player, data)
-	--local start = os.clock()
+	local start = i3.settings.debug_mode and os.clock() or nil
 
 	local fs = setmetatable({}, {
 		__call = function(t, ...)
@@ -1417,26 +1478,32 @@ local function make_fs(player, data)
 	data.inv_width = 10.23
 	local full_height = 12
 
-	local tab = i3.tabs[data.tab]
-
 	fs(fmt("formspec_version[%u]size[%f,%f]no_prepend[]bgcolor[#0000]",
-		i3.MIN_FORMSPEC_VERSION, data.inv_width + 8, full_height), styles)
+		i3.settings.min_fs_version, data.inv_width + 8, full_height), styles)
 
 	fs("bg9", 0, 0, data.inv_width, full_height, PNG.bg_full, 10)
 
+	local tab = i3.tabs[data.tab]
+
 	if tab then
 		tab.formspec(player, data, fs)
 	end
 
-	get_panels(player, data, fs, full_height)
+	if data.query_item then
-
+		get_panels(fs, data, player)
-	if #i3.tabs > 1 then
+	else
-		get_tabs_fs(player, data, fs, full_height)
+		get_items_fs(fs, data, player, full_height)
 	end
 
-	--get_debug_grid(data, fs, full_height)
+	if #i3.tabs > 1 then
-	--print("make_fs()", fmt("%.2f ms", (os.clock() - start) * 1000))
+		get_tabs_fs(fs, player, data, full_height)
-	--print("#fs elements", #fs)
+	end
+
+	if i3.settings.debug_mode then
+		get_debug_grid(data, fs, full_height)
+		msg(data.player_name, fmt("make_fs(): %.2f ms", (os.clock() - start) * 1000))
+		msg(data.player_name, fmt("#fs elements: %u", #fs))
+	end
 
 	return concat(fs)
 end

src/hud.lua

@@ -34,10 +34,12 @@ local function init_hud(player)
 		},
 	}
 
-	core.after(0, function()
+	if not i3.settings.legacy_inventory then
-		player:hud_set_hotbar_itemcount(i3.HOTBAR_LEN)
+		core.after(0, function()
-		player:hud_set_hotbar_image"i3_hotbar.png"
+			player:hud_set_hotbar_itemcount(i3.settings.hotbar_len)
-	end)
+			player:hud_set_hotbar_image"i3_hotbar.png"
+		end)
+	end
 end
 
 local function show_hud(player, data)
@@ -64,18 +66,18 @@ local function show_hud(player, data)
 
 			player:hud_change(def, "position", {
 				x = hud_info.position.x,
-				y = hud_info.position.y - ((dt / 5) * i3.HUD_SPEED)
+				y = hud_info.position.y - ((dt / 5) * i3.settings.hud_speed)
 			})
 		end
 
 	elseif data.show_hud == false then
-		if data.hud_timer >= i3.HUD_TIMER_MAX then
+		if data.hud_timer >= i3.settings.hud_timer_max then
 			for _, def in pairs(data.hud) do
 				local hud_info = player:hud_get(def)
 
 				player:hud_change(def, "position", {
 					x = hud_info.position.x,
-					y = hud_info.position.y + ((dt / 5) * i3.HUD_SPEED)
+					y = hud_info.position.y + ((dt / 5) * i3.settings.hud_speed)
 				})
 			end
 

src/styles.lua

@@ -1,4 +1,5 @@
 local PNG = {
+	blank = "i3_blank.png",
 	bg = "i3_bg.png",
 	bg_full = "i3_bg_full.png",
 	bg_content = "i3_bg_content.png",
@@ -27,6 +28,7 @@ local PNG = {
 	tab_small = "i3_tab_small.png",
 	tab_top = "i3_tab.png^\\[transformFY",
 	furnace_anim = "i3_furnace_anim.png",
+	shapeless = "i3_shapeless.png",
 	bag = "i3_bag.png",
 	armor = "i3_armor.png",
 	awards = "i3_award.png",

tests/test_custom_recipes.lua

@@ -38,6 +38,24 @@ i3.register_craft({
 	items = {"default:copper_ingot 7, default:tin_ingot, default:steel_ingot 2"},
 })
 
+i3.register_craft {
+	result = "default:tree",
+	items = {
+		"default:wood",
+		"",
+		"default:wood"
+	},
+}
+
+i3.register_craft {
+	result = "default:cobble 16",
+	items = {
+		"default:stone, default:stone",
+		"default:stone,              , default:stone",
+		", default:stone, default:stone",
+	}
+}
+
 i3.register_craft({
 	grid = {
 		"X",
@@ -311,22 +329,3 @@ i3.register_craft({
 	},
 	result = "default:mese 3",
 })
-
-i3.register_craft({
-	grid = {
-		"X  #",
-		" ## ",
-		"X#X#",
-		"#X#X#",
-		"X  X##X#X",
-		" ## ",
-		"#X#X#",
-		"#X#X#",
-		"X  #",
-	},
-	key = {
-		['#'] = "default:wood",
-		['X'] = "default:glass",
-	},
-	result = "default:mese 3",
-})