Plugin requirements

From VuzeWiki
Jump to: navigation, search

If you are looking for a guide to writing plugins, you should look here (a section specifically about the plugin.properties file in the guide is mentioned here).

Example file:

plugin.class=azplugins.aizen.AizenPlugin
plugin.id=aizen
plugin.name=Aizen - Example Plugin
plugin.version=0.1
plugin.langfile=azplugins.aizen.messages.Messages

plugin.class[edit]

Required. The class file which implements the Plugin interface.

plugin.id[edit]

Required. A short string which will be the internal name for the plugin. This internal name gets used for various things by Azureus (it's used as a prefix for config settings used by the plugin, for example). Don't include the .java or .class file extension.

plugin.name[edit]

Required. A user-readable name for the plugin - this gets displayed in a few different places (like the Plugins page).

plugin.version[edit]

Required. The plugin version. The numbering scheme should be of the form <number>.<number>.<number> (as many components as you want) - as long as it increases from version to version. A version of 0.9 is smaller than 0.10.

plugin.langfile[edit]

Optional. The location of the language resource file (don't include the .properties file).

plugin.jdk.min_version[edit]

Optional. The minimum version of Java required (e.g. 1.6 or 6.0). Available since Azureus 3.0.5.0.

plugin.azureus.min_version[edit]

Optional. The minimum version of Azureus required (e.g. 3.1.1.0). Available since Azureus 3.1.1.1.