Addon Manifest Object

{
  "addonscript": {},
  "id": "myaddon",
  "namespace": "com.example",
  "version": "1.0.0",
  "files": [],
  "relations": [],
  "flags": {},
  "repositories": [],
  "instance": false,
  "use_builder": false,
  "launch": {},
  "meta": {}
}

Required properties

addonscript

This is an AddonScript object containing information about the version of AddonScript used in this file.

id

This is the ID of the addon.

It MUST only contains lowercase alphanumeric characters and hyphens and SHOULD be written in the kebab-case format.

version

This is the AddonScript version number of this version.

namespace

This is the canonical namespace of the addon.

flags

This is an flags object which contains manifest flags for both sides for this manifest.

Optional properties

files

This is an array of file objects including the files belonging to this addon.

relations

This is an array of relation objects which represent addons in relation to this one.

repositories

This is an array of repository objects. Each repository object defines one repository from which files or addons can be retrieved. Each AddonScript manifest SHOULD have a repository for the canonical namespace of that manifest, from which AddonScript implementations MAY check for updates for this addon. If use_builder is true, this addon MUST have such a repository to provide API instances, which can be used to request the launch environment.

instance

This is a boolean which specifies, if this addon is an instance addon. If this property is not present, it defaults to false.

use_builder

This is a boolean which specifies, if this addon will use the environment builder. Only valid if instance is true. If this property is not present, it defaults to false.

launch

This is a launch config object which can be used to modify the inherited launch configuration of this instance. Only available for instance addons.

2.4 KiB Raw Blame History