addonscript-spec/docs/link.md
2022-01-29 17:33:32 +01:00

28 lines
950 B
Markdown

# Links
AddonScript uses links to point to specific files. AddonScript specifies three link types, which can be used
to point to files.
## http(s)
`https://example.com/file.jar`
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.
## mvn
`mvn://com.example/someartifact/1.0/core.jar`
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,
`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 link without an optional qualifier.
## file
`./relative/path/to/file.jar`
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.