forked from minetest-mods/craftguide
83 lines
2.2 KiB
Markdown
83 lines
2.2 KiB
Markdown
#  Crafting Guide
|
|
|
|
#### `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 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 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). To enable it:
|
|
`craftguide_sfinv_only = true` in `minetest.conf`.
|
|
|
|
Use the command `/craft` to show the recipe(s) of the pointed node.
|
|
|
|
|
|
|
|
---
|
|
|
|
## 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.
|