Descriptions and Formatting

Descriptions are the core feature of EID. They describe the effect of the item in a short, precise and easy to understand way.

Do's and Dont's

• Keep it short but precise!
• Don`t be vague or "mysterious" > Descriptions should always tell exactly what the item does. Keep the other stuff in the XML descriptions!
• Important effects on top, minor stuff at the end
• Keep descriptions reader friendly:
  • Short sentences or keynotes
  • Easy language
  • No "if X or Y then maybe Z or W but only when L"
• Use Markup:
  • Positive Effects should start with a "↑" arrow, negative ones with a "↓" arrow
  • Use Icons to help understand effects faster or shorten certain texts
  • Use colors to highlight words or effects
• Don`t tell stories or lore

Descriptions and Formatting

Descriptions are defined using a single string.

New Lines

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"

Editing Bulletpoints.

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:

1. Default bulletpoint -- Line doesnt start with something special. Normal bulletpoint will be rendered
2. ↑ space after icon -- Line starts with markup. Use Markup icon as bulletpoint icon
3. ↓no space after icon -- No space after icon will render the icon at the start of the text, rather than as a bulletpoint
4. {{Heart}} a custom icon as bulletpoint -- Same as 2. but with an explicit icon markup definition
5. {{Blank}} -- (a Line with only a {{Blank}} in it) Renders an empty line without bulletpoint or text. Good for spacing things
6. {{Blank}} A line without a bulletpoint -- Renders the text without any bulletpoint

Markup and inline icons

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.

>>> More about Markup <<<