Phenyl - 开箱即用的消息桥插件 - 服务端插件

xsling

本帖最后由 xsling 于 2022-5-12 03:40 编辑

Phenyl✨

开箱即用的消息转发桥！

🦀Features：

同步模式下自动获取群名片或昵称进行消息转发
游戏账号与QQ账号双向绑定，自动更新用户名
直接调用Mirai-Core开发，无需插件/Mirai-Http前置
SQLite/MySQL/PostgreSQL支持
链接、小程序消息、卡片、图片消息解析
游戏内发送图片至QQ
以图片格式转发聊天
完全可定制的提示消息与多语言支持
开箱即用，同时高度可配置

解析多种类消息，游戏内便捷访问

游戏内直接发送图片至QQ群

方便地进行绑定与更新

以图片发送提醒与转发消息

指令查询服务器信息

完全可配置的消息格式

📥如何使用：

Phenyl直接调用Mirai库开发，无需任何前置插件或Mirai-Http实现。将Phenyl丢进plugins文件夹并启动，然后修改Phenyl文件夹内的config.yml，再执行/phenyl reload即可。

Phenyl的所有配置选项都配有详细的注释。一般来说，你在初次启动时只需要更改Mirai/Bungeecord Configuration中的选项。

如果你不想由Phenyl来自动下载所需要的依赖，可以下载Github Release中的libs.zip文件，并将其中包含的所有文件解压至Phenyl/libs文件夹下。

✨自定义：

Phenyl的所有提示消息都从资源文件加载，这意味着你可以自由地修改其中的任何一句。使用任一解压缩软件打开Phenyl-x.x.x.jar文件，编辑messages_xxYY.properties文件，并在config.yml中将locale设置为xxYY即可。

🎙️指令与权限：

你可以直接在Bungeecord的config.yml添加权限，也可以使用如Luckperms的插件进行权限管理。

```以下指令需要phenyl.use.*权限节点```
/phenyl bind <QQ号> - 进行QQ绑定。
/phenyl verify <验证码> - 对从QQ发起的绑定请求进行验证。
/phenyl say <消息> - 如果Phenyl处于Command模式，你需要使用此指令来将消息发送到QQ。
/phenyl nomessage - 是否启用消息转发。
/phenyl at <用户名> - 在群聊中@该Minecraft玩家所对应的QQ账号。
```以下指令需要phenyl.admin.*权限节点```
/phenyl mute <用户名> - 禁言某人，则他的游戏内消息不会被转发到QQ。
/phenyl reload - 重新加载Phenyl。
/phenyl login - 登录QQ账号。
/phenyl logout - 注销QQ账号。

复制代码

如果使用Luckperms，直接给予phenyl.use.*或phenyl.admin.*权限即可；如果手动更改config.yml，可以仿照下例：

default:
- phenyl.use.bind
- phenyl.use.verify
- phenyl.use.say
- phenyl.use.nomessage
- phenyl.use.at
admin:
- phenyl.admin.mute
- phenyl.admin.reload
- phenyl.admin.login
- phenyl.admin.logout

复制代码

⚙️运行时：

Phenyl基于JDK17开发，使用部分高版本Java特性，要求在用Java 17运行的Bungeecord中加载。如果你的JRE低于17，请考虑下载新版本。

由于Phenyl运行于Bungeecord，故对游戏服务端本身并无版本要求，只要Bungeecord可以正常代理游戏即可使用。目前在Watferfall #475 + Paper 1.8.8测试通过。

同时，Phenyl基于AGPL-3.0协议开源。这意味着你完全可以在保留许可信息与开源的前提下自由进行分叉与二次开发。如果你对开发并维护一个兼容旧版Java的Phenyl分支感兴趣，我们很乐意提供必要的帮助。但是请注意，对于任何非官方版本的分叉，原作者没有义务也不会提供任何支持，所有针对非官方版本提出的issue将被直接关闭。

👂获取支持：

为便于追踪与管理，所有Bug report/Feature request都请在Githubt新建Issue提出。

🔧配置文件：

