Skip to content

bindglam/Phoenix

Repository files navigation

🔥 Phoenix

A lightweight RPG item framework for Paper-based Minecraft servers.

GitHub Release License Discord Wiki


Phoenix is a high-performance, lightweight Paper plugin designed to empower server owners to create custom RPG items with ease. Define unique attributes, custom behaviors, and immersive descriptions without the overhead of heavy frameworks.

FeaturesInstallationAPI DocumentationSupport


✨ Key Features

  • 🛡️ Advanced Attribute System
    • Fully customize Attack Damage and Attack Speed.
    • Dynamic Lore (description) management.
    • Define custom Item Behaviors to trigger unique effects.
  • ⚡ Optimized for Performance
    • Built with a "Performance-First" mindset to ensure zero lag even on high-population servers.
    • Minimalist footprint by focusing on essential RPG mechanics.
  • 🧩 Developer Friendly
    • Clean and intuitive API for developers to extend functionality.
    • Easy integration via JitPack.

🚀 Getting Started

Requirements

  • Server Software: Paper or its forks (e.g., Purpur, Pufferfish).
  • Java Version: Java 21 or higher recommended.

Installation

  1. Download the latest .jar file from the Releases page.
  2. Place the file into your server's plugins folder.
  3. Restart your server.
  4. Configure your items in the generated config files!

🧑‍💻 For Developers (API)

Empower your own plugins by integrating with the Phoenix API.

build.gradle.kts

repositories {
    maven { url = uri("https://jitpack.io") }
}

dependencies {
    // Replace <VERSION> with the latest release tag (e.g., 1.0.0)
    implementation("com.github.bindglam.Phoenix:api:<VERSION>")
}

🛠️ Support & Contribution

🐛 Bug Reports & Suggestions

Found a bug or have a feature request? Please open an issue on our GitHub Issues page. We value your feedback!

🤝 Contributing

Contributions are what make the open-source community such an amazing place!

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

💬 Community

Need quick help or want to share your creations? Join our community!

Discord Invite

📄 License

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


Made with ❤️ by bindglam

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published