Differences

This shows you the differences between two versions of the page.

--- development:wiki [2020/01/24 21:42] – external edit 127.0.0.1
+++ development:wiki [2021/06/21 12:50] – [Minecraft Recipes] switch to recipe with air as better example wdavery
@@ Line 1: / Line 1: @@
-====== Wiki guideline for editors ======
+====== Wiki Guidelines for Editors ======
 First of all, thank you for your efforts to make this wiki better. Seriously, with a lot of blocks and items it is near to impossible for developers to keep wiki up-to-date.
 \\
 ===== Wiki Structure =====
-In order to have breadcrumbs we have 3 major sections: Items, Blocks and Energy. While Energy section contains information about blocks it servers purpose to not bloat Blocks section too much.
+In order to have breadcrumbs we have 3 major sections:\\
-This approach introduce kind of burden to create page for a particular block or item twice. First page - with content with one of above mentioned major section. Second page is redirect required by plugins used to help with items and recipes.
+**Energy** - Any item or block that uses power. Including cables, generators, batteries, machines, and powered tools.\\
+**Items** - Non-power related items. Including cells, dusts, ingots, parts, etc.\\
+**Blocks** - Non-power related blocks. Including ores, machine frames/casings, storage/tank units, etc.
-===== MC specific plugins =====
+Each item or block will require two pages:\\
-Couple words about these specific plugins we use:
+. A redirect page at its //mods:namespace:item_name// location (see below at #Minecraft_Items)\\
+. A content page in one of the three sections above
+===== Plugins =====
+There are two plugins that provide extra Minecraft specific features:
+==== Minecraft Items ====
+Allows you to insert a fancy link to a block or item
-) Minecraft item plugin allows you to insert fancy link to block or item.
 Syntax:
 <code> <mcitem>namespace:item_name</mcitem> </code>
-namespace is either "minecraft" for vanilla items or "techreborn" for TR items and in general stands from mod name.
+//namespace// is “minecraft” for vanilla or the mod name\\
-\\
+//item_name// is the registry name for an item
-item_name is a registry name for an item. Same as in .json recipes, for example. Or in advanced tooltip withing MC.
-\\
+Example:
-Plugin will automatically generate link to a page like mods:techreborn:item_name. That page should have redirect to a page with real content.
+<code><mcitem>minecraft:iron_ore</mcitem>
+<mcitem>techreborn:copper_ore</mcitem>
+</code>
+Produces:
+<mcitem>minecraft:iron_ore</mcitem>
+<mcitem>techreborn:copper_ore</mcitem>
+This will automatically generate a link to a page //mods:namespace:item_name//.
+That page requires a redirect to the page with real content following wiki structure.\\
+**There should be no content besides redirects under //mods://**
 Redirect syntax for items is:
-<code>~~REDIRECT>items:item_name~~</code>
+<code>~~REDIRECT>namespace:item_name~~</code>
-Replace "items" with "blocks" or "energy" to redirect to a proper section.
+Where //namespace// is likely “items”, “blocks” or “energy”.\\
+Can also be nested, like “energy:generators:generator”.
-) Minecraft recipe plugin
+==== Minecraft Recipes ====
-Syntax:
+Allows for pretty formatted recipes
+Example Crafting Table recipe:
+<code>
+<recipe>
+input air minecraft:stick air
+input minecraft:wood_planks minecraft:wood_planks minecraft:wood_planks
+input minecraft:wood_planks air air
+output techreborn:treetap
+</recipe>
+</code>
+Produces:
+<recipe>
+input air minecraft:stick air
+input minecraft:wood_planks minecraft:wood_planks minecraft:wood_planks
+input minecraft:wood_planks air air
+output techreborn:treetap
+</recipe>
+\\
+Example furnace recipe (note: size and tool are optional):
 <code>
 <recipe>
@@ Line 31: / Line 68: @@
 </recipe>
 </code>
-where size and tool are optional
+Produces:
+<recipe>
+size 1x1
+input minecraft:cobblestone
+output minecraft:stone
+tool minecraft:furnace
+</recipe>