addonscript-spec/docs/schema/relation.md
2021-11-13 21:11:36 +01:00

1.2 KiB

Relation Object

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

Required properties

id

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

version

This is a semver version range of supported versions of this relation.

Optional properties

repositories

This is an array of repository IDs. This are the repositories, from where AddonScript should try to get this relation from, in the order as they are ordered 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 have the flags which are set as default for relations or, if no default was set, it will inherit the flags which are applicable for relations from the associated version.

conditions

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