ShopChest-Updated/README.md

30 lines
1.2 KiB
Markdown
Raw Normal View History

2015-09-02 13:17:08 +02:00
# ShopChest
2022-07-22 00:24:20 +02:00
2015-09-02 13:17:08 +02:00
ShopChest - Spigot/Bukkit Plugin
2016-07-04 17:44:18 +02:00
## API
2022-07-22 00:24:20 +02:00
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.
2016-07-04 19:40:32 +02:00
2016-07-04 17:44:18 +02:00
## Build
2022-07-22 00:24:20 +02:00
You need Maven and a jdk.
- First, compile spigot with the BuildTools.jar and the '--remapped' argument.
You need to do it for a lot of minecraft version, starting from 1.17.
To get them all, just do the next step, an error message will tell you what minecraft version is missing.
(I will try to suppress this step in future)
- Use ``mvn clean package`` or ``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.
2016-07-04 17:44:18 +02:00
2015-09-02 13:17:08 +02:00
## Issues
2022-07-22 00:24:20 +02:00
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.
2015-09-02 13:17:08 +02:00
## Download
2017-01-18 17:01:19 +01:00
2022-07-22 00:24:20 +02:00
I don't post build for this branch as it's in progress. If you want to use it, build it.