# jelly-chats
JellyChats 是一个高度可定制的基于 Redis 的私聊插件，适用于 [Velocity](https://github.com/PaperMC/Velocity) 代理。
## 前置条件
要从源代码构建：
- JDK 17 或更高版本
- 互联网连接
要运行插件：
- 一个 Redis 实例
- JRE 17 或更高版本
- 一个 [Velocity](https://github.com/PaperMC/Velocity) 代理
## 安装
从 [这里](https://github.com/azurejelly/jelly-chats) 获取最新版本，然后将其放入您的 `plugins/` 文件夹中。
### 创建新的聊天
前往服务器上的 `plugins/jelly-chats/config.yml` 文件，然后在 `chats` 部分添加一个新的条目：
```yaml
moderator:
enabled: true
name: "Moderators"
channel: "jelly-chats/mods"
permission: "jelly-chats.chat.moderator"
command:
main: "mod-chat"
aliases:
- "m"
- "mc"
- "modchat"
- "mods"
- "mod"
```
您也可以简化为：
```yaml
moderator:
enabled: true
```
在这些情况下：
- 名称将被设置为聊天 ID
- 在此示例中为 `moderator`
- Redis 频道将被设置为 `default-channel-prefix` + 聊天 ID 的值
- 在此示例中为 `jelly-chats/moderator`
- 权限将被设置为 `jelly-chats.chat.` + 聊天 ID
- 在此示例中为 `jelly-chats.chat.moderator`
- 命令将是聊天 ID + `-chat`
- `/moderator-chat` 在此示例中
- 命令将没有别名
### 格式化新的聊天
只需在 `messages → formatting` 下添加一个新的条目，具有相同的聊天 ID：
```yaml
messages:
# ...
formatting:
moderator: "[MOD] () : "
```
此示例假设您使用的是之前创建的相同聊天。
## 从源代码构建
克隆仓库：
```shell
$ git clone https://github.com/azurejelly/jelly-chats
$ cd jelly-chats/
```
使用 Gradle 构建项目：
```shell
$ ./gradlew build
```
您应该能够在 `./build/libs/` 下找到可分发的 JAR 文件。