Small cleaning

This fixes instances where items are counted as part of a group by
craftguide but not by the engine.

.luacheckrc

@@ -10,3 +10,8 @@ read_globals = {
 	"string",
 	"table",
 }
+
+globals = {
+	"craftguide",
+	"core",
+}

API.md

@@ -2,6 +2,9 @@
 
 ### 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.
+
 #### Registering a custom crafting type (example)
 
 ```Lua
@@ -11,17 +14,35 @@ 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,
-	output = "default:cobble 2",
+	result = "default:cobble 2",
 	items  = {"default:stone"},
 })
 ```
 
+Recipes can also 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",
+})
+```
+
 ---
 
 ### Recipe filters
@@ -55,10 +76,6 @@ end)
 
 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.get_recipe_filters()`
 
 Returns a map of recipe filters, indexed by name.
@@ -70,10 +87,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 +136,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 +145,23 @@ 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.background`
+
+You can set a custom background theme by overriding this variable:
+
+```Lua
+craftguide.background = "<file_name.png>:<middle>"
+
+```
+
+`middle` (number) refers to a 9-sliced background. Read the engine's Lua API documentation for more info.

README.md

@@ -17,5 +17,4 @@ 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). 
 
 
-![Preview2](https://i.imgur.com/bToFH38.png)
+![Preview2](https://i.imgur.com/oGSvbTW.png)
-

depends.txt

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

locale/craftguide.de.tr

@@ -3,20 +3,14 @@
 Craft Guide=Rezeptbuch
 Crafting Guide=Rezeptbuch
 Crafting Guide Sign=Rezepttafel
-Search=Suche
-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
 Burning time: @1=Brennzeit: @1
 Cooking time: @1=Kochzeit: @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)
+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

locale/craftguide.fr.tr

@@ -2,20 +2,18 @@
 
 Craft Guide=Guide de recettes
 Crafting Guide=Guide de recettes
-Search=Rechercher
-Reset=Réinitialiser
-Previous page=Page précédente
-Next page=Page suivante
 Usage @1 of @2=Usage @1 de @2
 Recipe @1 of @2=Recette @1 de @2
 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)
+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é

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,20 +3,18 @@
 Craft Guide=
 Crafting Guide=
 Crafting Guide Sign=
-Search=
-Reset=
-Previous page=
-Next page=
 Usage @1 of @2=
 Recipe @1 of @2=
 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)=
+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=

mod.conf

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