---
title: Config Annotations
---

Fzzy Config provides a suite of Annotations for spicing up a config. All annotations are covered in the official documentation as well.

[Annotation Documentation 🗗](https://fzzyhmstrs.github.io/fconfig/-fzzy%20-config/me.fzzyhmstrs.fzzy_config.annotations/index.html)

## <div><AtSignIcon height={26} width={22} style={{display: "inline", color: "#B2BFF9", paddingTop: "4px", verticalAlign: "top"}} /> Config Annotations</div>
Augment the functionality of your configs with these annotations. The currently available list of annotations is:
* [`@ClientModifiable`](annotations/Client-Modifiable) - Marks setting as editable regardless of permissions
* [`@WithPerms`](annotations/With-Perms) - Defines the permission level needed to edit marked settings
* [`@WithCustomPerms` and `@AdminLevel`](annotations/With-Custom-Perms) - Defines permissions in LuckPerms/Forge Permissions API string-based style; optionally falling back to vanilla permissions.
* [`@NonSync`](annotations/Non-Sync) - Defines a field as client-only. Won't sync to/from servers and no permission checks
* [`@Version`](annotations/Version) - Sets the version of a config class, used for version-managed updates
* [~~`@RequiresRestart`~~](annotations/Requires-Restart) - (Deprecated as of 0.4.0) Prompts a user to restart after syncing
* [`@RequiresAction`](annotations/Requires-Action) - (As of 0.4.0) Alerts the user to a needed action if they change the affected setting. Applies to fields and classes.
* [`@RootConfig`](annotations/Root-Config) - Sets the annotated config as the "root", displaying its settings in the landing page alongside the other config buttons.
* [`@ConvertFrom`](annotations/Convert-From) - Specifies an old config file to scrape and convert into a Fzzy Config toml
* [`@IgnoreVisibility`](annotations/Ignore-Visibility) - Marked classes can have fields/properties with lower visibility than public
* [`@Translation`](annotations/Translation) - Defines a custom lang prefix for a setting or whole config
* [`Toml Annotations`](annotations/Toml-Annotations) - Annotations for augmenting config .toml files.