Plugin configuration
Each plugin must include a mobro_plugin_config.json file which defines some important metadata.
This configuration file must be located in the plugins root directory after publishing to a .zip file.
note
If this file is missing, the plugin is considered invalid and can NOT be installed to MoBro.
Fields
| Field | Default | Restrictions | Description |
|---|---|---|---|
| name | - | Required Length: 3 - 128 Pattern: ^[\w-]+$ | The globally unique name (=id) of the plugin |
| displayName | name | - | Visible human readable name of the plugin |
| author | Unknown | - | The name of the author of this plugin |
| description | - | - | A short textual description for the plugin |
| assembly | Plugin.dll | - | The published .dll file to load |
| localization | - | - | The relative path to the folder containing the localization files |
| settings | - | - | The setting fields for this plugin |
Example
The following configuration file is taken from
the MoBroHardwareMonitor plugin.
It defines all the required fields like a unique plugin name, defines a custom assembly name and also points to the
localization directory.
Settings are omitted here, more details on them in In-depth: Settings.
Plugin.MoBroHardwareMonitor/mobro_plugin_config.json
{
"name": "modbros_mobrohardwaremonitor",
"displayName": "MoBro Hardware Monitor",
"author": "ModBros",
"description": null,
"assembly": "Plugin.MoBroHardwareMonitor.dll",
"localization": "Resources/Localization",
"settings": []
}