In order to help users fully understand and appreciate your plugin, it’s important to provide them with relevant information about it. Unfortunately, if you don’t include any meta information, gw2cc will only be able to identify your plugin by the name of its folder. This means that it will be listed under the “Uncategorized” category in the plugin menu, and users will not have access to any additional information beyond the name of the folder.
Fortunately, you can easily remedy this by adding meta information to your plugin. By creating a [plugin]_meta.json file in the plugins directory, you can specify a nicely formatted “Display Name”, version number, and a meaningful description that will help users understand what your plugin is all about. To create this file, simply name it after your plugin (e.g. plugins/my_plugin_meta.json).
Minimal Example File #
{
"name": "Teleporter",
"category": "Tool",
"version": "1.0",
"author": "gw2cc",
"description": "The Teleporter plugin allows you to teleport to predefined coordinates across the map, or save your very own coordinates."
}Required Attributes #
- name – A descriptive name for your plugin. Unlike the name of your plugin folder, this name can include special symbols as well as spaces.
- category – The category of your plugin. This determines at which tab your plugin appears in the plugin menu
- version – The current version of your plugin. This should follow the MAJOR.MINOR.PATCH format.
- author – Your username.
- description – A meaningful description of your plugin. Will be displayed below the name. Can include BBCode.
Optional Attributes #
None yet.