Skip to content

plugin.json

Lipu Fei edited this page Jan 15, 2019 · 5 revisions

plugin.json is a mandatory file for each Cura plugin which should be located in the plugin's root directory (where the plugin's __init__.py is). The pseudo-JSON file below illustrates what the content of a plugin.json should look like:

{
    "name": "My Cura Plugin",    # mandatory, name of the plugin
    "author": "me",              # mandatory, author name
    "version": "1.0.0",          # mandatory, version of the plugin
    "api": 4,                    # deprecated since Cura 4.0, use "supported_sdk_versions" instead
    "supported_sdk_versions": ["2.0.0", "3.0.0", "8.1.0"],  # mandatory, this is a list of Cura SDK versions this plugin supports.
    "description": "My Cura plugin."  # mandatory, description of the plugin
}

Note that supported_sdk_versions is list of discrete CURA SDK versions the plugin supports. Only the versions specified in the list are considered supported. All other versions are considered NOT supported. The format of each SDK version should be SemVer.

Clone this wiki locally