Upstream/ShopChest-Updated
1
0
Fork 0
mirror of https://github.com/Flowsqy/ShopChest.git synced 2024-11-14 23:15:10 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add some information in the README about this repo

Browse Source
This commit is contained in:
Flowsqy 2022-07-21 23:59:51 +02:00
parent 0ebe7ab6ea
commit 040a53e257
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,6 +1,18 @@
# ShopChest
ShopChest - Spigot/Bukkit Plugin
## General information
This fork of [ShopChest](https://github.com/EpicEricEE/ShopChest) intend to be updatable easily.
It also adds some common features like barrel or shulker shops.
It's still in progress and therefore, this repository has many branches.
Most of them have very explicit name, but there is two things to know:
- The 'master' branch is the original plugin, with no major changes.
It supports the most recent version of Minecraft.
- The 'feature/clean-project' branch is a 'work-in-progress' branch.
It contains bug fixes and adds new features.
However, as the structure change, some plugin that were previously using ShopChest can break.
If it's the case, just use the original version (in 'master' branch).
## API
To use the API, you need to add the following repository and dependency in your maven project:
@ -30,10 +42,10 @@ After importation, use ``mvn clean package`` or ``mvn clean install`` to build t
After the build succeeded, the ShopChest.jar is found in the ``/plugin/target/`` folder.
## Issues
If you find any issues, please provide them in the [Issues Section](https://github.com/EpicEricEE/ShopChest/issues) with a good description of how to reproduce it. If you get any error messages in the console, please also provide them.
If you find any issues, please provide them in the [Issues Section](https://github.com/Flowsqy/ShopChest/issues) with a good description of how to reproduce it. If you get any error messages in the console, please also provide them.
## Download
This resource/plugin is found on the official spigot page [here](https://www.spigotmc.org/resources/shopchest.11431/).
You can also download the latest unstable builds on [this page](https://ci.codemc.io/job/EpicEricEE/job/ShopChest/).
You can download the recent builds in the [release section](https://github.com/Flowsqy/ShopChest/releases).
This resource/plugin can also be found on the official spigot page [here](https://www.spigotmc.org/resources/shopchest.11431/), but as I don't own it, the most recent build there only supports Minecraft up to 1.16.