Fzzy Config

Toml Annotations

TomlKt, the library that powers Fzzy Config's serializer, provides annotations for augmenting .toml files.

AnnotationDocs LinkDescription
@Comment
@TomlComment
Docs 🗗Adds a comment to the file. Also, if no description translation is provided, Fzzy Config will use this comment in the in-game tooltip
@Inline
@TomlInline
Docs 🗗Forces the annotated list or map to be single-line in the file
@BlockArray
@TomlBlockArray
Docs 🗗Modifies the encoding process of the array-like property, either to force it to be encoded as a block array, or to change how many items should be encoded per line
@MultilineString
@TomlMultilineString
Docs 🗗Marks that the string property is multiline
@LiteralString
@TomlLiteralString
Docs 🗗Marks the string property as a literal in the output file. This means it will have single quotes 'C:\Users\<User>\.m2\repositories' and escaping won't be performed by the parser
@Integer
@TomlInteger
Docs 🗗
Defines the visual format of an integer-like property (byte, short, int, long)
  • Base.Bin - binary 0b11010100
  • Base.Oct - octal 0o81244
  • Base.Dec - standard decimal form
  • Base.Hex - hexadecimal 0xFF342B6A