Addon Manifest Object

{
  "addonscript": {},
  "id": "myaddon",
  "namespace": "com.example",
  "version": "1.0.0",
  "files": [],
  "relations": [],
  "flags": {},
  "repositories": [],
  "env_api": "https://example.com",
  "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.

env_api

This is the base URL of an AddonScript API instance, which has the env feature and will be used to build the launch environment for this addon. This property will only be used if this addon has the env manifest flag.

1.9 KiB Raw Blame History