# Fairy Framework
Fairy 是一个兼容且开源的 Java 框架，用 ♥ 打造。 Fairy 受到 Spring Boot 的极大启发。
它的目标是将依赖注入和基于 CRUD 的设计模式带到各种平台，包括 Minecraft 服务器，例如 Bukkit api、Bungee api 等。这个项目是一个通用的框架。
主要维护者：Imanity Software
支持： 
文档：[docs.fairyproject.io](https://docs.fairyproject.io/)
### 使用 Fairy Framework 的优势
作为通用框架，Fairy 主要为 Minecraft 服务器插件而设计。由于其灵活性、依赖注入模式和强大的后台系统，它无疑是 Minecraft 服务器开源的最佳框架。
凭借 Fairy 的灵活性，我们还支持许多与 Minecraft 无关的平台。[应用程序平台](https://github.com/FairyProject/fairy/tree/v5/io.fairyproject.platforms/app-platform) 用于独立平台，[Discord 模块]() 构建在 JDA 之上，以获得更好的体验等。
## 项目状态
我们目前处于 **`0.7.5`** 状态，我们仍然将 0 作为主要版本前缀的原因是，我们认为在开始版本 1 之前还有缺失的部分。
这并不意味着它不可使用。
## 目标
该项目的目标是一个完全 `跨平台` 的 Minecraft 框架。
您只需编写一次代码，即可在所有平台和版本的平台上使用。
为了实现这个目标，单靠一个人或一个小型团队几乎是不可能的，这就是为什么它应该是开源的，如果您可以为项目做出贡献，我们将不胜感激！
## 使用 Fairy 的公共项目
- Woolwars - [SpigotMC](https://www.spigotmc.org/resources/woolwars-competitive-pvp-gamemode.116176/), [BuiltByBit](https://builtbybit.com/resources/woolwars-competitive-pvp-gamemode.26119/)
- Monster Industries - [SpigotMC](https://www.spigotmc.org/resources/20-off-monster-industries-the-classic-revive.116432/), [BuiltByBit](https://builtbybit.com/resources/monster-industries-the-classic-revive.45452/)
- RaytraceAntiXray - [SpigotMC](https://www.spigotmc.org/resources/raytraceantixray-ores-entities-tiles.116253/), [BuiltByBit](https://builtbybit.com/resources/raytraceantixray-ores-entities-tiles.41896/)
- CraftGens - [BuiltByBit](https://builtbybit.com/resources/craftgens-generators-gui-editor.30062/)
- Brew - [GitHub](https://github.com/FairyProject/brew)
- *随时发起 PR 将您的项目添加到此处！*
## 快速开始
如果您有兴趣使用 Fairy 框架创建一个项目，请从 [项目模板](https://github.com/FairyProject/fairy-bukkit-template) 开始，并阅读我们的 [文档](https://docs.fairyproject.io/!)。
## 授权许可
[MIT license](https://github.com/FairyProject/fairy/blob/v5/LICENSE) 用于 **♥**
## 贡献
可以通过向此仓库提交拉取请求来贡献。
如果您不确定要贡献什么，可以查看
[Open issues](https://github.com/FairyProject/fairy/issues),
或直接在 [Discord](https://discord.gg/VMh3QAfvyq) 询问我们。
如果在贡献之前/期间遇到任何问题，请随时在我们的 [Discord](https://discord.gg/VMh3QAfvyq) 上提问。
对于每一位贡献者，我们将在我们的 Discord 上奖励一个 Discord 角色：
> 我们计划扩大为贡献者提供的奖励，但这现在就是全部了。