Help:Howto/Add a new plugin

To add a new plugin to Plugin list and Download pages you should do the following:

• Add the plugin to Template:Plugins as it is done for existing ones. Note that it is the plugin's filename (without .dll) to be added there.

• Update Template:PluginInfo. Information about the plugin can be found on Plugins page of Miranda options. Details on the parameters:

name=		Plugin name
filename=	(o) Use it if the name of the plugin file is other than name of the plugin itself.
screenshot=	Screenshot filename (Use *** if no screenshot is needed)
screenshotOpt = (o) Options for displaying the screenshot.
		If specified but empty default options (border|200px) will be removed.
		Specified options have to be separated by Template:! e.g. border{{!}}200px
author=		Plugin author
authors=	Plugin authors*
requirements=	(o) System requirements (e.g. necessary runtime libraries)

* Use Template:While to list all developers (see the example below)
(o) — parameter is optional

You might want to hide some download links in some cases (e. g. new plugins usually don't have stable versions until next stable Miranda NG is released). Use the appropriate "hide" parameter:

hide-s32=1	(o) to hide link for x32 stable version
hide-s64=1	(o) to hide link for x64 stable version
hide-l32=1	(o) to hide link for x32 latest version
hide-l64=1	(o) to hide link for x64 latest version
hide-stable=1	(o) to hide links for stable versions
hide-latest=1	(o) to hide links for latest versions
hideDownloadLinks=1	(o) to hide the default download links all at once

Also, some plugins might have download links that differ from the default ones. In this case the following parameters are used (see IM_Updater and Skype for example):

link-s32=	(o) to specify download link for 32-bit stable version
link-s64=	(o) to specify download link for 64-bit stable version
link-l32=	(o) to specify download link for 32-bit latset version
link-l64=	(o) to specify download link for 64-bit latset version
additionalLinks= (o) to specify download links for additional files or in other cases

Examples

link-s32=http://wiki.miranda-ng.org/x32/sampleplugin.zip
 but
additionalLinks=[http://wiki.miranda-ng.org/x32/sampleplugin.zip link text]

---

Example PluginInfo entry

|SamplePlugin = {{#hashdefine:{{#var:PluginFileName}} |name=Sample plugin;; screenshot=SamplePlugin.jpg;; authors={{while|tpl=Developer|Author 1|Author 2|Author 3}};; requirements=syslib.dll;; hide-s32=1;; hide-s64=1;; |;;|=}}

• Template:PluginDescription/* is the last to edit. This one is localization-dependent so update its version in your language. Add a short description of the plugin as it is done for existing ones. Usually the description from Plugins page of Miranda options is enough. See Template:PluginDescription/en for example.

• Each plugin has its own page for detailed description. To create a page for the newly added plugin go to Plugin list or Download page, select its version in your language and click the name of the new plugin (it will be written in red). Use any Plugin:<PluginFilename>/* page as example.

See also

• How to create new language