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

Relation Object

{
  "id": "othermod",
  "namespace": "com.example",
  "version": "[1.0]",
  "repositories": ["repo1"],
  "flags": [],
  "conditions": {}
}

Required properties

id

This is the ID of the addon this relation refers to.

Optional properties

namespace

This is the namespace of the related addon. This property will be implicitly equal to the namespace of the addon, if it was not set explicitly.

version

This is a maven version range that specifies, which versions of the related addon are targeted by this relation. You can either set this property or semver, but exactly one of them has to be set.

semver

This is a semver version range of supported versions of this relation. It will only allow versions of the related addon, which have a valid semver version number, which is in this range.

repositories

This is an array of repository IDs. These are the repositories, from which AddonScript should try to get this relation from, in the order as they are specified in the array. If this property is not set or the array is empty, AddonScript will try to resolve the relation by the namespace from all defined repositories.

flags

This is an array of flags for this relation. If this property is not present in a relation object, the relation will inherit the side flags from the version and have the required flag set by default.

conditions

This is a conditions object. It can only be used, if the optional flag was set.

1.8 KiB Raw Blame History