https://github.com/chafficplugins/chafficlib

A modern, comprehensive Spigot library designed to streamline plugin development while maintaining high standards for documentation, testing, and compatibility.
https://github.com/chafficplugins/chafficlib

minecraft papermc spigot spigot-api

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/chafficplugins/chafficlib
• Owner: ChafficPlugins
• License: mit
• Created: 2024-06-14T17:00:21.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-11-19T14:12:56.000Z (about 1 month ago)
• Last Synced: 2024-11-19T14:42:45.119Z (about 1 month ago)
• Topics: minecraft, papermc, spigot, spigot-api
• Language: Kotlin
• Homepage: https://chafficplugins.gitbook.io/chafficlib/
• Size: 80.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ChafficLib

[![Build Status](https://github.com/chafficplugins/ChafficLib/actions/workflows/build.yml/badge.svg)](https://github.com/chafficplugins/ChafficLib/actions/workflows/build.yml)

[![codecov](https://codecov.io/gh/chafficplugins/ChafficLib/branch/main/graph/badge.svg)](https://codecov.io/gh/chafficplugins/ChafficLib)

[![License](https://img.shields.io/github/license/chafficplugins/ChafficLib)](LICENSE)

[![Release](https://img.shields.io/github/v/release/chafficplugins/ChafficLib)](https://github.com/chafficplugins/ChafficLib/releases)

[![Minecraft Version](https://img.shields.io/badge/Minecraft-1.20--1.21-brightgreen.svg)](https://www.spigotmc.org/resources/chafficlib.XXXXX/)

[![Documentation](https://img.shields.io/badge/documentation-gitbook-blue.svg)](https://chafficplugins.gitbook.io/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)

```kotlin

repositories {

    mavenCentral()

    maven("https://jitpack.io")

}

dependencies {

    implementation("com.github.chafficplugins:ChafficLib:VERSION")

}

```

### Maven

```xml

    

        jitpack.io

        https://jitpack.io

    

    

        com.github.chafficplugins

        ChafficLib

        VERSION

    

```

## Documentation

Visit our [GitBook documentation](https://chafficplugins.gitbook.io/chafficlib/) for:

- Getting Started Guide

- API Reference

- Examples & Tutorials

- Best Practices

- Migration Guides

## Version Support

We follow [Semantic Versioning](https://semver.org/). Check [VERSIONS.md](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](CONTRIBUTING.md)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Support

- 🌐 [Website](https://felixbeinssen.net)

- 📚 [Documentation](https://chafficplugins.gitbook.io/chafficlib/)

- 💬 [Discord](https://discord.gg/RPZBhB4rna)

- 🐛 [Issue Tracker](https://github.com/chafficplugins/ChafficLib/issues)