ParcelLockers

ParcelLockers is a user plugin, dedicated for Spigot-based servers.

Warning ❗

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

Building

To build ParcelLockers execute this command using Gradle (Make sure you are using JDK 8 for maximum compatibility)

./gradlew clean shadowJar

When you build it for the first time, it may take a little longer.

Development builds

You can gather the development builds from GitHub Actions

Contributing

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.

TODO

• Add support for more databases (H2, PostgreSQL, MongoDB?)
• Add translation system, more languages
• Add delivery codes, so any person knowing the code can pick up the parcel
• Add delivery time, so the parcel can be picked up only in a specific time
• Parcel permissions for user
• Parcel return logic
• Banned parcel items (configurable)
• Parcel fee
• Rewrite database to ORMLite (far in future)
• Add "business" logic
• Add more parcel types (fragile, etc...)
• Add option to config for parcel locker space (e.g. max parcels within a locker)
• Rewrite Position class to use Integers instead of Doubles
• Finish GUIs
• Add more GUIs (admin GUI, parcel create GUI, etc.)
• Add Discord integration (bot, webhooks, etc...)
• Add more commands
• Isolate cache into separate classes
• Extract database service methods into repositories (interfaces)
• Delete cyclic dependency (Parcel <-> ParcelLocker), switch to UUID instead of object references

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

• LiteCommands (by Rollczi ❤️)
• Adventure API & MiniMessage
• CDN Configs
• PaperLib
• Lombok
• Spigot API
• expressible
• panda-utilities
• Errorprone
• TriumphGUI
• bStats

ParcelLockers is a advanced user delivery plugin, dedicated for Spigot-based servers.

🚫 Found an issue? Report it here.

🧩 Are you a developer and want to add something? Feel free to create a pull request.