Skip to content

Latest commit

 

History

History
69 lines (57 loc) · 3.83 KB

README.md

File metadata and controls

69 lines (57 loc) · 3.83 KB
Raw

CrazyCrates

CrazyCrates is a crates plugin for Paper based servers that lets you add unlimited crates. It allows you to bring something to the server to spice up your economy and to give your players something to brag about.

Building

CrazyCrates requires gradle 8.11.1 to build the plugin.

Requirements

  • Java 21 JDK or newer
  • Knowledge of Git

Compiling from source

git clone https://github.com/Crazy-Crew/CrazyCrates.git
cd CrazyCrates
./gradlew assemble

You'll find the jar in the jars folder.

Contributing

Pull Requests

If you have made any changes or improvements which you think could be beneficial to others, please make a pull request, so that the plugin can be improved for everyone using it. (we especially like bug fixes \o/).

A list of pointers when editing existing classes
  • Copy the style of code in the class you are editing.
  • No extra lines at the end of files.
  • No extra lines between imports.
  • No wildcard imports.

Project Structure

The project has been separated into multiple modules for preemptively supporting other platforms.

  • API Module - This module is the API used by other plugins that wish to properly integrate with our plugin, and receive data from CrazyCrates for use in their own plugins. No implementation details are in this module.
  • Common Module - This module handles a small portion of the implementation for CrazyCrates, mainly the configuration files. and independent enums or utilities.
    • The module does not yet handle implementation details for each platform.
  • Paper Module - This module currently is what provides the implementation for the API Module, I have not written an exact abstract module to sit between, and reduce more duplicated code between platforms.
    • Pull Requests that attempt to implement the remaining work of an abstract layer for multi-platform support will likely be ignored, I would like to handle that when the time comes.

License

CrazyCrates is a proud user of the MIT license, You can take a little peak at LICENSE