Phoenix
A lightweight RPG item framework for Paper-based Minecraft servers.
Phoenix
<div align="center">
🔥 Phoenix
A lightweight RPG item framework for Paper-based Minecraft servers.
---
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.
Features • Installation • API Documentation • Support
</div>
---
✨ Key Features
* 🧩 Developer Friendly * Fully customize Attack Damage and Attack Speed. * Dynamic Lore (description) management. * Define custom Item Behaviors to trigger unique effects. * 🧩 Developer Friendly * 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
* Java Version: Java Version 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
```kotlin 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. Pull Request the Project. 2. Create your Pull Request (`git checkout -b feature/AmazingFeature`). 3. Pull Request your changes (`git commit -m 'Add some AmazingFeature'`). 4. Pull Request 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!
<a href="https://discord.gg/CZEabRCuK8"> <img src="https://invidget.glitch.me/CZEabRCuK8.svg?theme=dark" alt="Discord Invite"> </a>
---
📄 License
This project is licensed under the MIT License. See the MIT License file for details.
--- <div align="center"> Made with ❤️ by <b>bindglam</b> </div>