Decorative Components
Learn about the decorations that you can add to your configs to make them prettier!
Separation
Header
The header lets you write a title for the following options, helping you separate large mods. You might define all of your colors in a single section, titled "Colors". Or locate all of your HUD options together.
Custom Pages
Config pages can be used with the @Page annotation. You can specify an additional class that extends Page, which will be opened when clicked. Read more about Custom Pages for more information.
The enum PageLocation
describes the location of that page, which can either be TOP
or BOTTOM
.
Inline documentation
Info Line
Information lines can provide the user with extra context about something. Maybe warning the user of a potential issue or common problem you could encounter. It's got both single and dual-column variants. Read the designer's note to understand when this should be used.
Descriptions
When to use an info line over a description
Descriptions aren't always shown to the user, only when they hover over the text of an option. This means that if you're simply adding extra info about what something does, use that. Info lines should be for more crucial information, something you actually want them to read.
Last updated