ChafficLib

A modern, comprehensive Spigot library designed to streamline plugin development while maintaining high standards for documentation, testing, and compatibility.

Features

• 🎮 Intuitive GUI System
• ⚙️ Type-safe Configuration
• 💾 Database Abstraction
• 🛠️ Item Builder System
• ✨ Effects & Particles
• 📝 Event DSL
• 🎯 Command Framework
• 📊 Statistics System

Getting Started

Gradle (Kotlin DSL)

repositories {
    mavenCentral()
    maven("https://jitpack.io")
}

dependencies {
    implementation("com.github.chafficplugins:ChafficLib:VERSION")
}

Maven

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>com.github.chafficplugins</groupId>
        <artifactId>ChafficLib</artifactId>
        <version>VERSION</version>
    </dependency>
</dependencies>

Documentation

Visit our GitBook documentation for:

• Getting Started Guide
• API Reference
• Examples & Tutorials
• Best Practices
• Migration Guides

Version Support

We follow Semantic Versioning. Check VERSIONS.md for:

• Supported Minecraft versions
• LTS releases
• End-of-life dates
• Migration guides

Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'feat: Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Requirements for Pull Requests

• 70% code coverage minimum
• Complete documentation for public APIs
• Passing CI checks
• Following our coding standards

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

• 🌐 Website
• 📚 Documentation
• 💬 Discord
• 🐛 Issue Tracker