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

Some fixes

Browse source
This commit is contained in:
Timo Ley 2022-09-12 14:54:05 +02:00
parent 9d5b4d945e
commit 124f9a6a2b
4 changed files with 7 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/concepts/flags.md
View file

@ -18,7 +18,7 @@ addon manifest, including for which side it is available and for which side it i
If a side has this flag, this side will completly be ignored for the manifest. If a side has this flag, this side will completly be ignored for the manifest.
- `instance` This flag specifies, that this is a manifest of an [instance addon](instance.md). - `instance` This flag specifies, that this is a manifest of an [instance addon](instance.md).
- `env` This flag is only valid for [instance addons](instance.md). It specifies, that the - `env` This flag is only valid for [instance addons](instance.md). It specifies, that the
[environment builder API](../api/features/env.md) will be used to bet the launch files for this addon. [environment builder API](../api/features/env.md) will be used to get the launch files for this addon.
An addon with this flag MUST have the [env_api](../schema/manifest.md#envapi) property. An addon with this flag MUST have the [env_api](../schema/manifest.md#envapi) property.
## Relational flags ## Relational flags

2
docs/concepts/instance.md
View file

@ -11,6 +11,6 @@ it on both sides, as long as the related addon is itself an instance addon for b
## Instance addons as relations ## Instance addons as relations
If an instance addon is a relation of another instance addon, each side of that If an instance addon is a relation of another instance addon, each side of that
relation MUST have at least one of the [flags](flags.md) `included`, `launch` relation MUST have at least one of the [flags](flags.md) `included`, `launch`, `env`
or `incompatible`. Non-instance addons MAY have instance addons as relations without or `incompatible`. Non-instance addons MAY have instance addons as relations without
this restrictions. this restrictions.

2
docs/concepts/versioning.md
View file

@ -50,7 +50,7 @@ End Result Examples:
Note: Contrary to what was stated in some design documents, for version order, snapshots are not treated differently than releases or any other qualifier. Note: Contrary to what was stated in some design documents, for version order, snapshots are not treated differently than releases or any other qualifier.
### Dependancy Version Requirement Specification ### Dependency Version Requirement Specification
Version requirements have the following syntax: Version requirements have the following syntax:

9
docs/packaging/zip.md
View file

@ -1,8 +1,7 @@
# Zip Packaging # Zip Packaging
With zip packaging, the AddonScript file and the associated files are contained in With zip packaging, the AddonScript file and the associated files are contained in
a zip file. The AddonScript file MUST be named `addon.json` and MUST either be placed a zip file. The AddonScript file MUST be named `manifest.json` and MUST be placed
at the root of the zip file or, if there is just one directory in the root of the zip file, at the root of the zip file. All files and directories inside the zip file can be
in this directory. All files and directories inside the zip file can be accessed from AddonScript accessed from AddonScript using the [file links](../concepts/links.md#file).
using the [file links](../concepts/links.md#file). The path from the file URL is relative to the location of The path from the file URL is relative to the location of the AddonScript file.
the AddonScript file.