################################
# General configuration #
################################
# locale: 服务器本地化设置。
locale: zh_CN
# debug: 是否打印Debug输出。
debug: false
################################
# Mirai configuration #
################################
# user_id: QQ号。
user_id: "your_qq_number"
# user_pass: QQ密码。
# 如果你选择了 ANDROID_PHONE 协议，请确保你的密码不超过16位。
user_pass: "your_qq_pass"
# login_protocol: 登录协议。
# 可用选项: ANDROID_PHONE, ANDROID_PAD, ANDROID_WATCH. 如果不能登录，请尝试更换协议。
login_protocol: "ANDROID_PHONE"
# enabled_groups: 启用Phenyl的QQ群号。
enabled_groups:
- 797717041
- 958173932
################################
# Bungeecord configuration #
################################
# server_alias: 服务器别名。
# 如果此处不设置，Phenyl将直接使用服务器名。
server_alias:
lobby: "Lobby"
survival: "Survival"
test: "Test"
# enabled_servers: 启用消息转发的服务器。
enabled_servers:
- lobby
- survival
- test
################################
# Database configuration #
################################
# database: 用以存储玩家信息（以及聊天数据）的数据库类型。
# 可用选项: sqlite, mysql, postgresql.
storage: "sqlite"
# save_message: 是否存储聊天记录。
# 如果你觉得message表/数据库文件过于庞大，你可以随意删除，它们不会影响到Phenyl的运行。
save_message: true
# 如果你选择了sqlite作为数据库，你可以忽略以下选项。
host: "127.0.0.1"
port: 3306
username: "root"
password: "123456"
database: "Phenyl"
table_prefix: "ph_"
################################
# Message configuration #
################################
# forward_mode: 转发模式。
# 可用选项:
# sync - 同步所有消息。
# %username% 变量在此模式下*不可用*.使用 %nickname% 以替代。
# command - 使用`/ph say ~` 和指令前缀发送消息。
# bind - 只有已绑定的玩家的消息会被同步。
forward_mode: "bind"
# forward_image: 是否将游戏内发送的图片链接转发到群。
forward_image: true
# get_image_timeout: 下载图片的超时限制（秒）。
get_image_timeout: 5
# nomessage_with_cross_server: 设置了nomessage的玩家是否会收到跨服务器转发的消息。
# true:会收到，false:不会收到。
nomessage_with_cross_server: true
# new_player_greeting: 是否给首次加入服务器的玩家发送提示信息。
new_player_greeting: true
# Variables:
# %sub_server% - 玩家所在的服务器名称。
# %group_id% - QQ群号。
# %group_name% - QQ群名称
# %username% - Minecraft用户名。
# %nickname% - 群名片或QQ昵称。
# %message% - 消息内容
# cross_sever_format: 游戏内的跨服务器消息格式。设置为"disabled"禁用。
# 可用变量:
# %sub_server%, %username%, %message%
cross_sever_format: "&7[%sub_server%]%username%:%message%"
# qq_to_server_format: QQ转发到游戏内的消息格式。
# 如果你选择了 sync 模式，请使用 %nickname% 而非 %username%。
# 可用变量:
# %group_id%, %group_id%, %group_name%, %username%, %nickname%, %message%
qq_to_server_format: "&7[QQ]%username%:%message%"
# server_to_qq_format: 游戏转发到QQ的消息格式。设置为"image"以发送图片消息。
# 可用变量:
# %sub_server%, %username%, %message%
server_to_qq_format: "image"
# online_total_format: 在线玩家总数消息格式。
# 可用变量:
# %player_count%
online_total_format: "在线玩家: %player_count%人"
# online_total_format: 在线玩家列表消息格式.
# 可用变量:
# %sub_server%, %username%
online_list_format: "[%sub_server%]%username%"
# on_join: 发送到QQ群的玩家上线消息格式。设置为"disabled"禁用。
# 在最前面加上"image:"来发送图片消息。
# 可用变量:
# %sub_server%, %username%
on_join: "image:%username%加入了%sub_server%"
# on_leave: 发送到QQ群的玩家下线消息格式。设置为"disabled"禁用。
# 在最前面加上"image:"来发送图片消息。
# 可用变量:
# %username%
on_leave: "image:%username%退出了游戏"
# on_join: 游戏内跨服广播的玩家上线消息格式。设置为"disabled"禁用。
# 你可以将这项功能与 EssentialsX 一同使用，禁用单个服务器的上线消息，让Phenyl来发送全部服务器都可见的玩家上线提示。
# 可用变量:
# %sub_server%, %username%
on_join_broadcast: "&e%username%加入了%sub_server%"
# on_leave: 游戏内跨服广播的玩家下线消息格式。设置为"disabled"禁用。
# 你可以将这项功能与 EssentialsX 一同使用，禁用单个服务器的下线消息，让Phenyl来发送全部服务器都可见的玩家上线提示。
# 可用变量:
# %username%
on_leave_broadcast: "&e%username%退出了游戏"
################################
# Image message configuration #
################################
# crafatar_url: Phenyl将要获取玩家头像图片的crafatar地址。
# 默认地址只能获取正版玩家的头像。如果你的服务器正在使用第三方登录，考虑修改crafatar的代码并部署以提供你自己的头像服务，然后在此处设置地址。
crafatar_url: "https://crafatar.com"
# avatar_size: 头像图片的尺寸。
avatar_size: 40
# username_avatar_margin: 用户名与头像之间的间距
username_avatar_margin: 40
# message_min_width: 图片消息的最小宽度。
# 如果你发现用户名显示不全，请把此项调大。
message_min_width: 230
# message_max_width: 图片消息的最大宽度。
message_max_width: 340
# overall_padding: 整体填充大小。
# 这个数值影响头像与消息内容四周的填充大小。
overall_padding: 25
# username_offset: 用户名向下调整的距离。
username_offset: 10
# message_padding: 消息内容向下调整的距离。
message_offset: 15
# username_size: 用户名的字体大小。
username_size: 30
# message_size: 消息内容的字体大小。
message_size: 30
# font: 绘制消息时使用的字体。
# 请确保你的设备上安装了此字体。
font: "Sarasa Mono SC"
################################
# Binding configuration #
################################
# command_prefix: 用来标识QQ群指令的前缀。
command_prefix: "#"
# group_command: 绑定指令。
bind_command: "绑定"
# confirm_command: 确认绑定指令。
confirm_command: "确认绑定"
# online_command: 在线人数指令。
online_command: "在线人数"
# status_command: 服务器状态指令
status_command: "服务器状态"
# verification: 用于生成验证码的正则表达式。
# 如果你只是想改变验证码的长度，将 6 改为你想要的数字就可以了。
verification: "[0-9]{6}"
# 别动这个！
version: 2

