Package dev.twilite.client.plugins

Annotation Interface PluginDescriptor

@Retention(RUNTIME) @Target(TYPE) @Documented public @interface PluginDescriptor
Declares plugin metadata used for discovery, configuration UI, and optional overlay binding.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    Human-readable plugin name.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<? extends Config>
    config
    Config class rendered for this plugin.
    String
    configName
    Optional alternate name used by configuration storage and UI grouping.
    String
    description
    Short description shown in plugin lists.
    boolean
    enabledByDefault
    Whether the plugin should be enabled for new users by default.
    boolean
    hidden
    Whether the plugin should be hidden from normal plugin lists.
    Class<? extends OverlayBinding>
    overlay
    Overlay binding class registered while this plugin is active.
    String[]
    tags
    Search tags used by plugin UI filtering.
    String
    version
    Human-readable plugin version.

  • Element Details

    • name

      String name
      Human-readable plugin name.

    • configName

      String configName
      Optional alternate name used by configuration storage and UI grouping.
      Default:
      ""

    • version

      String version
      Human-readable plugin version.
      Default:
      "1.0.0"

    • description

      String description
      Short description shown in plugin lists.
      Default:
      ""

    • tags

      String[] tags
      Search tags used by plugin UI filtering.
      Default:
      {}

    • enabledByDefault

      boolean enabledByDefault
      Whether the plugin should be enabled for new users by default.
      Default:
      true

    • hidden

      boolean hidden
      Whether the plugin should be hidden from normal plugin lists.
      Default:
      false

    • config

      Class<? extends Config> config
      Config class rendered for this plugin.
      Default:
      dev.twilite.client.config.Config.class

    • overlay

      Class<? extends OverlayBinding> overlay
      Overlay binding class registered while this plugin is active.
      Default:
      dev.twilite.client.ui.Overlay.class