Clickable group items

s

.luacheckrc

@@ -9,4 +9,10 @@ read_globals = {
 	"vector",
 	"string",
 	"table",
+	"ItemStack",
+}
+
+globals = {
+	"craftguide",
+	"core",
 }

API.md

@@ -2,6 +2,12 @@
 
 ### Custom recipes
 
+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
@@ -11,17 +17,77 @@ craftguide.register_craft_type("digging", {
 })
 ```
 
-#### Registering a custom crafting recipe (example)
+#### Registering a custom crafting recipe (examples)
 
 ```Lua
 craftguide.register_craft({
 	type   = "digging",
-	width  = 1,
+	result = "default:cobble 2",
-	output = "default:cobble 2",
 	items  = {"default:stone"},
 })
 ```
 
+```Lua
+craftguide.register_craft({
+	result = "default:cobble 16",
+	items = {
+		"default:stone, default:stone, default:stone",
+		"default:stone,              , default:stone",
+		"default:stone, default:stone, default:stone",
+	}
+})
+```
+
+Recipes can be registered in a Minecraft-like way:
+
+```Lua
+craftguide.register_craft({
+	grid = {
+		"X  #",
+		" ## ",
+		"X#X#",
+		"X  X",
+	},
+	key = {
+		['#'] = "default:wood",
+		['X'] = "default:glass",
+	},
+	result = "default:mese 3",
+})
+```
+
+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
@@ -51,14 +117,14 @@ craftguide.add_recipe_filter("Hide secretstuff", function(recipes)
 end)
 ```
 
-#### `craftguide.remove_recipe_filter(name)`
-
-Removes the recipe filter with the given name.
-
 #### `craftguide.set_recipe_filter(name, function(recipe, player))`
 
 Removes all recipe filters and adds a new one.
 
+#### `craftguide.remove_recipe_filter(name)`
+
+Removes the recipe filter with the given name.
+
 #### `craftguide.get_recipe_filters()`
 
 Returns a map of recipe filters, indexed by name.
@@ -70,10 +136,15 @@ Returns a map of recipe filters, indexed by name.
 Search filters are used to perform specific searches inside the search field.
 They can be used like so: `<optional name>+<filter name>=<value1>,<value2>,<...>`
 
+Examples:
+
+- `+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.
+
 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.
+- The `groups` filter is currently implemented by default.
 
 #### `craftguide.add_search_filter(name, function(item, values))`
 
@@ -114,49 +185,6 @@ Returns a map of search filters, indexed by name.
 
 ---
 
-### Custom formspec elements
-
-#### `craftguide.add_formspec_element(name, def)`
-
-Adds a formspec element to the current formspec.
-Supported types: `box`, `label`, `image`, `button`, `tooltip`, `item_image`, `image_button`, `item_image_button`
-
-Example:
-
-```lua
-craftguide.add_formspec_element("export", {
-	type = "button",
-	element = function(data)
-		-- Should return a table of parameters according to the formspec element type.
-		-- Note: for all buttons, the 'name' parameter *must not* be specified!
-		if data.recipes then
-			return {
-				data.iX - 3.7,   -- X
-				sfinv_only and 7.9 or 8, -- Y
-				1.6,             -- W
-				1,               -- H
-				ESC(S("Export")) -- label
-			}
-		end
-	end,
-	-- Optional.
-	action = function(player, data)
-		-- When the button is pressed.
-		print("Exported!")
-	end
-})
-```
-
-#### `craftguide.remove_formspec_element(name)`
-
-Removes the formspec element with the given name.
-
-#### `craftguide.get_formspec_elements()`
-
-Returns a map of formspec elements, indexed by name.
-
----
-
 ### Miscellaneous
 
 #### `craftguide.show(player_name, item, show_usages)`
@@ -166,3 +194,21 @@ Opens the Crafting Guide with the current filter applied.
    * `player_name`: string param.
    * `item`: optional, string param. If set, this item is pre-selected. If the item does not exist or has no recipe, use the player's previous selection. By default, player's previous selection is used
    * `show_usages`: optional, boolean param. If true, show item usages.
+
+#### `craftguide.group_stereotypes`
+
+This is the table indexing the item groups by stereotypes.
+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

@@ -6,7 +6,7 @@
 This crafting guide is a blue book named *"Crafting Guide"* or a wooden sign.
 
 This crafting guide features a **progressive mode**.
-The progressive mode is a Terraria-like system that shows recipes you can craft
+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:
@@ -14,8 +14,11 @@ from items you ever had in your inventory. To enable it: `craftguide_progressive
 
 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).
