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

We recommend using Jabba as a Java version manager:

# Install Java 17
jabba install openjdk@1.17
jabba use

# Verify Java version
java -version  # Should show Java 17

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:

   # Development build (no obfuscation)
   make build-dev
   
   # Production build (with ProGuard obfuscation)
   make
   
   # Just compile
   make compile

4. Find the built JAR:

   • Development: bukkit/target/CrateReloaded-{version}.jar
   • Production: bin/CrateReloaded-{version}.jar (after ProGuard)

Running Tests

# Run all tests
mvn test

# Generate coverage report
mvn test jacoco:report

# Generate full site with reports
mvn site
# View in browser: target/site/index.html

Code Quality

CrateReloaded uses Spotless with Palantir Java Format for code formatting:

# Check formatting
make lint

# Auto-fix formatting issues
make lint-fix