addonscript/addonscript-spec
addonscript/addonscript-spec
1
1
Fork 2
Code Issues 3 Pull requests 1 Projects Releases 3 Wiki Activity

Add links to relation
All checks were successful
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/pr Build is passing
Details

Browse source
This commit is contained in:
Timo Ley 2022-03-03 21:35:59 +01:00
parent ef6dc8fa6f
commit 4e9571c3d5
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/schema/relation.md
View file

@ -7,6 +7,7 @@
"version": "[1.0]", "version": "[1.0]",
"repositories": ["repo1"], "repositories": ["repo1"],
"flags": [], "flags": [],
"links": ["https://example.com/othermod.json", "./othermod.json"],
"conditions": {} "conditions": {}
} }
``` ```
@ -44,6 +45,13 @@ the namespace from all defined repositories.
This is an array of [flags](../concepts/flags.md) for this relation. If this property is not present in a relation object, the relation will use the default flags. This is an array of [flags](../concepts/flags.md) for this relation. If this property is not present in a relation object, the relation will use the default flags.
### links
This is an array of [links](../concepts/links.md), which are pointing to an [AddonScript JSON](addon.md) file, that contains the related addon.
When resolving relations, AddonScript should try to getthe related addon from the first link in this array. If the link doesn't work or the version
of the linked addon is not in the version range of this relation, the next link should be tried or, if there is no link left, the addon should
be resolved from the [repositories](#repositories)
### conditions ### conditions
This is a [conditions object](conditions.md). It can only be used, if the [optional flag](../concepts/flags.md) was set. This is a [conditions object](conditions.md). It can only be used, if the [optional flag](../concepts/flags.md) was set.