Skip to content

Guide Terminal

brachy84 edited this page Aug 12, 2021 · 5 revisions

The Guide Terminal is an item that can show tutorials and guides for items, machines or literally anything.

To create guides in an addon or as pack maker you will need a simple text editor to edit JSON files.

Adding a guide

The root path is assets/gregtech/terminal/guide/, then depending on what app you want to add a guide to create a subfolder. The defaults are items, machines, multiblocks and tutorials. Then you want to create a another folder named after the preferred lang code f.e. en_us. The files can have any name or can be in any sub directory after the lang folder.
At the end you might end up with something like this assets/gregtech/terminal/guide/items/en_us/tools/wrench.json

The JSON will need some parameters.
section will set the category of the guide. You can use / to to set sub sections
title will set the Title of the guide. Can be a lng key

Item Guide App

item set the item of the guide f.e. "minecraft:iron_ingot:<meta>". meta is optional
metaitem set the item of the guide. f.e. "tool.wrech"

Multiblocks guide app

You can use multiblock or metatileentity to set the meta tile entity. Has to be a mte id. f.e. "multiblock": "gregtech:electric_furnace.lv"

Machine guide app

You can use machine, generator or metatileentity to set the meta tile entity. Has to be a mte id. f.e. "machine": "gregtech:electric_furnace.lv"

Tutorial app

You can add a tutorial property (f.e. "tutorial": "some_test_tutorial"). By default it uses the title property.

After that you will need stream and fixed. This is where widgets are added.

For a guide on how to create widgets go here

Full example:

{
  "metaitem": "tool.wrench",
  "section": "items/tools",
  "title": "Wrench",
  "stream": [
  ],
  "fixed": [
  ]
}