Skip to content

Plugin Metadata

Every plugin must include a plugin.json file at the root of the archive.

Schema

{
    "name": "MyPlugin",
    "type": "qml",
    "apiVersion": "2.0",
    "description": "Short description of what the plugin does",
    "author": "Your Name",
    "copyright": "(c) 2026",
    "license": "MIT"
}

Fields

Field Required Description
name Yes Plugin name. Displayed in the AMC Settings > Plugins list.
apiVersion Yes The AMC plugin API version the plugin is built against, as a version string (e.g. "2.0"). AMC compares only the major component, so any 2.x value (2.0, 2.1, 2.3.5) satisfies the current minimum of 2.0. A missing, unparseable, or below-2 value makes the plugin incompatible — it will not load. See Migrating v1 → v2.
description Yes Short human-readable description of the plugin.
author Yes Author name or organization.
copyright Yes Copyright notice.
license Yes License identifier (e.g., "MIT", "Apache-2.0").
type Yes Must be "qml". This is the only supported plugin type.

Rules

  • The file must be valid JSON.
  • The file must be named exactly plugin.json.
  • It must be at the root of the .plugin archive (not inside a subdirectory).
  • The type field must be "qml". Other values are not recognized.
  • apiVersion must be present and parse to a major version of at least 2. Only the major component is compared (2.0, 2.1, 2.3.5 all satisfy the 2.0 minimum). A missing, unparseable, or below-2 value is treated as incompatible.

Compatibility

AMC requires plugins built against API version 2.0 or newer. When an incompatible plugin is imported:

  • The plugin file is still copied into the Plugins folder, but it is not loaded or classified.
  • It appears in Settings → Plugins with an "Incompatible" badge.
  • A one-time warning dialog is shown for the freshly imported plugin (it does not reappear on every app launch), pointing the developer to the Migrating v1 → v2 porting guide.

Example

From the NetFetch example plugin:

{
    "name": "NetFetch",
    "type": "qml",
    "apiVersion": "2.0",
    "description": "Fetch and display internet data",
    "author": "Auterion",
    "copyright": "(c) 2026 Auterion",
    "license": "MIT"
}