Skip to content

Entry Tags

Jump to bottom
Endor H edited this page Nov 27, 2022 · 2 revisions

Simple Config entries can be tagged with any amount of EntryTags. In fact, some of Simple Config's features you may already know, such as entry help/error icons, entries that require a restart to take effect or the option to copy an entry's path are implemented using some built-in tags.

Adding tags to an entry

To add/remove tag from entries, you may use the withTags or withoutTags methods.

Built-in tags

Simple Config defines a few built-in tags:

  • REQUIRES_RESTART, managed by the restart method on entries. Flags entries that require a restart for modifications to take full effect. Users will be warned when saving modifications for these entries.
  • EXPERIMENTAL, flags an entry as experimental. Players will be warned when saving modifications for these entries. Use this for config entries related to experimental features, or entries that could cause bugs if modified.
  • ADVANCED, flags an entry as being intended for advanced users. Players will be warned when saving modifications for these entries.
  • OPERATOR, flags an entry as only relevant for server operators.
  • NON_PERSISTENT, managed by the temp and ignored methods on entries. Flags entries that do not appear in the config file, only in the menu, as they get reset on restarts.

In addition, Simple Config defines a few families of colored tags, which come in any of the 16 Minecraft colors:

  • TAGS, a classic tag shape
  • BOOKMARKS, a bookmark icon
  • WRENCHES, a wrench icon

At the moment, Simple Config only allows mod developers to tag entries, however, there are plans to allow players to use these generic tags in the future to mark different entries for easier access, or even for granular permissions.

Custom tags

You may create custom tags, with their own icon, config comment, tooltip hint and click action, using any of the static factory methods from EntryTag.

Entry tags also have a priority that determines how they're sorted when displayed in the menu. If you have any ideas for an entry tag that should be built-in, consider submitting an issue or a pull request.

If you have any doubts, feel free to drop by the official Discord Server.

Home

Clone this wiki locally