# Quill
[](https://jitpack.io/#xLevitate/Quill)
Quill是一个为Paper插件提供的综合实用程序库,提供广泛的工具和系统来简化插件开发。它提供从配置管理到高级物品创建的一切,所有这些都具有干净直观的API。
## 特性
- 🔧 **配置系统** - 基于注解的配置,支持自动更新
- 💬 **聊天系统** - 高级消息处理,支持MiniMessage
- 💾 **JSON存储** - 灵活且类型安全的存储系统
- 📦 **物品管理** - 强大的物品创建和操作
- 📋 **积分板系统** - 简单而灵活的积分板创建
- 🎮 **事件系统** - 流线型的事件处理,带有过滤功能
- 🛠️ **实用类** - 综合的实用方法集合
- 🔌 **插件钩子** - 与PlaceholderAPI和Vault的内置集成
## 安装
### 1. 服务器安装
首先,下载并安装Quill插件到您的服务器:
1. 从[Releases](https://github.com/xLevitate/Quill/releases)下载最新版本
2. 将JAR文件放在服务器的`plugins`文件夹中
3. 重启您的服务器
### 2. 开发集成
#### Gradle (Kotlin DSL)
```kotlin
repositories {
maven("https://jitpack.io")
}
dependencies {
compileOnly("com.github.xLevitate:Quill:2.6.0")
}
```
#### Gradle (Groovy)
```groovy
repositories {
maven { url 'https://jitpack.io' }
}
dependencies {
compileOnly 'com.github.xLevitate:Quill:2.6.0'
}
```
#### Maven
```xml
jitpack.io
https://jitpack.io
com.github.xLevitate
Quill
2.6.0
provided
```
## 快速开始
### 聊天系统
```java
// 发送格式化消息
Chat.sendMessage(player, "欢迎来到服务器!");
// 发送标题
Chat.sendTitle(player, "欢迎! ", "享受您的停留");
```
### 配置
```java
@Configuration("config.yml")
public class MyConfig {
@Comment("启用或禁用插件")
private boolean enabled = true;
@Comment("自定义消息")
private String message = "你好! ";
}
```
### 物品创建
```java
ItemStack item = new ItemWrapper()
.plugin(plugin)
.material(Material.DIAMOND_SWORD)
.name("神秘之刃")
.lore(Arrays.asList(
"一件传奇武器",
"伤害:+50 "
))
.build();
```
### 事件处理
```java
Events.listen(plugin, PlayerJoinEvent.class)
.filter(event -> !event.getPlayer().hasPlayedBefore())
.handle(event -> {
Player player = event.getPlayer();
Chat.sendMessage(player, "欢迎来到服务器!");
});
```
## 文档
有关详细文档,请访问我们的[Wiki](https://github.com/xLevitate/Quill/wiki)。
## 要求
- Java 17或更高版本
- Paper 1.20.4或更高版本
- (可选) PlaceholderAPI 用于占位符支持
- (可选) Vault 用于经济支持
## 支持
如果您遇到任何问题或有任何疑问:
1. 查看 [Wiki](https://github.com/xLevitate/Quill/wiki)
2. 打开 [Issue](https://github.com/xLevitate/Quill/issues)