Upstream/ShopChest-Updated
1
0
Fork 0
mirror of https://github.com/Flowsqy/ShopChest.git synced 2025-01-22 09:51:19 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README build instructions

Browse Source
This commit is contained in:
Flowsqy 2022-07-26 22:38:17 +02:00
parent 902686ea47
commit 4012e001de
1 changed files with 29 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -1,19 +1,23 @@
# ShopChest # ShopChest
ShopChest - Spigot/Bukkit Plugin ShopChest - Spigot/Bukkit Plugin
## General information ## General information
This fork of [ShopChest](https://github.com/EpicEricEE/ShopChest) intend to be updatable easily. 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 also adds some common features like barrel or shulker shops.
It's still in progress and therefore, this repository has many branches. 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: 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 'master' branch is the original plugin, with no major changes.
- The 'feature/clean-project' branch is a 'work-in-progress' branch. It supports the most recent version of Minecraft.
It contains bug fixes and adds new features. - The 'feature/clean-project' branch is a 'work-in-progress' branch.
However, as the structure change, some plugin that were previously using ShopChest can break. It contains bug fixes and adds new features.
If it's the case, just use the original version (in 'master' branch). 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 ## API
To use the API, you need to add the following repository and dependency in your maven project: To use the API, you need to add the following repository and dependency in your maven project:
```xml ```xml
@ -37,15 +41,29 @@ To use the API, you need to add the following repository and dependency in your
You can find the javadoc here: https://epicericee.github.io/ShopChest/javadoc/ You can find the javadoc here: https://epicericee.github.io/ShopChest/javadoc/
## Build ## Build
Clone this repository and use ``sh lib/install_local_depedencies.sh`` to import local dependencies.
After importation, use ``mvn clean package`` or ``mvn clean install`` to build the project. You need Maven with Github access and a jdk.
If you don't know how to give Github access to maven,
check [this](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-with-a-personal-access-token)
.
If you don't know how to create a personal token,
check [this](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
.
- Use ``sh lib/install_local_depedencies.sh`` to import local dependencies.
- Use ``mvn clean install`` at the root of the project to build ShopChest artifact.
After the build succeeded, the ShopChest.jar is found in the ``/plugin/target/`` folder. After the build succeeded, the ShopChest.jar is found in the ``/plugin/target/`` folder.
## Issues ## Issues
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.
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 ## Download
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. 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.