README.md
1<p align="center">
2 <img src="local/logo.png" width=100 height=100 />
3</p>
4
5<div align="center"><h1>minecraftrecipe</h1></div>
6
7<div align="center">
8A DokuWiki plugin to render minecraft recipe previews on your wikis. Useful for modders, servers, and other blockgame enthusiasts.
9</div>
10<br></br>
11
12# Table of Contents
13- [Installation](#installation)
14- [Usage](#usage)
15 - [Syntax](#syntax)
16 - [Items](#items)
17 - [Item Groups](#item-groups)
18- [Extension Commands](#extension-commands)
19- [License](#license)
20- [Disclaimer](#disclaimer)
21
22# Installation
23Run `git clone https://github.com/tlm9201/dokuwiki-plugin-minecraftrecipe minecraftrecipe` under your DokuWiki plugins directory.
24
25Login as admin and ensure it is enabled in the extensions manager.
26
27# Usage
28
29DokuWiki currently supports 3 recipe types, `crafting`, `smelting`, and `brewing`.
30
31The type is specified using the `type` tag:
32```xml
33<recipe type="crafting">
34</recipe>
35```
36
37## Syntax
38
39The syntax for each type is as follows:
40
41### Crafting
42```xml
43<recipe type="crafting">
44slot_0 slot_1 slot_2
45slot_3 slot_4 slot_5
46slot_6 slot_7 slot_8
47-> result
48</recipe>
49```
50
51### Smelting
52```xml
53<recipe type="smelting">
54input
55fuel
56-> result
57</recipe>
58```
59
60### Brewing
61```xml
62<recipe type="brewing">
63reagent
64-> potion_0 potion_1 potion_2
65</recipe>
66```
67
68## Items
69Items are defined under `./images/item/item_id.png`.
70For air, use `empty` or `x`.
71
72For example, the recipe for a diamond block would be:
73```xml
74<recipe type="crafting">
75diamond diamond diamond
76diamond diamond diamond
77diamond diamond diamond
78-> block_of_diamond
79</recipe>
80```
81
82> Note that if the specified item id cannot be found, it will fallback to minecraft.wiki and attempt to lookup the sprite there. Assets on minecraft.wiki are case sensitive.
83
84## Item Groups
85Groups of items are declared using commas.
86
87For example, a boat using different wood types.
88(Yes it can be a little verbose).
89```xml
90<recipe type="crafting">
91x x x
92Oak_Planks,Spruce_Planks,Birch_Planks x Oak_Planks,Spruce_Planks,Birch_Planks
93Oak_Planks,Spruce_Planks,Birch_Planks Oak_Planks,Spruce_Planks,Birch_Planks Oak_Planks,Spruce_Planks,Birch_Planks
94-> Oak_Boat,Spruce_Boat,Birch_Boat
95</recipe>
96```
97
98Output:
99
100<img src="local/group-prev.gif" width = 250 height = 125 />
101
102# License
103```
104dokuwiki-plugin-minecraftrecipe Copyright (C) 2025 tlm920
105
106 This program is free software: you can redistribute it and/or modify
107 it under the terms of the GNU General Public License as published by
108 the Free Software Foundation, either version 3 of the License, or
109 (at your option) any later version.
110
111 This program is distributed in the hope that it will be useful,
112 but WITHOUT ANY WARRANTY; without even the implied warranty of
113 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
114 GNU General Public License for more details.
115
116 You should have received a copy of the GNU General Public License
117 along with this program. If not, see <https://www.gnu.org/licenses/>.
118```
119
120## Disclaimer
121I am in no way affiliated with Mojang Studios, nor am I endorsed by Mojang Studios.
122All assets under `./images` and its subdirectories are intellectual property of Mojang Studios.
123
124Minecraft ®/TM, Mojang Studios / Notch © 2009-2025
