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

Move concepts to own directory

Browse source
This commit is contained in:
Timo Ley 2022-02-16 23:27:55 +01:00
parent 354a9505a8
commit 9607180dad
13 changed files with 31 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/SUMMARY.md
View file

@ -15,11 +15,11 @@
# Concepts
- [Installing](install.md)
- [Flags](flags.md)
- [Links](link.md)
- [Namespaces](namespaces.md)
- [Versioning](versioning.md)
- [Installing](concepts/install.md)
- [Flags](concepts/flags.md)
- [Links](concepts/link.md)
- [Namespaces](concepts/namespaces.md)
- [Versioning](concepts/versioning.md)
# Packaging

14
docs/flags.md → docs/concepts/flags.md
View file

@ -2,33 +2,33 @@
## Side flags
These are flags, which specify, for which side a [version](schema/version.md), a [file](schema/file.md) or
a [relation](schema/relation.md) was made.
These are flags, which specify, for which side a [version](../schema/addon.md), a [file](../schema/file.md) or
a [relation](../schema/relation.md) was made.
- `client` This flag specifies, that the version, relation or file can be installed on the client side
- `server` This flag specifies, that the version, relation or file can be installed on the server side
## Version flags
These are flags, which can be set for [versions](schema/version.md).
These are flags, which can be set for [versions](../schema/addon.md).
- `instance` This flag specifies, that this is a version of an instance addon. Instance addons represent instances of
Minecraft itself, while non-instance addons have to be installed into an existing instance of Minecraft.
## Relational flags
These are flags, which describe the relation between the addon and [related addons](schema/relation.md)
or [files](schema/file.md).
These are flags, which describe the relation between the addon and [related addons](../schema/relation.md)
or [files](../schema/file.md).
- `required` This flag specifies, that the related addon or file is required for the addon. If the addon gets installed,
than any relation or file, which has this flag set, also has to be installed.
- `optional` This flag specifies, that the related addon or file is optional for this addon. If the addon gets installed,
the user should be able to choose, whether he wants to install the relation or file with this flag, or not. This flag
can be used in combination with the [conditions](schema/conditions.md) property.
can be used in combination with the [conditions](../schema/conditions.md) property.
### Relation specific
These are relational flags, which can only be used for [relations](schema/relation.md).
These are relational flags, which can only be used for [relations](../schema/relation.md).
- `included` This flag specifies, that the related addon is included in this one. This also means, that if some
addon requires the related addon, it can also be installed with this addon instead.

6
docs/install.md → docs/concepts/install.md
View file

@ -45,11 +45,11 @@ to prevent malicous code from running.
`launch` can be used to mark the selected file as the launch file for a specific side. Files having this
install step can only have the `client` or the `server` flag, not both. If the file is client-sided, it
has to be a [client JSON file](https://minecraft.fandom.com/wiki/Client.json) as specified by Minecraft
itself. If it is server-sided. it has to be a jar file, which is the file, that should be launched to start
itself. If it is server-sided, it has to be a jar file, which is the file, that should be launched to start
the server. The jar file has to be moved to the root of the instance directory, before using `launch` on it.
Moreover, this install step may only be used with instance addons and there may be only one file for each
Moreover, this install step may only be used with launchable or instance addons and there may be only one file for each
side, which has this install step, except all of them are marked as `optional`, in which case they are also
implicitly marked as incompatible.
implicitly marked as incompatible to each other.
### select

2
docs/link.md → docs/concepts/link.md
View file

@ -23,5 +23,5 @@ In this example `com.example` it the namespace of the artifact, `someartifact` i
`./relative/path/to/file.jar`
This is a relative path to a file. It can only be used with [packaging](packaging/README.md)
This is a relative path to a file. It can only be used with [packaging](../packaging/README.md)
or in some third-party environments, which are not covered by this specification.

1
docs/concepts/namespaces.md Normal file
View file

@ -0,0 +1 @@
# Namespaces

0
docs/versioning.md → docs/concepts/versioning.md
View file

1
docs/namespaces.md
View file

@ -1 +0,0 @@
# Addon IDs and Namespaces

2
docs/packaging/zip.md
View file

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

4
docs/schema/addon.md
View file

@ -29,7 +29,7 @@ It should be written in the `kebab-case` format, meaning lowercase only and usin
### version
This is the version number of this version. Versions are compared by [Maven version order rules](../versioning.md#version-order-specification).
This is the version number of this version. Versions are compared by [Maven version order rules](../concepts/versioning.md#version-order-specification).
If this version number is valid semver, the `semver` property is implicitly equal to `version` if it was not explicitly set.
## Optional properties
@ -52,7 +52,7 @@ This is an array of [relation objects](relation.md) which represent addons in re
### flags
This is an array of [flags](../flags.md) for this version.
This is an array of [flags](../concepts/flags.md) for this version.
### repositories

6
docs/schema/file.md
View file

@ -22,7 +22,7 @@ The file ID has to be unique to this addon version.
### link
This is an array of [links](../link.md), which are pointing to the actual file. All of these links must
This is an array of [links](../concepts/link.md), which are pointing to the actual file. All of these links must
have the same file type. Since AddonScript treats directories and zip files equally,
they can be mixed in the same link array. When downloading the file,
the first link in this array should be used with the other links as fallback, if the first doesn't work.
@ -39,7 +39,7 @@ The order in the array corresponds to the order in which the installation steps
### flags
This is an array of [flags](../flags.md) for this file. If this property is not present in a file object, the file will use the default flags.
This is an array of [flags](../concepts/flags.md) for this file. If this property is not present in a file object, the file will use the default flags.
### sha1
@ -47,7 +47,7 @@ This is the sha1 checksum of the file. Although the checksum is optional, it is
### conditions
This is a [conditions object](conditions.md). It can only be used, if the [optional flag](../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.
### maven

4
docs/schema/install.md
View file

@ -11,10 +11,10 @@
### command
This is the [install command](../install.md), which should be used at this installation step.
This is the [install command](../concepts/install.md), which should be used at this installation step.
## Optional properties
### args
This is an array of arguments for the [install command](../install.md). Each of them takes other arguments.
This is an array of arguments for the [install command](../concepts/install.md). Each of them takes other arguments.

6
docs/schema/meta.md
View file

@ -46,12 +46,12 @@ display to the user.
### icon
A [link](../link.md) to the icon of the addon. This path should point to an image file of small resolution
A [link](../concepts/link.md) to the icon of the addon. This path should point to an image file of small resolution
which is ideally square. It can be dispayed to users in programs.
### description
A [link](../link.md) to a description file for the addon. The file should be in CommonMark markdown.
A [link](../concepts/link.md) to a description file for the addon. The file should be in CommonMark markdown.
### summary
@ -83,7 +83,7 @@ An array of people who have contributed to the addon.
### changelog
A [link](../link.md) to a changelog file for the addon.
A [link](../concepts/link.md) to a changelog file for the addon.
### timestamp

6
docs/schema/relation.md
View file

@ -20,7 +20,7 @@ This is the ID or namespaced ID of the addon this relation refers to.
### version
This is a [maven version range](../versioning.md#dependancy-version-requirement-specification) that specifies, which versions
This is a [maven version range](../concepts/versioning.md#dependancy-version-requirement-specification) 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
@ -36,8 +36,8 @@ the namespace from all defined repositories.
### flags
This is an array of [flags](../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.
### conditions
This is a [conditions object](conditions.md). It can only be used, if the [optional flag](../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.