craftguide/README.md

39 lines
1.2 KiB
Markdown
Raw Normal View History

2016-12-18 15:30:39 +01:00
## ![Preview1](http://i.imgur.com/fIPNYkb.png) Crafting Guide ##
2016-02-21 00:42:52 +01:00
2018-11-11 22:24:48 +01:00
#### `craftguide` is the most comprehensive crafting guide on Minetest. ####
#### Consult the [Minetest Wiki](http://wiki.minetest.net/Crafting_guide) for more details. ####
2016-02-21 09:52:59 +01:00
2018-12-16 23:20:54 +01:00
This crafting guide is a blue book named *"Crafting Guide"* or a wooden sign.
2016-02-21 09:52:59 +01:00
2018-12-16 23:20:54 +01:00
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.
2016-12-18 15:30:39 +01:00
The progressive mode can be enabled with `craftguide_progressive_mode = true` in `minetest.conf`.
2018-11-11 22:24:48 +01:00
`craftguide` is also integrated in `sfinv` (Minetest Game inventory) when you enable it with
`craftguide_sfinv_only = true` in `minetest.conf`.
2018-12-16 23:20:54 +01:00
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"},
})
```
2018-11-25 15:51:01 +01:00
![Preview2](https://i.imgur.com/bToFH38.png)