Skip to content

Making a Configuration Class

zerocool edited this page Feb 7, 2026 · 4 revisions

@ConfigProperty

Any class can be used as a configuration class, as long as it contains at least one field annotated with the @ConfigProperty annotation. This annotation marks a field as a part of the configuration, and will be stored/loaded appropriately.

@Comment

The @Comment annotation can be used to add a comment above the property in the configuration file. To add a comment, add the line @Comment(comment = "COMMENT") filling the string with your actual comment.

Supported Types

Any types that are not listed here will be ignored
Every field MUST have a default value

  • byte/Byte
  • short/Short
  • int/Integer
  • long/Long
  • float/Float
  • double/Double
  • boolean/Boolean
  • String
  • Item
  • Block
  • StatusEffect

Clone this wiki locally