README.md
1# mcitem plugin for DokuWiki
2Adds Minecraft item link with icon
3
4All documentation for this plugin can be found at
5https://github.com/drcrazy/mcitem
6
7If you install this plugin manually, make sure it is installed in
8lib/plugins/mcitem/ - if the folder is called different it
9will not work!
10
11Please refer to http://www.dokuwiki.org/plugins for additional info
12on how to install plugins in DokuWiki.
13
14## Concept
15
16Every mod (that is [Minecraft Forge](http://www.minecraftforge.net/)'s way of talking about extensions) has its own sub-space in the wiki.
17
18Every mod's sub-space is located within the root space `:mods:`.
19
20Every image of a block or item is named exactly like its description page in the wiki. And is provided as PNG.
21
22*Example: The vanilla block Smooth Stone would have its page on `:mods:minecraft:stone`.*
23
24*Example: The vanilla block Smooth Stone would have an image under `:mods:minecraft:stone.png`.*
25
26## Usage
27
28Anywhere on a wiki page you can add the mcitem tag and specify item inside this tag in format 'modname':'itemname', for example, 'minecraft:redstone' which will result in a link to your wiki page about redstone with redstone icon prepended.
29
30## Credits
31
32Plugin inspiration and major part of readme is from mcrecipe Dokuwiki plugin made by [cryxli](https://github.com/cryxli)
33
