Skip to main content

Wiki Guidelines

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​

Wiki content split into several sections:

  • Items - Tech Reborn items. Including cells, dusts, ingots, parts, etc.
  • Blocks - Tech Reborn blocks. Including machine frames/casings, storage/tank units, etc.
  • World - World Generation related things, like ores, trees, NPCs.

Syntax​

This wiki with Docusaurus and use Markdown syntax for pages. There is a comprehensive documentation on possible formatting options.

Page Structure​

Pages should start with Front Matter.

---
title: <Some page Title. It will become H1 tag on the page and also will be used in SideBar>
sidebar_position: <Some number, including float. Optional. Could be used to better sort pages in SideBar
---

More fields for Front Matter documented here.

Most of pages have big righ-aligned item image just below page title. We have custom component for that image

<ItemImage 
    file="<file name without extension for a file in /static/img/techreborn folder>" 
    alt="<Alt text for image>" 
    size="<Size in pixels for image.>" />

Here is an example of ItemImage.

<ItemImage file="rubber_sapling" alt="Rubber Sapling" size="200" />

will be shown as:

Rubber Sapling

Please, use headings to structure page content. Table of Content for a page will be generated automatically based on heading.

Custom Components​

Here's a list of custom components and how to use them.

McItem​

The base of most item references. If you want to refer to an item in your page, you should probably be using this tag. It brings in an image and automatically does some other nice things too (hopefully).

<McItem slug="aluminum_ingot" pack="techreborn"/>

The slug is the name of the file in /static/imgs/techreborn/ without the file extension. We also use the slug to find the correct page in the index and to render the friendly name of the item. Slug can also be the old format of pack:slug instead of passing the pack on its own. The pack is the content pack that this item originates from. Supported packs at the moment are:

  • minecraft: for the base game
  • techreborn: for this modpack

Tip!

If you use VSCode, you can use find and replace with regex and simplify this inside of a file:

  • Find: \\<mcitem\\>(.*?)\\<\/mcitem\\>
  • Replace: <McItem slug="$1"/>

CraftingTable​

This is largely meant to take recipes from the previous generation of wiki and display them in a somewhat nice interface.

<CraftingTable recipe="input techreborn:aluminum_nugget techreborn:aluminum_nugget techreborn:aluminum_nugget input techreborn:aluminum_nugget techreborn:aluminum_nugget techreborn:aluminum_nugget input techreborn:aluminum_nugget techreborn:aluminum_nugget techreborn:aluminum_nugget output techreborn:aluminum_ingot" />

The recipe is meant to be a drop in replacement for the previous version of the wiki, but this doesn't mean you can't handwrite a recipe. I'm showing a broken down example below, but when you do it for real, use spaces between your items, not newlines.

input
air
air
air
input
air
minecraft:coal
air
input
air
minecraft:stick
air
output
minecraft:torch,4

This would be the broken down recipe for torchs in the base game. Use air if you'd like nothing to be rendered in that grid position.

Tip!

If you use VSCode, you can use find and replace with regex and simplify this inside of a file:

  • Find: \\<recipe\\>(.*?)\\<\/recipe\\>
  • Replace: <CraftingTable recipe="$1"/>

Machine​

Machine is meant as a one-size-fits-all solution for crafting machines (including crafting table). You can pass in data to the component in two ones. One using the traditional recipe format:

<Machine recipe="input techreborn:sap output techreborn:rubber tool minecraft:furnace" />

You can also supply configuration in the new format:

<Machine config={{input: [
  {id: "techreborn:ashes", qty: 2},
  {id: "techreborn:empty_cell"}
], output: [
  {id: "techreborn:carbon_fiber_cell"}
], tool: "techreborn:industrial_electrolyzer"}} />

Both inputs and outputs can have quantities attached to them. If you don't include a quantity, it's assumed to be 1.