Relation Object

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

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 MUST 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 will 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 flags object which contains relational flags for both sides for this relation. If a relation has no flag for a side, the relation will be ignored for that side. This behavior is different from the incompatible flag, since the related addon can still be installed on that side without any conflict.

1.7 KiB Raw Blame History