forked from rwtema/ExtraUtilities_Localization
-
Notifications
You must be signed in to change notification settings - Fork 0
/
NEI Documentation support.txt
33 lines (19 loc) · 1.79 KB
/
NEI Documentation support.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
As of 1.1.0c, I've expanded Extra Utilities NEI Documentation to support other mods automatically.
If you open your language file (commonly en_US.lang), your item/block entries will be in the form
<UnlocalizedName>.name=<Item Name>, so if you add
<UnlocalizedName>.documentation=<Item's description>
then it XU will automatically detect the entry and create a documentation page for it when the recipe/usage
command is called on an itemstack that matches that unlocalized name. The item info can be as long as
necessary and page and line breaks will be inserted automatically.
So for example, if you wish to add documentation for vanilla stone, the unlocalized name for stone is
"tile.stone.name". Thus you can add the following entry for "tile.stone.documentation", such as...
tile.stone.documentation=Stone is the most common block in the overworld, and makes up most of the underground area. It holds valuable ores and gems for you to mine and collect. You cannot mine with your bare hands though, since stone is too hard, and you must use a pickaxe. Mining a stone block will break the blocks structure and give you cobblestone. Cobblestone can be smelted in a furnace to give your regular stone back.
...and this entry will automatically be added to the NEI documentation.
For further examples, see the Extra Utilities en_US.lang.
Additional Features
You can use either the itemstack-specific version of unlocalizedname or the generic version. If an item has
entries for both, it will default to the itemstack-specific version.
If you wish to include manual page breaks, creat seperate entries for the documentation in the form:
<UnlocalizedName>.documentation.0=<Item's description: page 1>
<UnlocalizedName>.documentation.1=<Item's description: page 2>
<UnlocalizedName>.documentation.2=<Item's description: page 3>