mirror of
https://github.com/Flowsqy/ShopChest.git
synced 2024-12-03 02:13:22 +01:00
28 lines
1.3 KiB
Markdown
28 lines
1.3 KiB
Markdown
# ShopChest
|
|
|
|
ShopChest - Spigot/Bukkit Plugin
|
|
|
|
## API
|
|
|
|
For the moment, the project structure can change a lot, and there is no official API planned.
|
|
If you want to use ShopChest functionality, just add the .jar with the version you want to use to your project.
|
|
Maybe in future I will post an official API through github packages, but currently I don't have the time.
|
|
|
|
## Build
|
|
|
|
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 ``mvn clean install`` at the root of the project to build ShopChest artefact.
|
|
- 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/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
|
|
|
|
I don't post build for this branch as it's in progress. If you want to use it, build it.
|