Add an API for custom recipes

This commit is contained in:
Jean-Patrick Guerrero
2018-12-16 23:20:54 +01:00
parent b2a7f5430a
commit 53833af635
2 changed files with 205 additions and 105 deletions

View File

@ -3,13 +3,36 @@
#### `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.
This crafting guide features a **progressive mode**.
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`.
`craftguide` is also integrated in `sfinv` (Minetest Game inventory) when you enable it with
`craftguide_sfinv_only = true` in `minetest.conf`.
Use the command `/craft` to show the recipe(s) of the pointed node.
---
`craftguide` has an API to register **custom recipes**. Demos:
#### Registering a custom crafting type ####
```Lua
craftguide.register_craft_type("digging", {
description = S("Digging"),
icon = "default_tool_steelpick.png",
width = 1,
})
```
#### Registering a custom crafting recipe ####
```Lua
craftguide.register_craft({
type = "digging",
output = "default:cobble",
items = {"default:stone"},
})
```
![Preview2](https://i.imgur.com/bToFH38.png)