Discord Velocity
一个 Velocity 插件,用于将代理与 Discord 服务器桥接:玩家事件中继、双向聊天、控制台日志流式传输、从 Discord 执行命令以及游戏时长统计。
功能
- 双向聊天频道:玩家消息发送至 Discord;Discord 消息传送到代理上的所有玩家。玩家显示包含其 LuckPerms 前缀/后缀(如果已安装)。
- 玩家事件:加入 / 离开、服务器切换、执行的命令(可选)。
- 代理状态消息:启动和关闭。
- 控制台频道:流式传输所有 Velocity 日志(每 ~1.5 秒批量发送以避免速率限制)。频道中的纯文本消息作为代理控制台命令执行,并带有 ✅ / ❌ 反应。
- ANSI 转义符剥离:在发送前从日志中去除 ANSI 转义符。
- 存在机器人:单一状态、列表轮换带间隔或基于计划(
HH:mm)。活动类型:PLAYING / LISTENING / WATCHING / STREAMING / COMPETING / CUSTOM。支持%online%/%max%。 - 在线状态(
ONLINE / IDLE / DND / INVISIBLE):根据玩家数量自动设置或手动设置;每个轮换条目可以覆盖它。 - 斜杠命令
/commands— 列出所有代理命令(仅限控制台频道)。 - 斜杠命令
/players— 按服务器列出在线玩家;支持服务器自动补全。 - 斜杠命令
/time— 玩家在每个服务器的游戏时长,可选时间段过滤器(需要 Statify)。 - Velocity 中的
/discord-velocity(/dv):无需重启即可info和reload。 - 版本化 YAML 配置:当版本不匹配时,旧文件会被备份并创建新文件。
要求
- Java 21+
- Gradle 8.10
- Velocity 3.5.0+
- Discord 应用程序 → 启用 MESSAGE CONTENT INTENT 和 SERVER MEMBERS INTENT 的 Bot
- 在 Discord 中启用 开发者模式(设置 → 高级)以复制频道 / 公会 ID
- LuckPerms (可选) — 聊天中的前缀/后缀显示
- Statify Paper 1.0.0 + MySQL/MariaDB (可选) —
/time命令
安装
- 下载或构建
discord-velocity-<version>.jar。 - 将其放置在 Velocity 的
plugins/目录中。 - 启动代理 —
plugins/discord-velocity/config.yml和messages.yml将被创建。 - 填写
config.yml:discord.token— bot tokendiscord.guild-id— 公会 ID(推荐;否则斜杠命令最多需要 1 小时才能全局出现)discord.chat-channel-id,discord.console-channel-id— 频道 IDstatify.*— 数据库凭据和服务器列表 (仅/time需要)
- 重启代理。
从源代码构建
gradle wrapper --gradle-version 8.10
./gradlew clean shadowJar
输出:build/libs/discord-velocity-<version>.jar(包含 JDA、SnakeYAML、MariaDB JDBC 的 fat-jar)。
命令
Velocity
| 命令 | 描述 |
|---|---|
/discord-velocity info |
插件版本、bot 状态、频道、当前存在状态。 |
/discord-velocity reload |
无需重启即可重新加载 config.yml 和 messages.yml。 |
/dv ... |
别名。 |
- 从代理控制台或 Discord 控制台频道 — 不需要权限。
- 从游戏内服务器 — 需要
discordvelocity.admin(LuckPerms:lp user <name> permission set discordvelocity.admin true)。 reload应用所有config.yml更改,除了discord.*和console.flush-interval-ms(对于这些会发出[warn])。
Discord 斜杠命令
| 命令 | 位置 | 描述 |
|---|---|---|
/commands |
控制台频道 | 列出所有代理命令(临时回复)。 |
/players |
任何频道 | 每个服务器的在线玩家;可选 server 参数并支持自动补全。 |
/time |
任何频道 | 玩家在每个服务器的游戏时长。需要 statify.enabled: true。 |
控制台频道中的任何纯文本消息都将作为代理控制台命令执行。/ 前缀是可选的。
/players 参数
server(可选) — 筛选到单个服务器;从 Velocity 注册的服务器中自动补全。
/time 参数
player— 玩家昵称(必需,不区分大小写)。period—all(默认),day,week(7 天),month(30 天),year,custom。from,to—period=custom的范围,格式为DD.MM.YYYY或DD.MM.YY。
配置
config.yml
config-version: "0.2.0" # 在构建时设置 — 请勿编辑
discord:
token: ""
guild-id: ""
chat-channel-id: ""
console-channel-id: ""
chat:
mc-to-discord: true # 将玩家聊天转发到 Discord
discord-to-mc: true # 将 Discord 消息转发到 MC
events:
command-log: true # 将玩家命令记录到聊天频道
console:
bidirectional: true # 将来自控制台频道的消息作为命令执行
flush-interval-ms: 1500 # 日志批量发送间隔(毫秒)
exclude-loggers: # 通过前缀跳过记录器
- net.dv8tion
- okhttp3
- io.netty
statify:
enabled: false # 启用 /time 斜杠命令
type: mariadb # mysql | mariadb
host: localhost
port: 3306
database: statify
username: statify
password: change_me
use-ssl: false
servers: # Statify 的 config.yml 中的服务器名称值(显示顺序)
- lobby
- survival
presence: mode: single # single | rotate | schedule type: PLAYING format: "%online%/%max% online" rotation-interval-sec: 30 status: mode: auto # auto | manual manual: ONLINE active: ONLINE # when players > 0 empty: IDLE # when players == 0 list: - type: PLAYING text: "%online%/%max% players" - type: LISTENING text: "maintenance" status: DND - at: "20:00" type: STREAMING text: "Evening stream" url: "
### `messages.yml`
所有插件发送至 Discord 和 Minecraft 的文本。占位符:`%player%`、`%displayname%`、`%server%`、`%role%`、`%from%`、`%to%`、`%message%`、`%command%`、`%count%`。
- `%displayname%` — 带有 LuckPerms 前缀/后缀的玩家昵称(去除颜色代码以适配 Discord),否则为普通昵称。
- `%role%` — 最高 Discord 角色,已预格式化 MiniMessage 颜色标签(例如 `<color:#FF5555>Admin</color>`)。
缺失的键将回退到内置默认值——不会丢失任何消息。
## 配置版本控制
`config-version` 和 `messages-version` 在构建时注入,必须与正在运行的插件版本匹配。
启动时:
1. 文件缺失 → 从内置默认值创建。
2. 发现旧版 `config.properties` / `messages.properties` → 重命名为 `*.old.legacy.yml`。
3. 版本不匹配 → 旧文件重命名为 `<name>.old.<version>.yml`,创建新的默认文件。发生冲突时添加 `.1`、`.2` 后缀。
## 数据布局
plugins/ ├── discord-velocity-0.2.0.jar └── discord-velocity/ ├── config.yml ├── messages.yml ├── config.old.0.1.0.yml └── messages.old.0.1.0.yml
## 技术栈
- [JDA 5](https://github.com/discord-jda/JDA) — Discord 客户端
- [SnakeYAML](https://bitbucket.org/snakeyaml/snakeyaml) — YAML 解析器
- [MariaDB Java Client](https://mariadb.com/kb/en/mariadb-connector-j/) — `/time` 命令的 JDBC 驱动
- [LuckPerms API](https://luckperms.net/) *(compileOnly)* — MC→Discord 聊天中的前缀/后缀
- Velocity API + Adventure (MiniMessage 用于 Discord→MC 渲染)
- Log4j2 — 自定义 appender 用于控制台流式传输
JDA、SnakeYAML 和 MariaDB 驱动已阴影打包至 `ru.dvolk.discordvelocity.shaded.*`。
## 备注
已在 [Velocity 3.5.0 #605](https://fill-data.papermc.io/v1/objects/0ec616020166465dacca3b790d3db2b246f8f7c13b3aaacaae60c825744a66e0/velocity-3.5.0-SNAPSHOT-605.jar)、[Paper 1.21.11 #132](https://fill-data.papermc.io/v1/objects/5ffef465eeeb5f2a3c23a24419d97c51afd7dbb4923ff42df9a3f58bba1ccfba/paper-1.21.11-132.jar)、[LuckPerms 5.5.57](https://download.luckperms.net/1645/bukkit/loader/LuckPerms-Bukkit-5.5.57.jar) 和 [statify-paper 1.0.0](statify-paper-1.0.0.jar) 上测试。
## 许可证
[MIT](LICENSE)
---
# Discord Velocity
一个用于 [Velocity](https://papermc.io/software/velocity) 的插件,将代理服务器与 Discord 服务器连接:事件和聊天转播、控制台直播、通过 Discord 执行命令以及游戏时长统计。
## 功能
- **聊天频道**(双向):玩家消息发送至 Discord,显示服务器名称及 LuckPerms 的前缀/后缀;Discord 消息在 MC 中显示带颜色的成员最高角色。
- **玩家事件**:加入/离开、切换服务器、执行的命令(可选)。
- **代理状态消息**:启动和关闭通知。
- **Console 频道**:Velocity 日志流(批处理间隔约 1.5 秒)。消息作为命令执行并附带 ✅ / ❌ 反应。
- **清理日志中的 ANSI 转义码**。
- **Presence 机器人**:单一状态、轮换、日程表。类型:`PLAYING / LISTENING / WATCHING / STREAMING / COMPETING / CUSTOM`。占位符 `%online%` / `%max%`。
- **在线状态** (`ONLINE / IDLE / DND / INVISIBLE`):自动或手动设置。
- **`/commands`** — 代理命令列表(console 频道)。
- **`/players`** — 按服务器分类的在线玩家,支持按服务器自动补全。
- **`/time`** — 按服务器分类的玩家游戏时长(需要 Statify)。
- **`/discord-velocity` (`/dv`)** in Velocity: `info` and `reload`.
- **配置版本控制**:版本不匹配时,旧文件会被备份,并创建新文件。
## 要求
- Java **21+**
- Gradle **8.10**
- Velocity **3.5.0+**
- Discord 应用 → Bot:启用 **MESSAGE CONTENT INTENT** 和 **SERVER MEMBERS INTENT**
- Discord 中的 **开发者模式**(设置 → 高级)以便复制 ID
- [LuckPerms](https://luckperms.net/) *(可选)* — 聊天中显示前缀/后缀
- [Statify Paper 1.0.0](statify-paper-1.0.0.jar) + MySQL/MariaDB *(可选)* — `/time` 命令
## 安装
1. 下载或编译 `discord-velocity-<version>.jar`。
2. 放入 Velocity 的 `plugins/` 目录。
3. 启动代理 —— 将在 `plugins/discord-velocity/` 下生成 `config.yml` 和 `messages.yml`。
4. 填写 `config.yml`:
- `discord.token` — 机器人令牌
- `discord.guild-id` — 服务器 ID(否则斜杠命令最多需 1 小时才会出现)
- `discord.chat-channel-id`, `discord.console-channel-id` — 频道 ID
- `statify.*` — 数据库数据和服务器列表 *(仅用于 `/time`)*
5. 重启代理。
## 从源码构建
```bash
gradle wrapper --gradle-version 8.10
./gradlew clean shadowJar
结果:build/libs/discord-velocity-<version>.jar。
命令
Velocity
| 命令 | 作用 |
|---|---|
/discord-velocity info |
版本、机器人状态、频道、当前 presence。 |
/discord-velocity reload |
重新加载 config.yml 和 messages.yml。 |
/dv ... |
别名。 |
- 从控制台和 console 频道执行无需权限。
- 在游戏中执行需要
discordvelocity.admin(LuckPerms:lp user <name> permission set discordvelocity.admin true)。
Discord (斜杠命令)
| Команда | Где работает | Что делает |
|---|---|---|
/commands |
console-канал | Список команд прокси (ephemeral). |
/players |
любой канал | Онлайн-игроки по серверам; параметр server с автодополнением. |
/time |
любой канал | Наигранное время игрока. Требует statify.enabled: true. |
Любое сообщение в console-канале выполняется как команда. Префикс / опционален.
Параметры /players: server (опционально) — фильтр по серверу с автодополнением из Velocity.
Параметры /time: player (обязательно), period (all/day/week/month/year/custom), from/to (DD.MM.YYYY или DD.MM.YY для custom).
Конфигурация
config.yml
config-version: "0.2.0" # подставляется при сборке, не менять
discord:
token: ""
guild-id: ""
chat-channel-id: ""
console-channel-id: ""
chat:
mc-to-discord: true # чат игроков → Discord
discord-to-mc: true # Discord → MC
events:
command-log: true # логировать команды игроков
console:
bidirectional: true # выполнять команды из console-канала
flush-interval-ms: 1500 # период склейки логов
exclude-loggers:
- net.dv8tion
- okhttp3
- io.netty
statify:
enabled: false # true — включить /time
type: mariadb # mysql | mariadb
host: localhost
port: 3306
database: statify
username: statify
password: change_me
use-ssl: false
servers: # server-name из config.yml Statify
- lobby
- survival
presence:
mode: single # single | rotate | schedule
type: PLAYING
format: "%online%/%max% online"
rotation-interval-sec: 30
status:
mode: auto
manual: ONLINE
active: ONLINE
empty: IDLE
list:
- type: PLAYING
text: "%online%/%max% игроков"
- type: LISTENING
text: "тех. работы"
status: DND
- at: "20:00"
type: STREAMING
text: "Вечерний стрим"
url: "https://twitch.tv/example"
messages.yml
Тексты всех сообщений. Плейсхолдеры: %player%, %displayname%, %server%, %role%, %from%, %to%, %message%, %command%, %count%.
%displayname%— ник с prefix/suffix из LuckPerms (без цветовых кодов для Discord), иначе просто ник.%role%— высшая роль Discord с MiniMessage-цветом (напр.<color:#FF5555>Admin</color>).
Если ключ отсутствует в файле — подставляется значение из bundled-дефолта.
Версионирование конфигов
config-version и messages-version подставляются при сборке и должны совпадать с версией плагина.
При запуске:
- Файл отсутствует → создаётся из дефолта.
- Найден
*.properties→ переименовывается в*.old.legacy.yml. - Версия не совпадает → файл бэкапится как
<name>.old.<version>.yml, создаётся свежий.
Структура данных
plugins/
├── discord-velocity-0.2.0.jar
└── discord-velocity/
├── config.yml
├── messages.yml
├── config.old.0.1.0.yml
└── messages.old.0.1.0.yml
Технологии
- JDA 5 — Discord-клиент
- SnakeYAML — YAML-парсер
- MariaDB Java Client — JDBC-драйвер для
/time - LuckPerms API (compileOnly) — prefix/suffix в чате
- Velocity API + Adventure (MiniMessage для рендера Discord → MC)
- Log4j2 — кастомный аппендер стрима консоли
JDA, SnakeYAML и MariaDB-драйвер шейдятся в ru.dvolk.discordvelocity.shaded.*.
Комментарий
Протестировано на Velocity 3.5.0 #605, Paper 1.21.11 #132, LuckPerms 5.5.57 и statify-paper 1.0.0.
Лицензия
MIT
你是这个资源的作者?登录后可认领此资源。
相似资源
PacketEvents 是一款专为 Minecraft Java 版打造的协议库,旨在简化数据包的处理与传输。
ExyliaPlugins 的库。
通过对话框或铁砧界面帮助你的 Anthme
重新定义服务器上的生物运输方式。使用高度可定制的口袋道具,安全地捕获、存储和释放任何实体。
为基于 Spigot/Paper/Folia 的服务器添加对 Vivecraft 的支持
用于绘制游戏内地图或在浏览器中随探索实时进行地图绘制的实时地图。
评论 0
登录后参与评分
还没有评论,来抢沙发吧