Skip to content

Latest commit

 

History

History
116 lines (80 loc) · 5.34 KB

README.md

File metadata and controls

116 lines (80 loc) · 5.34 KB

ParcelLockers.svg

Supports Paper Supports Spigot

Patreon Website Chat on Discord

Gradle Java

Welcome to ParcelLockers! 🚀

ParcelLockers is a minecraft plugin, dedicated for Spigot-based servers.. 💎 Crafted with care, ParcelLockers is dedicated to incorporating highly practical server function of transfering items across the Minecraft world, especially on long distances.

ℹ️ Information

  • ParcelLockers fully supports Minecraft's latest minor versions starting from each major version, starting from 1.17 onward, e.g. 1.17.1, 1.18.2, 1.19.4, 1.20.6, 1.21.1.
  • Requires Java 17 or later to work properly. For older versions of Java, this may affect the functionality of the plugin.
  • If you have any questions, you can ask us about it on our Discord server.

❗Warning

ParcelLockers is at an very early stage of development, and you use it at your own risk.

🏗️ Compiling JAR from Source

To build ParcelLockers, follow these steps (Make sure you have JDK 21 or higher):

./gradlew clean shadowJar
  • The output file will be located at build/libs.
  • When you build the plugin for the first time, it might take a while to download all the dependencies.

🛠️ Development builds

🤫 Want to be a few steps ahead of others? You can gather our freshly squeezed builds from GitHub Actions here.

:octocat: Contributing

🧩 Are you a developer and want to add something?

Create a public fork of the repository, modify it with appropriate changes and then create a Pull Request. See CONTRIBUTING.md to find out more.

🐛 Issues

Found a bug? Report it here. If you are not sure if that's an intended behavior or not, feel free to ask on our Discord 😅

Additionally, if you enable automatic Sentry bug reporting in your config.yml file (we strongly advise to do so), errors will be automatically sent to us, which will greatly accelerate the bug fixing process 🥳

📜 License

ParcelLockers is published under the GNU GPL-v3 license. In particular, the developer:

  • Is freely allowed to modify and improve the code
  • Can distribute production versions
  • He must publish any changes made, ie. the public fork of this repository
  • Cannot change the license or copyright

Additionally:

  • It is forbidden to modify or remove the code responsible for the compliance of production versions with the license.
  • The authors of this project are not responsible for using the application, modifying and distributing it.
  • Trademarks appearing in this project and this document belong to their rightful owners and are used for informational purposes only.

❤️ Other dependencies usages

❤️ Special Thanks

JetBrains sentry.svg

We express our gratitude to JetBrains for providing Open Source Licenses for their outstanding tools. We recommend using IntelliJ IDEA to work with our projects and boost your productivity!

We also thank Sentry for providing us with a Open-Source Sponsorship plan for error tracking. We recommend using Sentry to track errors in your projects and improve the quality of your software.