Few minor optimizations

Misc. fixes and refactors

.luacheckrc

@@ -6,4 +6,5 @@ read_globals = {
 	"default",
 	"sfinv",
 	"sfinv_buttons",
+	"vector",
 }

LICENSE

@@ -1,9 +0,0 @@
-« Copyright © 2015-2018, Jean-Patrick Guerrero <jeanpatrick.guerrero@gmail.com>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders X be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
-
-Except as contained in this notice, the name of the <copyright holders> shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from the <copyright holders>. »

README.md

@@ -1,15 +1,82 @@
-## ![Preview1](http://i.imgur.com/fIPNYkb.png) Crafting Guide ##
+# ![Preview1](http://i.imgur.com/fIPNYkb.png) Crafting Guide
 
-#### `craftguide` is the most comprehensive crafting guide on Minetest. ####
-#### Consult the [Minetest Wiki](http://wiki.minetest.net/Crafting_guide) for more details. ####
+#### `craftguide` is the most comprehensive crafting guide on Minetest.
+#### Consult the [Minetest Wiki](http://wiki.minetest.net/Crafting_guide) for more details.
 
-#### This crafting guide is usable with a blue book named *"Crafting Guide"* ####
+This crafting guide is a blue book named *"Crafting Guide"* or a wooden sign.
 
-#### This crafting guide features two modes : Standard and Progressive. ####
-The Progressive mode is a Terraria-like system that only shows recipes you can craft from items in inventory.
-The progressive mode can be enabled with `craftguide_progressive_mode = true` in `minetest.conf`.
+This crafting guide features a **progressive mode**.
+The progressive mode is a Terraria-like system that only 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) when you enable it with
+`craftguide` is also integrated in `sfinv` (Minetest Game inventory). To enable it:
 `craftguide_sfinv_only = true` in `minetest.conf`.
 
-![Preview2](http://i.imgur.com/3q7rVSo.png)
+Use the command `/craft` to show the recipe(s) of the pointed node.
+
+![Preview2](https://i.imgur.com/bToFH38.png)
+
+---
+
+## API
+
+### Custom recipes
+
+#### Registering a custom crafting type
+
+```Lua
+craftguide.register_craft_type("digging", {
+	description = "Digging",
+	icon = "default_tool_steelpick.png",
+})
+```
+
+#### Registering a custom crafting recipe
+
+```Lua
+craftguide.register_craft({
+	type   = "digging",
+	width  = 1,
+	output = "default:cobble 2",
+	items  = {"default:stone"},
+})
+```
+
+### Recipe filters
+
+Recipe filters can be used to filter the recipes shown to players. Progressive
+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
+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`.
+
+Example function to hide recipes for items from a mod called "secretstuff":
+
+```lua
+craftguide.add_recipe_filter("Hide secretstuff", function(recipes)
+	local filtered = {}
+	for _, recipe in ipairs(recipes) do
+		if recipe.output:sub(1,12) ~= "secretstuff:" then
+			filtered[#filtered + 1] = recipe
+		end
+	end
+
+	return filtered
+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.get_recipe_filters()`
+
+Returns a map of recipe filters, indexed by name.

depends.txt

@@ -1,3 +1,3 @@
 sfinv?
 sfinv_buttons?
-intllib?
+intllib?

license.txt

@@ -0,0 +1,58 @@
+License of source code
+----------------------
+
+The MIT License (MIT)
+
+Copyright (c) 2015-2019 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+
+Licenses of media (textures)
+----------------------------
+
+Copyright © Diego Martínez (kaeza): craftguide_*_icon.png (CC BY-SA 3.0)
+
+You are free to:
+Share — copy and redistribute the material in any medium or format.
+Adapt — remix, transform, and build upon the material for any purpose, even commercially.
+The licensor cannot revoke these freedoms as long as you follow the license terms.
+
+Under the following terms:
+
+Attribution — You must give appropriate credit, provide a link to the license, and
+indicate if changes were made. You may do so in any reasonable manner, but not in any way
+that suggests the licensor endorses you or your use.
+
+ShareAlike — If you remix, transform, or build upon the material, you must distribute
+your contributions under the same license as the original.
+
+No additional restrictions — You may not apply legal terms or technological measures that
+legally restrict others from doing anything the license permits.
+
+Notices:
+
+You do not have to comply with the license for elements of the material in the public
+domain or where your use is permitted by an applicable exception or limitation.
+No warranties are given. The license may not give you all of the permissions necessary
+for your intended use. For example, other rights such as publicity, privacy, or moral
+rights may limit how you use the material.
+
+For more details:
+http://creativecommons.org/licenses/by-sa/3.0/