复制代码

🤔常见问题：

- 滑动验证码如何使用？

对于大部分用户来说，目前最简便的使用方式是下载mzdluo123/TxCaptchaHelper进行验证。填入Phenyl给你的验证链接并完成验证，它会自动提取ticket。

使用浏览器开发人员工具进行获取同样可行，你可以参考：https://docs.mirai.mamoe.net/mirai-login-solver-selenium/

- 为什么获取不到头像/头像为什么是Alex?

如果你没有修改过配置文件中的crafatar_url，Phenyl将默认从crafatar.com获取头像。请尝试在该网站输入玩家的uuid检查是否能正常获取到头像。

排查头像相关的问题时可以注意以下工作流程：

1.Phenyl会在每个玩家登录时自动开始获取头像，并保存在storage/{$uuid}目录下，如果获取时出现网络问题，消息中的头像处应该直接为空；

2.出现了Alex头像即说明Phenyl已成功从Crafatar获取到了头像，且对方返回的头像即Alex。Crafatar本身使用Redis进行缓存，如果玩家才更换过皮肤可能需要一点时间生效；

3.如果Crafatar上的头像已经正常，一般来说只要玩家退出并重新加入游戏Phenyl就会自动更新。

- 提示当前版本过低，请升级到QQ最新版本。怎么办?

出现此消息多是因为验证码错误次数太多或账号/密码错误。请检查你的账号与密码并：

1.删除Phenyl/mirai文件夹后重试；

2.更改登录协议后重试；

3.更换网络环境后重试。

📚版权信息：

Phenyl使用AGPL-3.0协议开源。这意味着你可以：

任意地运行、复制——在保留许可与版权信息的情况下——分发Phenyl。对于一般的转载，保留开源协议声明及其开源仓库地址即可；
任意地分叉、修改、引用Phenyl的源码并进行二次开发，但是新增与修改后的代码必须以同样的协议开源。

你不被许可的是：

闭源分发或闭源商用Phenyl及Phenyl的衍生代码；
修改Phenyl及其衍生代码的开源协议。

Phenyl-1.1.12-bungee.jar (324.58 KB, 下载次数: 37)

本插件所用代码部分来自其他开源作品

祝用得开心🙋

Syrilo

虽然这类插件不少了但是这个玩家信息变成图片我爱了

WekyJay

可惜只支持高版本啊