forked from addonscript/addonscript-spec

Timo Ley 56837dcec1 Specify default flags

Closes #9

2022-06-08 19:44:19 +02:00

1.8 KiB

Raw Blame History

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 semver was not explicitly set.

flags

This is an array of flags for this version.

Optional properties

semver

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

namespace

This is the namespace of the addon, which should be in a reversed domain name format. Used to identify addons across repositories.

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.

1.8 KiB Raw Blame History