Minepacks/README.md

120 lines
5.9 KiB
Markdown
Raw Normal View History

2019-04-30 18:23:16 +02:00
<!-- Variables (this block will not be visible in the readme -->
[banner]: https://pcgamingfreaks.at/images/minepacks.png
2019-06-04 21:54:43 +02:00
[spigot]: https://www.spigotmc.org/resources/19286/
2019-05-30 02:36:25 +02:00
[spigotRatingImg]: https://img.shields.io/badge/dynamic/json.svg?color=brightgreen&label=rating&query=%24.rating.average&suffix=%20%2F%205&url=https%3A%2F%2Fapi.spiget.org%2Fv2%2Fresources%2F19286
[spigotDownloadsImg]: https://img.shields.io/badge/dynamic/json.svg?color=brightgreen&label=downloads%20%28spigotmc.org%29&query=%24.downloads&url=https%3A%2F%2Fapi.spiget.org%2Fv2%2Fresources%2F19286
2019-04-30 18:23:16 +02:00
[bukkit]: http://dev.bukkit.org/bukkit-plugins/minepacks/
[issues]: https://github.com/GeorgH93/Minepacks/issues
[wiki]: https://github.com/GeorgH93/Minepacks/wiki
2019-06-04 21:54:43 +02:00
[wikiFAQ]: https://github.com/GeorgH93/Minepacks/wiki/FAQ
[wikiPermissions]: https://github.com/GeorgH93/Minepacks/wiki/Permissions
2019-04-30 18:23:16 +02:00
[release]: https://github.com/GeorgH93/Minepacks/releases/latest
[releaseImg]: https://img.shields.io/github/release/GeorgH93/Minepacks.svg?label=github%20release
[license]: https://github.com/GeorgH93/Minepacks/blob/master/LICENSE
[licenseImg]: https://img.shields.io/github/license/GeorgH93/Minepacks.svg
2019-06-04 21:54:43 +02:00
[ci]: https://ci.pcgamingfreaks.at/job/Minepacks/
[ciImg]: https://ci.pcgamingfreaks.at/job/Minepacks/badge/icon
2020-01-07 02:58:31 +01:00
[ciDev]: https://ci.pcgamingfreaks.at/job/Minepacks%20Dev/
[ciDevImg]: https://ci.pcgamingfreaks.at/job/Minepacks%20Dev/badge/icon
2019-05-30 02:36:25 +02:00
[apiVersionImg]: https://img.shields.io/badge/dynamic/xml.svg?label=api-version&query=%2F%2Frelease[1]&url=https%3A%2F%2Frepo.pcgamingfreaks.at%2Frepository%2Fmaven-releases%2Fat%2Fpcgamingfreaks%2FMinepacks-API%2Fmaven-metadata.xml
2020-02-17 01:42:36 +01:00
[api]: https://github.com/GeorgH93/Minepacks/tree/master/Minepacks-API
2019-05-30 02:36:25 +02:00
[apiJavaDoc]: https://ci.pcgamingfreaks.at/job/Minepacks%20API/javadoc/
[apiBuilds]: https://ci.pcgamingfreaks.at/job/Minepacks%20API/
[bugReports]: https://github.com/GeorgH93/Minepacks/issues?q=is%3Aissue+is%3Aopen+label%3Abug
[bugReportsImg]: https://img.shields.io/github/issues/GeorgH93/Minepacks/bug.svg?label=bug%20reports
[reportBug]: https://github.com/GeorgH93/Minepacks/issues/new?labels=bug&template=bug.md
[featureRequests]: https://github.com/GeorgH93/Minepacks/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement
[featureRequestsImg]: https://img.shields.io/github/issues/GeorgH93/Minepacks/enhancement.svg?label=feature%20requests&color=informational
[requestFeature]: https://github.com/GeorgH93/Minepacks/issues/new?labels=enhancement&template=feature.md
2020-02-17 02:16:11 +01:00
[config]: https://github.com/GeorgH93/Minepacks/blob/master/Minepacks/resources/config.yml
2019-06-04 21:54:43 +02:00
[pcgfPluginLib]: https://github.com/GeorgH93/PCGF_PluginLib
[pcgfPluginLibAdvantages]: https://github.com/GeorgH93/Minepacks/wiki/Build-and-Mode-comparison#Advantages-of-using-the-PCGF-PluginLib
2020-02-17 01:42:36 +01:00
[languages]: https://github.com/GeorgH93/Minepacks/tree/master/Minepacks/resources/lang
2019-04-30 18:23:16 +02:00
<!-- End of variables block -->
[![Logo][banner]][spigot]
2020-02-17 02:16:11 +01:00
Minepacks is a free and reliable backpack plugin for minecraft server running bukkit or spigot.
2019-04-30 18:23:16 +02:00
2019-05-30 02:36:25 +02:00
[![ciImg]][ci] [![releaseImg]][release]
[![apiVersionImg]][api] [![licenseImg]][license]
[![featureRequestsImg]][featureRequests] [![bugReportsImg]][bugReports]
[![spigotRatingImg]][spigot] [![spigotDownloadsImg]][spigot]
2014-08-02 17:50:30 +02:00
2018-04-26 15:47:30 +02:00
## Features:
2019-05-30 02:36:25 +02:00
* [Configuration][config]
* Backpack size controlled by [permissions][wikiPermissions]
2018-04-26 15:47:30 +02:00
* Auto item-collect on full inventory (can be enabled in the config)
2019-06-04 21:54:43 +02:00
* Multiple storage back-ends (Files, SQLite, MySQL)
* Multi language support ([multiple language file included][languages])
* Item filter (block items from being stored in the backpack)
2018-04-26 15:47:30 +02:00
* Preserves the NBT data of items (everything that can be stored in a chest can be stored in the backpack)
2019-04-30 18:23:16 +02:00
* Support for name changing / UUIDs
2018-04-26 15:47:30 +02:00
* Auto-updater
2019-05-30 02:36:25 +02:00
* [API][api] for developers
2019-09-09 18:19:51 +02:00
## Requirements:
### Runtime requirements:
2019-06-04 21:54:43 +02:00
* Java 8
2020-02-17 01:42:36 +01:00
* Bukkit, Spigot or Paper for Minecraft 1.7.5 or newer
2019-06-04 21:54:43 +02:00
* (Optional) [PCGF PluginLib][pcgfPluginLib] ([Advantages of using the PCGF PluginLib][pcgfPluginLibAdvantages])
2019-09-09 18:19:51 +02:00
### Build requirements:
2019-06-04 21:54:43 +02:00
* JDK for Java 8
* Maven 3
* git
2019-09-09 18:19:51 +02:00
## Build from source:
The plugin can be build in 3 different configurations.
All the details about the different build configs and runtime modes can be found [here](https://github.com/GeorgH93/Minepacks/wiki/Build-and-Mode-comparison).
2019-05-30 02:36:25 +02:00
### Normal version:
```
git clone https://github.com/GeorgH93/Minepacks.git
cd Minepacks
mvn package
```
2020-02-17 01:42:36 +01:00
The final file will be in the `Minepacks/target` folder, named `Minepacks-<CurrentVersion>.jar`.
2019-05-30 02:36:25 +02:00
### Standalone version:
This version works without the PCGF-PluginLib, however some API features are not available.
```
git clone https://github.com/GeorgH93/Minepacks.git
cd Minepacks
mvn package -P Standalone,ExcludeBadRabbit
2019-05-30 02:36:25 +02:00
```
2020-02-17 01:42:36 +01:00
The final file will be in the `Minepacks/target` folder, named `Minepacks-<CurrentVersion>-Standalone.jar`.
### Release version:
This is the version of the plugin published on dev.bukkit.org and spigotmc.org.
```
git clone https://github.com/GeorgH93/Minepacks.git
cd Minepacks
mvn clean install -P Standalone,ExcludeBadRabbit
mvn clean package -P Release
```
2020-02-17 01:42:36 +01:00
The final file will be in the `Minepacks/target` folder, named `Minepacks-<CurrentVersion>-Release.jar`.
2019-05-30 02:36:25 +02:00
## API:
Minepacks V2 comes with an API that allows you to interact with this plugin.
If you think there is something missing in the API feel free to open a [feature request][requestFeature].
2019-06-02 15:33:31 +02:00
Please do not access data of the plugin in any other way than through the provided API, the inner workings will change and I won't keep track of what you are using in your plugin.
2019-05-30 02:36:25 +02:00
For more details about the API please check the following links:
[Source Code & Details][api] ⚫ [JavaDoc][apiJavaDoc] ⚫ [Build Server][apiBuilds]
2014-08-02 17:51:07 +02:00
## Support:
2019-04-30 18:23:16 +02:00
* [Wiki][wiki]
* [Issue tracker][issues]
2019-05-30 02:36:25 +02:00
* [new feature request][requestFeature]
* [new bug report][reportBug]
* [Faq][wikiFAQ]
2019-04-30 18:23:16 +02:00
## Links:
2019-04-30 18:23:16 +02:00
* [Spigot][spigot]
* [Dev Bukkit][bukkit]
2019-06-04 21:54:43 +02:00
* [Build Server - Release Builds ![ciImg]][ci]
* [Build Server - Dev Builds ![ciDevImg]][ciDev]