Addon Object

{
  "addonscript": {},
  "id": "myaddon",
  "namespace": "com.example",
  "version": "1.0",
  "semver": "1.0.0",
  "files": [],
  "relations": [],
  "flags": ["server", "client"],
  "repositories": [],
  "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 should be written in the kebab-case format, meaning lowercase only and using - instead of spaces.

version

This is the version number of this version. Versions are compared by Maven version order rules. If this version number is valid semver, the semver property is implicitly equal to version if it was not explicitly set.

Optional properties

semver

This is the version number of this version in semver format. It must follow the semver versioning specifications.

namespace

The namespace of the addon in a reverse-DNS format. Used to identify addons across repositories, if it is present.

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.

flags

This is an array of flags for this version.

repositories

This is an array of repository objects. Each repository object defines one repository from which files or addons can be retrieved.

1.7 KiB Raw Blame History