info.json

info.json

The info.json file contains all the information, like the plugin's name, a small description, and more! This file should be put in the root of your plugin's folder so it can be easily found by both other people and the server. If your plugin doesn't contain an info.json, it won't be loaded.

Basic Format

{
  "name": "plugin's name",
  "desc": "A small description",
  "author": "Author's name",
  "main": "my_file.py:my_parser_class"
}

Required Keys

• name - This is the plugin's name. Capitalize it where necessary. This will be shown to users when your plugin loads on server start or reload.
• desc - A small description. This shouldn't be much longer than a few words.
• author - Author's name. If possible, include contact information like email, website url, or twitter handle.
• main - The main parser class. This is the class that the plugin calls automatically. It should subclass base.parser. The format is the location relative to the plugin's directory, followed by a colon, followed by the name of the class. For example, my_file.py:my_parser_class

Optional Keys

• shortname - The short, non user-seeable name of the plugin. It can be used in the api to further refine a query. See here for more info.
• listener - If your plugin implements a listener, then you should define it here. The format is the location relative to the plugin's directory, followed by a colon, followed by the name of the class. For example, my_file.py:my_listener more about listeners

Custom Keys

Any other keys that are defined won't do anything by default, but can be accessed by the plugin. more info