Repository navigation
Guide Page Format
Guide pages are all written in a subset of markdown.
(Most of this page needs filling out, however here is a list of basic tags)
Every tag has is in the form <name arguments/> - where the name is the tag name, and the ending '/' signifies that this tag is by itself. Some tags also have arguments in the form of "key-value pairs", for example:
"level"="42"<new_page/> will move the content after it to the next page.
These will make a link to another guide book page, using the title and icon from that linked page. Alternatively you can make a link to an ItemStack or Statement even if they don't have an existing guide book page. For example:
<link to="buildcraftunofficial:config/json_insn_format"/>will result in: JSON Instruction Format
or:
<link to="minecraft:iron_ingot" type="item_stack"/>will result in: Iron Ingot
<chapter/> will create a "chapter heading", that's displayed in the chapter list as a coloured heading. It has one possible argument: "level", which must be an integer that's 0 or greater. Alternatively you can use multiple hash symbols (#) just like normal markdown format to create headings. The number of #'s (minus one) equals the level of the heading. For example:
### Level 3 chapter
<chapter name="Another level 3 chapter" level="2"/>will result in:
All of these must surround some content: and they must have both a starting tag <italic> and an ending tag </italic> They all affect the contained text between the starting and end tags.
- italic
- bold
- underlined
strikethrough- red
- black
- dark_blue
- dark_green
- dark_aqua
- dark_red
- dark_purple
- gold
- gray
- dark_gray
- blue
- green (green)
- aqua (aqua)
- light_purple
- yellow (yellow)
- white (white)
It is not a good idea to use green, aqua, yellow, or white because it is generally very difficult to see any of those colours on the page.
All of the following tags are option based, and can be enabled or disabled by the player.
If the "Show Lore [ ]" box is ticked then everything in the <no_lore> tag will be hidden, otherwise everything in the <lore> tag will be hidden.
The lore tag should be used to show "in-game" guide information, narrated from the perspective of the player. (As if they were actively researching how everything worked). The inverse is for a more formal, wikipedia-like tone used to convey the information, pure and simple.
This is enabled by default in-game, and always disabled in exports.
If the "Show Hints [ ]" box is ticked then everything in the <no_hint> tag will be hidden, otherwise everything in the <hint> tag will be hidden.
The hint tag should be used to show extra "hints" that the described thing can be used for, or different ways of using it in combinations with other blocks/items. Essentially this is for "recommended usages" of different things. (As working this out is part of the fun it is not required. As such this is disabled by default, but toggle-able in-game and planned to be toggle-able when exported.
If the "display.guideBookEnableDetail" configuration option is set to "true" then everything in the <no_detail> tag will be hidden, otherwise everything in the <detail> tag will be hidden.
The detail tag should be used to show all of the numbers used when calculating various things, like pipe flow rate, extraction rate, pulse rate, etc.
This is disabled by default, but toggle-able in-game and planned to be toggle-able when exported.
This tag shows the first recipe found for the given item stack. For example:
<recipe stack="buildcraftunofficial:gear_stone"/>Recipe
| Stone Crafting Materials | ||
| Stone Crafting Materials | Wooden Gears | Stone Crafting Materials |
| Stone Crafting Materials |
→ 
Stone Gear
Ingredients: Stone Crafting Materials (any) · Wooden Gears (any)
You can also pin one specific recipe by its registry id with the id attribute. Use this when matching by item stack can't single out the recipe you want — for example a crafting recipe whose output carries data components (a specific gate variant), which the component-aware output match won't surface from a bare item stack:
<recipe id="buildcraftunofficial:gate_basic"/>| Brick | ||
| Brick | Redstone | Brick |
| Cobblestone |
→ Gate
Ingredients: Brick · Redstone · Cobblestone
Add type="assembling" to pin an Assembly Table recipe instead, looked up by its registry name (rather than a crafting recipe's ResourceLocation). This lets a page interleave a gate's crafting and assembly recipes in a deliberate order:
<recipe id="gate-and-IRON-NO_MODIFIER" type="assembling"/>recipe_cycle folds a family of near-identical recipes into a single panel that cycles through them in lock-step — the inputs, output and (for assembly) the MJ cost all advance to the next recipe together. Use it to collapse, say, a gate's AND and OR variants, or a whole set of swap recipes, into one compact animated entry instead of many. Select the recipes with match — a substring tested against each recipe's id (or, with type="assembling", its registry name). Below, one panel cycles the Iron Gate's AND and OR assembly recipes (match="-IRON-NO_MODIFIER" selects both):
<recipe_cycle type="assembling" match="-IRON-NO_MODIFIER"/>This tag shows all recipes for the given item stack. For example:
<recipes stack="buildcraftunofficial:gear_wood">Recipe
| Wooden Rods | ||
| Wooden Rods | Wooden Rods | |
| Wooden Rods |
→ 
Wood Gear
Ingredients: Wooden Rods (any)
Similar to recipes, this shows all usages for the given item stack. For example:
<usages stack="buildcraftunofficial:engine_redstone">This effectively combines the above two tags into one, for example:
<recipes_usages stack="buildcraftunofficial:pipe_structure">Crafting
| Normal Cobblestones | Gravel | Normal Cobblestones |
→ 
Cobblestone Structure Pipe ×8
Ingredients: Normal Cobblestones (any) · Gravel
Used to craft: Pipe Plug, Pipe Power Adaptor
This shows groups appropriate for the given item, statement, etc.
This shows an image. There are 3 arguments:
- src: The source location for the image.
- width: The width that the image will be shown with. Defaults to the width of the source image (however this might not be what you want)
- height: The height that the image will be shown with.
For example:
<image src="buildcraftunofficial:item/wrench" width="64" height="64"/>