Minepacks/README.md

50 lines
1.6 KiB
Markdown
Raw Normal View History

<!-- Variables (this block will not be visible in the readme -->
[banner]: https://pcgamingfreaks.at/images/minepacks.png
[spigot]: https://www.spigotmc.org/resources/minepacks.19286/
[license]: https://github.com/GeorgH93/Minepacks/blob/master/LICENSE
[licenseImg]: https://img.shields.io/github/license/GeorgH93/Minepacks.svg
[ci]: https://ci.pcgamingfreaks.at/job/Minepacks%20API/
[ciImg]: https://ci.pcgamingfreaks.at/job/Minepacks%20API/badge/icon
[apiVersionImg]: https://img.shields.io/badge/dynamic/xml.svg?label=api-version&query=%2F%2Flatest[1]&url=https%3A%2F%2Frepo.pcgamingfreaks.at%2Frepository%2Fmaven-releases%2Fat%2Fpcgamingfreaks%2FMinepacks-API%2Fmaven-metadata.xml
[apiJavaDoc]: https://ci.pcgamingfreaks.at/job/Minepacks%20API/javadoc/
[apiBuilds]: https://ci.pcgamingfreaks.at/job/Minepacks%20API/
<!-- End of variables block -->
[![Logo][banner]][spigot]
This branch holds the API for the Minepacks plugin.
[![ciImg]][ci] [![apiVersionImg]][apiJavaDoc] [![licenseImg]][license]
## Adding it to your plugin
### Maven
The API is available through maven.
#### Repository:
```
<repository>
<id>pcgf-repo</id>
<url>https://repo.pcgamingfreaks.at/repository/everything</url>
</repository>
```
#### Dependency:
```
<!-- Minepacks API -->
<dependency>
<groupId>at.pcgamingfreaks</groupId>
<artifactId>Minepacks-API</artifactId>
<version>2.0</version><!-- Check api-version shield for newest version -->
</dependency>
```
### Build from source:
```
git clone https://github.com/GeorgH93/Minepacks.git
cd Minepacks
git checkout --track origin/API
mvn clean install
```
## Links
* [JavaDoc][apiJavaDoc]
* [API Build Server][apiBuilds]