forked from addonscript/addonscript-spec
Rename URL to link
This commit is contained in:
parent
0b1d10e6cc
commit
006645d102
5 changed files with 14 additions and 14 deletions
|
@ -17,7 +17,7 @@
|
||||||
|
|
||||||
- [Installing](install.md)
|
- [Installing](install.md)
|
||||||
- [Flags](flags.md)
|
- [Flags](flags.md)
|
||||||
- [URLs](url.md)
|
- [Links](link.md)
|
||||||
- [Namespaces](namespaces.md)
|
- [Namespaces](namespaces.md)
|
||||||
- [Versioning](versioning.md)
|
- [Versioning](versioning.md)
|
||||||
|
|
||||||
|
|
|
@ -1,23 +1,23 @@
|
||||||
# URLs
|
# Links
|
||||||
|
|
||||||
AddonScript uses URLs to point to specific files. AddonScript specifies three URL schemes, which can be used
|
AddonScript uses links to point to specific files. AddonScript specifies three link types, which can be used
|
||||||
to point to files.
|
to point to files.
|
||||||
|
|
||||||
## http(s)
|
## http(s)
|
||||||
|
|
||||||
`https://example.com/file.jar`
|
`https://example.com/file.jar`
|
||||||
|
|
||||||
This URL scheme is mostly self-explaining. It is jsut a simple http or https URL, which points to
|
This link type is mostly self-explaining. It is just a simple http or https URL, which points to
|
||||||
a file on a http server.
|
a file on a http server.
|
||||||
|
|
||||||
## mvn
|
## mvn
|
||||||
|
|
||||||
`mvn://com.example/someartifact/1.0/core.jar`
|
`mvn://com.example/someartifact/1.0/core.jar`
|
||||||
|
|
||||||
This URL scheme is used, to point to a maven artifact. The URL consists of multiple parts.
|
This link type is used, to point to a maven artifact. The link consists of multiple parts.
|
||||||
In this example `com.example` it the namespace of the artifact, `someartifact` is the artifact ID,
|
In this example `com.example` it the namespace of the artifact, `someartifact` is the artifact ID,
|
||||||
`1.0` is the version, `core` is an optional specifier and `.jar` is the file ending.
|
`1.0` is the version, `core` is an optional qualifier and `.jar` is the file ending.
|
||||||
`mvn://com.example/someartifact/1.0.jar` would also be a valid URL without an optional specifier.
|
`mvn://com.example/someartifact/1.0.jar` would also be a valid link without an optional qualifier.
|
||||||
|
|
||||||
## file
|
## 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
|
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,
|
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
|
in this directory. All files and directories inside the zip file can be accessed from AddonScript
|
||||||
using the [file URL scheme](../url.md). The path from the file URL is relative to the location of
|
using the [file links](../link.md#file). The path from the file URL is relative to the location of
|
||||||
the AddonScript file.
|
the AddonScript file.
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"id": "modfile",
|
"id": "modfile",
|
||||||
"url": "https://example.com/mymod.jar",
|
"link": "https://example.com/mymod.jar",
|
||||||
"flags": [],
|
"flags": [],
|
||||||
"install": [],
|
"install": [],
|
||||||
"sha1": "somesha1checksum",
|
"sha1": "somesha1checksum",
|
||||||
|
@ -24,9 +24,9 @@ If multiple file objects in the same array have the same ID, they are treated as
|
||||||
which means that the first one of them in the array will be used unless it can't be retrieved from the URL,
|
which means that the first one of them in the array will be used unless it can't be retrieved from the URL,
|
||||||
in which case the next one will be used as a fallback.
|
in which case the next one will be used as a fallback.
|
||||||
|
|
||||||
### url
|
### link
|
||||||
|
|
||||||
This is a [URL](../url.md), which points to the actual file.
|
This is a [link](../link.md), which points to the actual file.
|
||||||
|
|
||||||
### install
|
### install
|
||||||
|
|
||||||
|
|
|
@ -45,12 +45,12 @@ display to the user.
|
||||||
|
|
||||||
### icon
|
### icon
|
||||||
|
|
||||||
A path to the icon of the addon. This path should point to an image file of small resolution
|
A [link](../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.
|
which is ideally square. It can be dispayed to users in programs.
|
||||||
|
|
||||||
### description
|
### description
|
||||||
|
|
||||||
A path to a description file for the addon. The file should be in CommonMark markdown.
|
A [link](../link.md) to a description file for the addon. The file should be in CommonMark markdown.
|
||||||
|
|
||||||
### summary
|
### summary
|
||||||
|
|
||||||
|
@ -78,7 +78,7 @@ An array of people who have contributed to the addon.
|
||||||
|
|
||||||
### changelog
|
### changelog
|
||||||
|
|
||||||
A path to a changelog file for the addon.
|
A [link](../link.md) to a changelog file for the addon.
|
||||||
|
|
||||||
### timestamp
|
### timestamp
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue