Create Plugin Manifest

This wiki page explains how to create a plugin manifest.

Before starting, very important information, if you want to publish a plugin on the official Rtop directory, you must use indentations with two spaces.

Other information for the naming of manifest files, in the case of a plugin directory name it: [plugin-id].json, example: test.json and in the case of a single plugin in a git repository name it manifest.json.

Here is the example used in the repository containing the Rtop example plugin:

{
  "id": "template",
  "name": "Template",
  "description": "A simple Rtop plugin template.",
  "url": "https://github.com/RtopRS/PluginTemplate",
  "version": "0.1.0",
  "author": "Rtop Development Team",
  "license": "MPL-2.0",
  "os": [],
  "arch": []
}

Usefulness of each element:

• id → This is the plugin ID, it will be used in the plugin installation command for example.
• name → This is the name of your plugin and will be displayed during operations on it (update, installation...).
• description → This is a simple description of your plugin.
• url → The URL leading to the repository of your plugin.
• version → The version of your plugin, allows to detect updates.
• author → A string containing your information as a developer, eg: Asthowen or Asthowen<contact@asthowen.fr>.
• authors → The same as author but in the form of a list which allows to list all developers in case there are several.
• license → The license of your repository, you must use the keyword of the license and not its full name example: MPL-2.0 or gpl-3.0, a list is present here.
• os → The list of OS that your plugin supports, in case all OS are supported you can leave the list empty or omit it, otherwise here is an example: ["linux", "darwin"], here the plugin will only install on Linux and MacOS systems otherwise RTPM will display an error message and cancel the plugin installation.
• arch → The list of architectures that your plugin supports, as for plugins you can leave it empty or omit it if all are supported. If not, here is an example: ["i686", "x86_64"].