- 版权类型
- 原创
- 插件中文名称
- 逸云加入插件
- 插件英文名称
- YiyunJoin
- 原帖地址
- #
- 支持的核心(服务端)
- Spigot
- Paper
- Folia
- Purpur
- Leaves
- 其他核心
- 语言支持
- 中文(简体)
- 前置组件
- authme(可选)
- 适配版本(Java)
- 最新版本
- 26.x
- 1.21
- 1.20
[MD]
# ✨ YiyunJoin
**让每一次相遇都充满仪式感**




面向 Paper/Folia 的现代智能欢迎插件:多模式欢迎消息、进服烟花、欢迎奖励系统、整点报时与一言,外加无需 Redis 的 Velocity 群组服协调。以**通用包**形式分发——同一个 JAR 既可装进子服,也可装进代理。
***
## ✨ 功能特性
- 🎨 **多模式欢迎消息** — ActionBar / Chat / Title 动画,渐变色 + 权限组模板
- 🎆 **进服烟花** — 玩家加入时释放自定义烟花,支持颜色/形状/权限/新玩家专属
- 🎁 **欢迎奖励系统** — 一键欢迎按钮,冷却 + 每日上限,概率命令与 Vault 金币奖励
- 💬 **玩家真发言欢迎** — 可选以玩家身份发送欢迎消息,正常触发聊天事件与称号前缀
- 🎁 **首次进服奖励** — 新玩家首次记录资料后自动执行礼包命令,全部成功才落库
- 🔔 **整点报时系统** — 自定义报时时间点,高性能轮询,时区支持
- 💬 **一言 (Hitokoto)** — 每次加入随机一句名言,可配置格式与缓存
- 🔊 **音效系统** — 进服/欢迎/奖励/退出/报时多场景自定义音效
- 👋 **退出消息** — 权限组模板,ActionBar/Chat 双模式
- 🔄 **配置自动迁移** — 升级插件自动补入新配置项(含注释),无需手动对比 wiki
- 🔌 **公共 API v1** — ServicesManager、能力检测、欢迎来源和结构化奖励结果
- 🌐 **Velocity 群组服协调** — 子服生成业务内容,代理校验会话并有界投递,切服静默且无需 Redis
- 📦 **代理零存储** — Velocity 不连接数据库、不下载 JDBC,长期奖励状态由后端存储
- 🧵 **Folia 兼容** — 运行时检测区域化调度器,全局/实体/异步执行域自动适配
> 📖 完整配置参考、占位符一览、FAQ 与高级主题见[用户使用手册](https://docs.qq.com/aio/DVExReWpmcFR5QnpD)。
***
## ⚡ 快速开始
通用包一个 JAR 通吃两个平台,各平台通过自己的描述文件加载对应入口:
| 运行平台 | 描述文件 | 配置目录 |
| --- | --- | --- |
| Paper / Folia | `plugin.yml` | `plugins/YiyunJoin/config.yml` |
| Velocity | `velocity-plugin.json` | `plugins/yiyunjoinvelocity/config.properties` |
**单服三步**:
1. 获取通用包 JAR(从发布渠道下载,或自行构建,见文末),放入 Paper/Folia 的 `plugins/` 文件夹
2. 重启服务器,自动生成 `plugins/YiyunJoin/config.yml`
3. 编辑配置后执行 `/yj reload` 即时生效(无需重启)
> **依赖说明**:Paper 会在首次加载本体时自动从 Maven Central 下载 Gson 和 MySQL Connector/J,之后使用服务器本地缓存。Velocity 端不下载任何库、不连接数据库。
>
> 💡 升级插件后,缺失的新配置项会**自动补入**(含中文注释),原有设置完全保留,迁移前自动备份到 `config_bak/`。每个服务端进程只保留一个 YiyunJoin 发行 JAR,替换时保留配置和数据目录,无需迁移。
***
## 🌐 群组服部署(Velocity)
将**同一个通用包 JAR** 再放入 Velocity 代理的 `plugins/` 目录即可。架构边界:**子服生成全部业务内容并持久化状态,Velocity 只做会话校验、受众选择和有界投递**——不需要 Redis,代理端零存储。
部署要点:
1. 所有后端子服启用 `network.mode: VELOCITY`,配置与代理一致的 `shared-secret`(≥16 字符)
2. 每个后端的 `network.server-id` 与 `velocity.toml` 中的注册名**完全一致**
3. 需要跨子服共享奖励状态(每日次数、冷却、`claim_id` 幂等)时,所有后端使用**同一个 MySQL**
***
## 📋 命令与权限
| 命令 | 权限 | 说明 |
| --- | --- | --- |
| `/welcome <玩家名>` | `yiyunjoin.welcome`(默认所有人) | 欢迎指定新玩家,获取奖励 |
| `/yj reload` | `yiyunjoin.admin.reload` | 重载配置 |
| `/yj stats [玩家]` | `yiyunjoin.admin.stats` | 查看欢迎统计 |
| `/yj resetplayer <玩家名>` | `yiyunjoin.admin.resetplayer` | 重置玩家数据 |
| `/yj testwelcome` | `yiyunjoin.admin.testwelcome` | 测试欢迎按钮 |
| `/yj top` | `yiyunjoin.welcome` | 排行榜(开发中) |
> `/yj` 即 `/yiyunjoin`。另有 `yiyunjoin.vip` / `yiyunjoin.admin` 权限组样式、`yiyunjoin.bypass.cooldown` / `yiyunjoin.bypass.limit` 绕过限制等权限节点,完整列表见[用户使用手册](https://docs.qq.com/aio/DVExReWpmcFR5QnpD)。
***
## 📚 文档导航
| 文档 | 内容 |
| --- | --- |
| [`USERGUIDE.md`](https://docs.qq.com/aio/DVExReWpmcFR5QnpD) | **用户使用手册**:完整配置参考、占位符、FAQ、高级主题 |
| [`API.md`](docs/API.md) | 公共 API v1:接入方式、事件参考、线程模型、示例插件 |
***
## 📬 联系方式
- **作者 QQ**: 2919089965
- **插件交流群**: 1093090518
***
## 版本与兼容
- **最低要求**: Paper/Folia 1.20.1+,Java 21+;群组服需 Velocity 3.4.0+ API
- **升级注意**: `1.2.0-release` 起两端协议要求完整内容快照;请在维护窗口内同时更新 Velocity 和所有子服,确认健康汇总正常后再恢复玩家接入
[/MD]