Skip to content

Latest commit

 

History

History
68 lines (47 loc) · 3.25 KB

README.md

File metadata and controls

68 lines (47 loc) · 3.25 KB

Logo

GitHub Release License Minecraft Version

A powerful, easy-to-use, and flexible framework for making Minecraft Plugins.


Caution

Kapi is still in early development, expect to encounter bugs and breaking changes!

Demos and Examples can be seen Here

💡 Why Kapi?

As a longtime user of the Spigot API, I became frustrated with how minimal it is. Even basic tasks required too much boilerplate, and every time I started a new project, I found myself copy pasting the same utility functions over and over again.

I built Kapi to solve this problem by offering a "batteries included" framework that simplifies plugin development, allowing you to build both simple and complex plugins with ease.

✨ Features

  • 🤖 Commands: Use method parameters as command arguments, with automatic parsing and method selection based on input
  • 📚 Templating System: Easily create and manage impressive visual effects
  • 📦 ECS: Add dynamic behaviour to your visual effects, enhancing interactivity with the world and players
  • 🎨 Particles & Block Displays Helpers: Reduce boilerplate and improve productivity
  • 📐 Math Library: A powerful math library built for game-specific calculations
  • 💾 Config Management: Simplified handling of YAML configs and SQLite databases
  • 🛠️ Utility Collection: Essential tools and helpers to streamline your plugin development

🚀 Getting Started

Check the documentation website for more information

🤝 Contributing

Contributions are welcome! Please see CONTRIBUTING.md.

You can join the Discord community to discuss the project and ask questions.

📝 License

Code (everything in the "src/" directory) is licensed under GPLv3.
Copyright (C) 2024 Kyren223

Everything in the "assets/" directory (including the Kapi logo) is licensed under CC BY-NC-SA 4.0.
Copyright (C) 2024 Kyren223

🙏 Funding

If you would like to contribute financially, consider sponsoring me (Kyren223) on Patreon.

I would love to continue working on Kapi and your support would help me dedicate more time to do so. Thanks!