How to add descriptions
Descriptions are the core feature of EID. They describe the effect of the item in a short, precise and easy to understand way.
Descriptions are defined using a single string.
New lines are added with the # Character.
Every new line starts with a bulletpoint indicator or an icon.
Example:
"Test description#A second line#A third line"
The bulletpoints infront of each line can be replaced with inline Markup Icons. The mod will try to read a markup string in the first position of a new line.
The markup needs to be followed by a space!
Example:
Description:"Some text#↑ Some text#↓Some text#{{Heart}} Some text#{{Blank}}#{{Blank}} Some text"
Explanation of the lines:
-
Default bulletpoint-- Line doesnt start with something special. Normal bulletpoint will be rendered -
↑ space after icon-- Line starts with markup. Use Markup icon as bulletpoint icon -
↓no space after icon-- No space after icon will render the icon at the start of the text, rather than as a bulletpoint -
{{Heart}} a custom icon as bulletpoint-- Same as 2. but with an explicit icon markup definition -
{{Blank}}-- Renders an empty line without bulletpoint or text. Good for spacing things -
{{Blank}} A line without a bulletpoint-- Renders the text without any bulletpoint
Every text rendered with EID does support the usage of the custom "Markup" of the mod. This allows mods to render icons and colored text inside their descriptions and objectnames.