CrateReloaded

A powerful and flexible crate plugin for Minecraft servers. Create customizable crates with animated openings, varied rewards, and a comprehensive claim system. Perfect for Spigot, Paper, and compatible server software.

---

📚 Documentation

• Wiki - Comprehensive guides and tutorials
• API Documentation - For plugin developers
• Configuration Guide - All config options explained
• Examples - Example crate configurations

---

🛠️ Development

Prerequisites

Use Java 25 or newer. The Gradle build targets Paper API 26.1.2.build.60-stable, matching Paper 26.1.2-60.

java -version  # Should show Java 25+

Building from Source

1. Clone the repository:

   git clone https://github.com/Hazebyte/CrateReloaded.git
   cd CrateReloaded

2. Initialize git submodules:

   ./scripts/init-project.sh

3. Build the plugin with Gradle:

   ./gradlew clean pluginJar

4. Find the built JAR:

   • Gradle: bukkit/build/libs/CrateReloaded-2.3.16.jar

The build uses public API artifacts for Paper, PlaceholderAPI, Vault, CMI/CMILib, HolographicDisplays, and DecentHolograms. Local compile-only plugin jars may be placed in libs/ or under servers/**/plugins/; those folders are ignored by git.

Legacy Maven Build

The original Maven files are still present for reference, but the maintained build path for this fork is Gradle.

./gradlew clean pluginJar

Running Tests

./gradlew test

Code Quality

CrateReloaded uses Spotless with Palantir Java Format for code formatting:

# Check formatting
make lint

# Auto-fix formatting issues
make lint-fix