Package net.runelite.client.plugins

Annotation Type PluginDescriptor

@Retention(RUNTIME)
@Target(TYPE)
@Documented
public @interface PluginDescriptor

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	configName	Internal name used in the config.
String[]	conflicts	A list of plugin names that are mutually exclusive with this plugin.
String	description	A short, one-line summary of the plugin.
boolean	developerPlugin
boolean	enabledByDefault	If this plugin should be defaulted to on.
boolean	hidden	Whether or not plugin is hidden from configuration panel
String	internalName	The internal-name of a Plugin Hub plugin as used in the PluginHub repository.
String	legacyDataDirectory	The subpath of .runelite this plugin that should be migrated to the plugin's plugin directory.
boolean	loadInSafeMode
String[]	tags	A list of plugin keywords, used (together with the name) when searching for plugins.

Element Detail

name

String name

configName

String configName

Internal name used in the config.

Default:

""

description

String description

A short, one-line summary of the plugin.

Default:

""

tags

String[] tags

A list of plugin keywords, used (together with the name) when searching for plugins. Each tag should not contain any spaces, and should be fully lowercase.

Default:

{}

conflicts

String[] conflicts

A list of plugin names that are mutually exclusive with this plugin. Any plugins with a name or conflicts value that matches this will be disabled when this plugin is started

Default:

{}

enabledByDefault

boolean enabledByDefault

If this plugin should be defaulted to on. Plugin-Hub plugins should always have this set to true (the default), since having them off by defaults means the user has to install the plugin, then separately enable it, which is confusing.

Default:

true

hidden

boolean hidden

Whether or not plugin is hidden from configuration panel

Default:

false

internalName

String internalName

The internal-name of a Plugin Hub plugin as used in the PluginHub repository. This value must be all lowercase and snake-cased

Default:

""

legacyDataDirectory

String legacyDataDirectory

The subpath of .runelite this plugin that should be migrated to the plugin's plugin directory.

Default:

""

developerPlugin

boolean developerPlugin

Default:

false

loadInSafeMode

boolean loadInSafeMode

Default:

true