Optimization

Since 5.4.0-dev, hud_change() expects a valid HUD identifier. Nil results in an error.
Additionally data.hud_flags were 'nil' after closing the /craft-opened formspec

.luacheckrc

@@ -1,14 +1,12 @@
-unused_args = false
 allow_defined_top = true
 
 read_globals = {
 	"minetest",
 	"default",
-	"sfinv",
-	"sfinv_buttons",
 	"vector",
 	"string",
 	"table",
+	"ItemStack",
 }
 
 globals = {

API.md

@@ -5,6 +5,9 @@
 Custom recipes are nonconventional crafts outside the main crafting grid.
 They can be registered in-game dynamically and have a size beyond 3x3 items.
 
+**Note:** the registration format differs from the default registration format in everything.
+The width is automatically calculated depending where you place the commas. Look at the examples attentively.
+
 #### Registering a custom crafting type (example)
 
 ```Lua
@@ -35,7 +38,7 @@ craftguide.register_craft({
 })
 ```
 
-Recipes can also be registered in a Minecraft-like way:
+Recipes can be registered in a Minecraft-like way:
 
 ```Lua
 craftguide.register_craft({
@@ -53,6 +56,38 @@ craftguide.register_craft({
 })
 ```
 
+Multiples recipes can also be registered:
+
+```Lua
+craftguide.register_craft({
+	{
+		result = "default:mese",
+		items = {
+			"default:mese_crystal, default:mese_crystal",
+			"default:mese_crystal, default:mese_crystal",
+		}
+	},
+
+	big = {
+		result = "default:mese 4",
+		items = {
+			"default:mese_crystal, default:mese_crystal",
+			"default:mese_crystal, default:mese_crystal",
+			"default:mese_crystal, default:mese_crystal",
+			"default:mese_crystal, default:mese_crystal",
+		}
+	},
+})
+```
+
+Recipes can be registered from a given URL containing a JSON file (HTTP support is required¹):
+
+```Lua
+craftguide.register_craft({
+	url = "https://raw.githubusercontent.com/minetest-mods/craftguide/master/test.json"
+})
+```
+
 ---
 
 ### Recipe filters
@@ -62,7 +97,7 @@ mode is implemented as a recipe filter.
 
 #### `craftguide.add_recipe_filter(name, function(recipes, player))`
 
-Adds a recipe filter with the given name. The filter function should return the
+Adds a recipe filter with the given `name`. The filter function returns the
 recipes to be displayed, given the available recipes and an `ObjectRef` to the
 user. Each recipe is a table of the form returned by
 `minetest.get_craft_recipe`.
@@ -88,7 +123,7 @@ Removes all recipe filters and adds a new one.
 
 #### `craftguide.remove_recipe_filter(name)`
 
-Removes the recipe filter with the given name.
+Removes the recipe filter with the given `name`.
 
 #### `craftguide.get_recipe_filters()`
 
@@ -99,50 +134,41 @@ Returns a map of recipe filters, indexed by name.
 ### Search filters
 
 Search filters are used to perform specific searches inside the search field.
-They can be used like so: `<optional name>+<filter name>=<value1>,<value2>,<...>`
+You can cumulate several filters to perform a specific search.
+They can be used like so: `<optional_name> +<filter name>=<value1>,<value2>,<...>`
 
-Examples:
+Example usages:
 
 - `+groups=cracky,crumbly`: search for groups `cracky` and `crumbly` in all items.
-- `sand+groups=falling_node`: search for group `falling_node` for items which contain `sand` in their names.
+- `wood +groups=flammable +type=node`: search for group `flammable` amongst items which contain
+  `wood` in their names AND have a `node` drawtype.
 
 Notes:
-- If `optional name` is omitted, the search filter will apply to all items, without pre-filtering.
-- Filters can be combined.
-- The `groups` filter is currently implemented by default.
+- If `optional_name` is omitted, the search filter will apply to all items, without pre-filtering.
+- The `groups` and `type` filters are currently implemented by default.
 
 #### `craftguide.add_search_filter(name, function(item, values))`
 
-Adds a search filter with the given name.
-The search function should return a boolean value (whether the given item should be listed or not).
+Adds a search filter with the given `name`.
+The search function must return a boolean value (whether the given item should be listed or not).
 
-Example function to show items which contain at least a recipe of given width(s):
+Example function sorting items by drawtype:
 
 ```lua
-craftguide.add_search_filter("widths", function(item, widths)
-	local has_width
-	local recipes = recipes_cache[item]
-
-	if recipes then
-		for i = 1, #recipes do
-			local recipe_width = recipes[i].width
-			for j = 1, #widths do
-				local width = tonumber(widths[j])
-				if width == recipe_width then
-					has_width = true
-					break
-				end
-			end
-		end
+craftguide.add_search_filter("type", function(item, drawtype)
+	if drawtype == "node" then
+		return reg_nodes[item]
+	elseif drawtype == "item" then
+		return reg_craftitems[item]
+	elseif drawtype == "tool" then
+		return reg_tools[item]
 	end
-
-	return has_width
 end)
 ```
 
 #### `craftguide.remove_search_filter(name)`
 
-Removes the search filter with the given name.
+Removes the search filter with the given `name`.
 
 #### `craftguide.get_search_filters()`
 
@@ -168,3 +194,12 @@ You can add a stereotype like so:
 ```Lua
 craftguide.group_stereotypes.radioactive = "mod:item"
 ```
+
+#### `craftguide.export_url`
+
+If set, the mod will export all the cached recipes and usages in a JSON format
+to the given URL (HTTP support is required¹).
+
+---
+
+**¹** Add `craftguide` to the `secure.http_mods` or `secure.trusted_mods` setting in `minetest.conf`.

README.md

@@ -1,5 +1,7 @@
 # ![Preview1](http://i.imgur.com/fIPNYkb.png) Crafting Guide
 
+[![ContentDB](https://content.minetest.net/packages/jp/craftguide/shields/title/)](https://content.minetest.net/packages/jp/craftguide/) [![ContentDB](https://content.minetest.net/packages/jp/craftguide/shields/downloads/)](https://content.minetest.net/packages/jp/craftguide/)
+
 #### `craftguide` is the most comprehensive crafting guide on Minetest.
 #### Consult the [Minetest Wiki](http://wiki.minetest.net/Crafting_guide) for more details.
 
@@ -9,14 +11,11 @@ This crafting guide features a **progressive mode**.
 This mode is a Terraria-like system that shows recipes you can craft
 from items you ever had in your inventory. To enable it: `craftguide_progressive_mode = true` in `minetest.conf`.
 
-`craftguide` is also integrated in `sfinv` (Minetest Game inventory). To enable it:
-`craftguide_sfinv_only = true` in `minetest.conf`.
-
 Use the command `/craft` to show the recipe(s) of the pointed node.
 
-For developers, `craftguide` also has a [modding API](https://github.com/minetest-mods/craftguide/blob/master/API.md). 
+For developers, `craftguide` also has a [modding API](https://github.com/minetest-mods/craftguide/blob/master/API.md).
 
 Love this mod? Donations are appreciated: https://www.paypal.me/jpg84240
 
 
-![Preview2](https://i.imgur.com/GVQvufb.png)
+![Preview2](https://user-images.githubusercontent.com/7883281/103141399-113b5e00-46f4-11eb-96cd-0167972ca1cf.png)

license.txt

@@ -3,7 +3,7 @@ License of source code
 
 The MIT License (MIT)
 
-Copyright (c) 2015-2019 Jean-Patrick Guerrero and contributors.
+Copyright (c) 2015-present Jean-Patrick Guerrero and contributors.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -27,7 +27,8 @@ THE SOFTWARE.
 Licenses of media (textures)
 ----------------------------
 
-Copyright © Diego Martínez (kaeza): craftguide_*_icon.png (CC BY-SA 3.0)
+paramat (CC BY-SA 3.0):
+  craftguide_arrow.png - derived from a texture by BlockMen (CC BY-SA 3.0)
 
 You are free to:
 Share — copy and redistribute the material in any medium or format.

locale/craftguide.de.tr

@@ -3,17 +3,58 @@
 Craft Guide=Rezeptbuch
 Crafting Guide=Rezeptbuch
 Crafting Guide Sign=Rezepttafel
+Bookmarks=Lesezeichen
 Usage @1 of @2=Verwendung @1 von @2
 Recipe @1 of @2=Rezept @1 von @2
+No recipes=Keine Rezepte
+No usages=Keine Verwendungen
 Burning time: @1=Brennzeit: @1
 Cooking time: @1=Kochzeit: @1
+Replaced by @1 on smelting=Ersetzt durch @1 beim Schmelzen
+Replaced by @1 on burning=Ersetzt durch @1 beim Brennen
+Replaced by @1 on crafting=Ersetzt durch @1 beim Fertigen
+Repairable by step of @1=Reparierbar um @1
 Any item belonging to the group(s): @1=Beliebiger Gegenstand aus Gruppe(n): @1
+Any black dye=Beliebiger schwarzer Farbstoff
+Any black flower=Beliebige schwarze Blume
+Any blue dye=Beliebiger blauer Farbstoff
+Any blue flower=Beliebige blaue Blume
+Any brown dye=Beliebiger brauner Farbstoff
+Any coal=Beliebige Kohle
+Any cyan dye=Beliebiger türkiser Farbstoff
+Any dark green dye=Beliebiger dunkelgrüner Farbstoff
+Any dark grey dye=Beliebiger dunkelgrauer Farbstoff
+Any green dye=Beliebiger grüner Farbstoff
+Any green flower=Beliebige grüne Blume
+Any grey dye=Beliebiger grauer Farbstoff
+Any kind of stone block=Beliebiger Steinblock
+Any magenta dye=Beliebiger magenta Farbstoff
+Any orange dye=Beliebiger orange Farbstoff
+Any orange flower=Beliebige orange Blume
+Any pink dye=Beliebiger rosa Farbstoff
+Any red dye=Beliebiger roter Farbstoff
+Any red flower=Beliebige rote Blume
+Any sand=Beliebiger Sand
+Any stick=Beliebiger Stock
+Any tree=Beliebiger Baum
+Any vessel=Beliebiger Behälter
+Any violet dye=Beliebiger violetter Farbstoff
+Any violet flower=Beliebige violette Blume
+Any white dye=Beliebiger weißer Farbstoff
+Any white flower=Beliebige weiße Blume
+Any wood planks=Beliebige Holzplanken
+Any wool=Beliebige Wolle
+Any yellow dye=Beliebiger gelber Farbstoff
+Any yellow flower=Beliebige gelbe Blume
 Recipe's too big to be displayed (@1x@2)=Rezept ist zu groß für die Anzeige (@1×@2)
 Shapeless=Formlos
 Cooking=Kochen
 No item to show=Nichts anzuzeigen
 Collect items to reveal more recipes=Gegenstände aufsammeln, um mehr Rezepte aufzudecken
 Show recipe(s) of the pointed node=Rezept(e) des gezeigten Blocks anzeigen
-No node pointed=Auf keinen Block gezeigt
-You don't know a recipe for this node=Sie kennen kein Rezept für diesen Block
-No recipe for this node=Kein Rezept für diesen Block
+No node pointed=Auf keinem Block gezeigt
+You don't know a recipe or usage for this item=Sie kennen kein Rezept und keine Verwendung für diesen Gegenstand
+No recipe or usage for this item=Kein Rezept und keine Verwendung für diesen Gegenstand
+Digging=Graben
+Digging Chance=Grabechance
+@1 of chance to drop=@1 Abwurfwahrscheinlichkeit

locale/craftguide.fr.tr

@@ -2,8 +2,12 @@
 
 Craft Guide=Guide de recettes
 Crafting Guide=Guide de recettes
-Usage @1 of @2=Usage @1 de @2
-Recipe @1 of @2=Recette @1 de @2
+Crafting Guide Sign=Guide de recettes
+Bookmarks=Favoris
+Usage @1 of @2=Usage @1 sur @2
+Recipe @1 of @2=Recette @1 sur @2
+No recipes=Pas de recettes
+No usages=Pas d'usages
 Burning time: @1=Temps de combustion : @1
 Cooking time: @1=Temps de cuisson : @1
 Replaced by @1 on smelting=Remplacé par @1 lors de la cuisson
@@ -11,12 +15,55 @@ Replaced by @1 on burning=Remplacé par @1 lors de la combustion
 Replaced by @1 on crafting=Remplacé par @1 lors de la fabrication
 Repairable by step of @1=Réparable par étape de @1
 Any item belonging to the group(s): @1=Tout item appartenant au(x) groupe(s) : @1
-Recipe's too big to be displayed (@1x@2)=La recette est trop grande pour être affichée (@1x@2)
+Any black dye=Quelconque colorant noir
+Any black flower=Quelconque fleur noire
+Any blue dye=Quelconque colorant bleu
+Any blue flower=Quelconque fleur bleue
+Any brown dye=Quelconque colorant marron
+Any coal=Quelconque charbon
+Any cyan dye=Quelconque colorant bleu ciel
+Any dark green dye=Quelconque colorant vert foncé
+Any dark grey dye=Quelconque colorant gris foncé
+Any green dye=Quelconque colorant vert
+Any green flower=Quelconque fleur verte
+Any grey dye=Quelconque colorant gris
+Any kind of stone block=Quelconque roche
+Any magenta dye=Quelconque colorant magenta
+Any orange dye=Quelconque colorant orange
+Any orange flower=Quelconque fleur orange
+Any pink dye=Quelconque colorant rose
+Any red dye=Quelconque colorant rouge
+Any red flower=Quelconque fleur rouge
+Any sand=Quelconque sable
+Any stick=Quelconque bâton
+Any tree=Quelconque tronc d'arbre
+Any vessel=Quelconque couvert
+Any violet dye=Quelconque colorant violet
+Any violet flower=Quelconque fleur violette
+Any white dye=Quelconque colorant blanc
+Any white flower=Quelconque fleur blanche
+Any wood planks=Quelconques planches de bois
+Any wool=Quelconque laine
+Any yellow dye=Quelconque colorant jaune
+Any yellow flower=Quelconque fleur jaune
 Shapeless=Sans forme
 Cooking=Cuisson
 No item to show=Aucun item à afficher
 Collect items to reveal more recipes=Collecte des items pour révéler plus de recettes
 Show recipe(s) of the pointed node=Affiche les recettes du bloc visé
 No node pointed=Aucun bloc visé
-You don't know a recipe for this node=Tu ne connais aucune recette pour ce bloc
-No recipe for this node=Aucune recette pour ce bloc
+You don't know a recipe or usage for this item=Vous ne connaissez aucune recette pour ce bloc
+No recipe or usage for this node=Aucune recette pour ce bloc
+Digging=Destruction
+Digging (by chance)=Destruction (par chance)
+@1 of chance to drop=@1 de chance de tomber
+Mark this item=Mettre en favori.
+Unmark this item=Enlever des favoris.
+Cannot mark this item. Limit of bookmarks reached.=Impossible de mettre cet item en favori. Limite des favoris atteinte.
+Only drop if using one of these tools: @1=Tombe seulement si détruit avec un de ces outils : @1
+Only drop if using this tool: @1=Tombe seulement si détruit avec cet outil : @1
+Craft @1 stack=Fabriquer @1 objet
+Craft @1 stacks=Fabriquer @1 objets
+@1 added in your inventory=@1 mis dans votre inventaire
+@1 crafted=@1 fabriqué(s)
+Quick crafting=Fabrication rapide

locale/craftguide.it.tr

@@ -2,22 +2,59 @@
 
 Craft Guide=Guida di assemblaggio
 Crafting Guide=Guida d'assemblaggio
-Crafting Guide Sign=Cartello della guida d'assemblaggio
+Crafting Guide Sign=Cartello della guida di assemblaggio
+Bookmarks=Segnalibri
 Usage @1 of @2=Utilizzo @1 di @2
 Recipe @1 of @2=Ricetta @1 di @2
-Burning time: @1=Tempo di bruciatura: @1
+No recipes=Nessuna ricetta
+No usages=Nessun utilizzo
+Burning time: @1=Tempo di combustione: @1
 Cooking time: @1=Tempo di cottura: @1
 Replaced by @1 on smelting=Sostituito da @1 alla fusione
-Replaced by @1 on burning=Sostituito da @1 alla bruciatura
+Replaced by @1 on burning=Sostituito da @1 alla combustione
 Replaced by @1 on crafting=Sostituito da @1 all'assemblaggio
 Repairable by step of @1=Riparabile per passo di @1
-Any item belonging to the group(s): @1=Qualunque oggetto appartenente al gruppo: @1
+Any item belonging to the group(s): @1=Qualunque oggetto appartenente al/ai gruppo/i: @1
+Any black dye=Qualunque tintura nera
+Any black flower=Qualunque fiore nero
+Any blue dye=Qualunque tintura blu
+Any blue flower=Qualunque fiore blu
+Any brown dye=Qualunque tintura marrone
+Any coal=Qualunque carbone
+Any cyan dye=Qualunque tintura ciano
+Any dark green dye=Qualunque tintura verde scura
+Any dark grey dye=Qualunque tintura grigio scura
+Any green dye=Qualunque tintura verde
+Any green flower=Qualunque fiore verde
+Any grey dye=Qualunque tintura grigia
+Any kind of stone block=Qualunque tipo di blocco di pietra
+Any magenta dye=Qualunque tintura magenta
+Any orange dye=Qualunque tintura arancione
+Any orange flower=Qualunque fiore arancione
+Any pink dye=Qualunque tintura rosa
+Any red dye=Qualunque tintura rossa
+Any red flower=Qualunque fiore rosso
+Any sand=Qualunque sabbia
+Any stick=Qualunque bastone
+Any tree=Qualunque albero
+Any vessel=Qualunque contenitore
+Any violet dye=Qualunque tintura viola
+Any violet flower=Qualunque fiore viola
+Any white dye=Qualunque tintura bianca
+Any white flower=Qualunque fiore bianco
+Any wood planks=Qualunque asse di legno
+Any wool=Qualunque lana
+Any yellow dye=Qualunque tintura gialla
+Any yellow flower=Qualunque fiore giallo
 Recipe's too big to be displayed (@1x@2)=La ricetta è troppo grande per essere mostrata (@1x@2)
 Shapeless=Senza forma
 Cooking=Cottura
 No item to show=Nessun oggetto da mostrare
 Collect items to reveal more recipes=Raccogli oggetti per svelare più ricette
-Show recipe(s) of the pointed node=Mostra la ricetta del nodo puntato
+Show recipe(s) of the pointed node=Mostra la/le ricetta/e del nodo puntato
 No node pointed=Nessun nodo puntato
-You don't know a recipe for this node=Non conosci una ricetta per questo nodo
-No recipe for this node=Nessuna ricetta per questo nodo
+You don't know a recipe or usage for this item=Non conosci una ricetta o un utilizzo per questo oggetto
+No recipe or usage for this item=Nessuna ricetta o utilizzo per questo oggetto
+Digging=Scavando
+Digging Chance=Probabilità di scavare
+@1 of chance to drop=@1 di probabilità di rilascio

locale/craftguide.zh_CN.tr

@@ -0,0 +1,40 @@
+# textdomain: craftguide
+
+Any black dye=任何黑染料
+Any black flower=任何黑花
+Any blue dye=任何蓝染料
+Any blue flower=任何蓝花
+Any brown dye=任何棕染料
+Any coal=任何煤炭
+Any cyan dye=任何青染料
+Any dark green dye=任何暗绿染料
+Any dark grey dye=任何暗灰染料
+Any green dye=任何绿染料
+Any green flower=任何绿花
+Any grey dye=任何灰染料
+Any item belonging to the group(s): @1=任何属于以下组别的物品：@1
+Any kind of stone block=任何石方块
+Any magenta dye=任何品红染料
+Any orange dye=任何橙染料
+Any orange flower=任何橙花
+Any pink dye=任何粉红染料
+Any red dye=任何红染料
+Any red flower=任何红花
+Any sand=任何沙
+Any stick=任何棒
+Any vessel=任何容器
+Any violet dye=任何紫染料
+Any violet flower=任何紫花
+Any white dye=任何白染料
+Any white flower=任何白花
+Any wood planks=任何木板
+Any wool=任何羊毛
+Any yellow dye=任何黄染料
+Any yellow flower=任何黄花
+Cooking time: @1=熔炼时间为：@1
+No items to show=没有可显示的项目。
+Recipe @1 of @2=第@1个配方，共@2个
+Usage @1 of @2=第@1个用法，共@2个
+Recipe is too big to be displayed=配方太大，无法显示。
+Shapeless=无序配方
+Unknown Item=不明物品

locale/template

@@ -3,8 +3,11 @@
 Craft Guide=
 Crafting Guide=
 Crafting Guide Sign=
+Bookmarks=
 Usage @1 of @2=
 Recipe @1 of @2=
+No recipes=
+No usages=
 Burning time: @1=
 Cooking time: @1=
 Replaced by @1 on smelting=
@@ -12,7 +15,37 @@ Replaced by @1 on burning=
 Replaced by @1 on crafting=
 Repairable by step of @1=
 Any item belonging to the group(s): @1=
-Recipe's too big to be displayed (@1x@2)=
+Any black dye=
+Any black flower=
+Any blue dye=
+Any blue flower=
+Any brown dye=
+Any coal=
+Any cyan dye=
+Any dark green dye=
+Any dark grey dye=
+Any green dye=
+Any green flower=
+Any grey dye=
+Any stone=
+Any magenta dye=
+Any orange dye=
+Any orange flower=
+Any pink dye=
+Any red dye=
+Any red flower=
+Any sand=
+Any stick=
+Any tree=
+Any vessel=
+Any violet dye=
+Any violet flower=
+Any white dye=
+Any white flower=
+Any wood planks=
+Any wool=
+Any yellow dye=
+Any yellow flower=
 Shapeless=
 Cooking=
 No item to show=
@@ -20,13 +53,17 @@ Collect items to reveal more recipes=
 Show recipe(s) of the pointed node=
 No node pointed=
 You don't know a recipe or usage for this item=
-No recipe or usage for this item=
-Node=
-Entity=
-Craftitem=
-Tool=
-Name=
-Type=
-Groups=
-Unknown=
-None=
+No recipe or usage for this node=
+Digging=
+Digging (by chance)=
+@1 of chance to drop=
+Mark this item=
+Unmark this item=
+Cannot mark this item. Limit of bookmarks reached.=
+Only drop if using one of these tools: @1=
+Only drop if using this tool: @1=
+Craft @1 stack=
+Craft @1 stacks=
+@1 added in your inventory=
+@1 crafted=
+Quick crafting=

mod.conf

@@ -1,3 +1,2 @@
 name = craftguide
-optional_depends = sfinv, sfinv_buttons
 description = The most comprehensive Crafting Guide on Minetest

settingtypes.txt

@@ -1,5 +1,2 @@
 # The progressive mode shows recipes you can craft from items you ever had in your inventory.
-craftguide_progressive_mode	(Progressive Mode)	bool false
-
-# Integration in the default Minetest Game inventory.
-craftguide_sfinv_only		(Sfinv only)		bool false
+craftguide_progressive_mode    (Learn crafting recipes progressively)    bool false

test.json

@@ -0,0 +1,8 @@
+{
+	"items": [
+		"default:stone, default:stone, default:stone",
+		"default:stone,              , default:stone",
+		"default:stone, default:stone, default:stone"
+	],
+	"result": "default:cobble 16"
+}