+
+For the best visuals, it is recommended to enable `inventory_items_animations` in `minetest.conf`.
+
+Love this mod? Donations are appreciated: https://www.paypal.me/jpg84240
 
 
-![Preview2](https://i.imgur.com/bToFH38.png)
+![Preview2](https://i.imgur.com/TrBouDq.png)
-

depends.txt

@@ -1,2 +0,0 @@
-sfinv?
-sfinv_buttons?

description.txt

@@ -1,2 +0,0 @@
-The most comprehensive Crafting Guide
-on Minetest.

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-2020 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

locale/craftguide.de.tr

@@ -3,23 +3,58 @@
 Craft Guide=Rezeptbuch
 Crafting Guide=Rezeptbuch
 Crafting Guide Sign=Rezepttafel
-Search=Suche
+Bookmarks=Lesezeichen
-Reset=Zurücksetzen
-Previous page=Vorherige Seite
-Next page=Nächste Seite
 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
-Recipe is too big to be displayed (@1x@2)=Rezept ist zu groß für die Anzeige (@1×@2)
+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
-Increase window size=Fenster vergrößern
-Decrease window size=Fenster verkleinern
 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
+No node pointed=Auf keinem Block gezeigt
-You don't know a recipe for this node=Sie kennen kein Rezept für diesen Block
+You don't know a recipe or usage for this item=Sie kennen kein Rezept und keine Verwendung für diesen Gegenstand
-No recipe for this node=Kein Rezept für diesen Block
+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,23 +2,64 @@
 
 Craft Guide=Guide de recettes
 Crafting Guide=Guide de recettes
-Search=Rechercher
+Crafting Guide Sign=Guide de recettes
-Reset=Réinitialiser
+Bookmarks=Favoris
-Previous page=Page précédente
+Usage @1 of @2=Usage @1 sur @2
-Next page=Page suivante
+Recipe @1 of @2=Recette @1 sur @2
-Usage @1 of @2=Usage @1 de @2
+No recipes=Pas de recettes
-Recipe @1 of @2=Recette @1 de @2
+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
+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 is 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
+Recipe's too big to be displayed (@1x@2)=La recette est trop grande pour être affichée (@1x@2)
 Shapeless=Sans forme
 Cooking=Cuisson
-Increase window size=Agrandir la fenêtre
-Decrease window size=Réduire la fenêtre
 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
+You don't know a recipe or usage for this item=Vous ne connaissez aucune recette pour ce bloc
-No recipe for this node=Aucune recette pour ce bloc
+No recipe or usage for this item=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

locale/craftguide.it.tr

@@ -0,0 +1,60 @@
+# textdomain: craftguide
+
+Craft Guide=Guida di assemblaggio
+Crafting Guide=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
+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 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/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/le ricetta/e del nodo puntato
+No node pointed=Nessun nodo puntato
+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.ru.tr

@@ -2,24 +2,18 @@
 
 Craft Guide=книга рецептов крафта
 Crafting Guide=книга рецептов крафта
-Crafting Guide Sign=
+Crafting Guide Sign=Знак с книгой рецептов
-Search=Поиск
-Reset=Сброс
-Previous page=Предыдущая страница
-Next page=Следущая страница
 Usage @1 of @2=использование  @1 из @2
 Recipe @1 of @2=Рецепт @1 из @2
 Burning time: @1=Время горения: @1
 Cooking time: @1=Время преготовления: @1
 Any item belonging to the group(s): @1=Любой элемент из группы: @1
-Recipe is too big to be displayed (@1x@2)=Рецепт слишком большой для показа (@1x@2)
+Recipe's too big to be displayed (@1x@2)=Рецепт слишком большой для показа (@1x@2)
-Shapeless=
+Shapeless=Бесформенный
-Cooking=
+Cooking=Приготовление
-Increase window size=Увеличить окно
-Decrease window size=Уменьшить окно
 No item to show=Нет элемента для показа
-Collect items to reveal more recipes=
+Collect items to reveal more recipes=Собирайте предметы, чтобы раскрыть больше рецептов
-Show recipe(s) of the pointed node=
+Show recipe(s) of the pointed node=Показать рецепт(ы) выбранной ноды
-No node pointed=
+No node pointed=Не указана нода
-You don't know a recipe for this node=
+You don't know a recipe for this node=Вы не знаете рецепт для этой ноды
-No recipe for this node=
+No recipe for this node=Нет рецептов для этой ноды

locale/template

@@ -3,23 +3,63 @@
 Craft Guide=
 Crafting Guide=
 Crafting Guide Sign=
-Search=
+Bookmarks=
-Reset=
-Previous page=
-Next page=
 Usage @1 of @2=
 Recipe @1 of @2=
+No recipes=
+No usages=
 Burning time: @1=
 Cooking time: @1=
+Replaced by @1 on smelting=
+Replaced by @1 on burning=
+Replaced by @1 on crafting=
+Repairable by step of @1=
 Any item belonging to the group(s): @1=
-Recipe is 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 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 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=
+Recipe's too big to be displayed (@1x@2)=
 Shapeless=
 Cooking=
-Increase window size=
-Decrease window size=
 No item to show=
 Collect items to reveal more recipes=
 Show recipe(s) of the pointed node=
 No node pointed=
-You don't know a recipe for this node=
+You don't know a recipe or usage for this item=
-No recipe for this node=
+No recipe or usage for this item=
+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=

mod.conf

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

settingtypes.txt

@@ -1,5 +1,5 @@
 # The progressive mode shows recipes you can craft from items you ever had in your inventory.
-craftguide_progressive_mode	(Progressive Mode)	bool false
+craftguide_progressive_mode    (Learn crafting recipes progressively)    bool false
 
 # Integration in the default Minetest Game inventory.
-craftguide_sfinv_only		(Sfinv only)		bool false
+craftguide_sfinv_only    (Crafting Guide in inventory only)    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"
+}