Petpet

自定义合成图片的 Mirai 插件 / 独立程序 / gocq-http插件, 灵感/部分数据来自 nonebot-plugin-petpet。

原生 java 编写, kotlin仅用于数据序列化, 使用底层API, 多线程优化: 轻量, 高性能, 易拓展

• 在线编辑器

• JS 前端版本

• 在线体验

使用方法

单独运行

1. 下载 最新版本 petpet.jar 或 petpet-no-ws.jar

2. 下载 图片素材

3. 将图片素材放入 ./data/xmmt.dituon.petpet/ 目录

4. 运行 start.bat 或 start.sh, 可自行更改配置文件 config.json, 重启后生效

5. 参考WebServer一节 发起网络请求 / 或使用WebUI

Mirai插件

0. 部署 Mirai 机器人框架

1. 下载 最新版本

2. 将插件放入 Mirai/plugins/

3. 下载 图片素材

4. 将图片素材放入 Mirai/data/xmmt.dituon.petpet/

5. 启动 Mirai, 可自行更改配置文件 Petpet.yml, 重启后生效 (参考 配置项说明)

• 使用 戳一戳 有 30% 的概率触发; 或发送 pet @xxx

pet key @xxx 或 key @xxx 可返回指定图片 例如 pet kiss @xxx kiss @xxx

可通过发送的图片生成Petpet kiss [图片], 支持GIF

可通过回复构造图片, 例如 [图片] -> [回复[图片]] 对称

可使用 pet指令 获取 keyList

gocq-http插件

Warning

此功能处于测试阶段, 目前仅能通过key生成图片, 请期待后续开发!

0. 部署 gocq-http 机器人框架, 设置正向 WebSocket 监听 (默认端口为8080)

1. 更改 gocq-http 配置项 message.post-format 为 array

2. 下载 最新版本 petpet.jar

3. 下载 图片素材

4. 将图片素材放入 ./data/xmmt.dituon.petpet/ 目录

5. cd ./ java -jar petpet.jar -gocq, 可自行更改配置文件 gocq-config.json, 重启后生效

配置文件

配置项说明

修改后重启 Mirai 以重新加载

权限管理

群主或管理员使用 pet on pet off 以 启用/禁用 戳一戳

pet on/off指令控制的事件可在配置文件中更改

可在配置文件中禁用指定key, 被禁用的key不会随机触发, 但仍可以通过指令使用

图片预览

在线尝试

自定义

在线编辑器

data.json

./data/xmmt.dituon.petpet/ 下的目录名为 key ，插件启动时会遍历 ./data/xmmt.dituon.petpet/$key/data.json

data.json 是模板配置文件, 程序解析此文件以生成图像

{
  "type": "GIF",
  "avatar": [],
  "text": [],
  "delay": 50,
  "alias": [ "别名1", "别名2" ]
}

模板类型枚举

• GIF 动图, 程序会读取目录下所有.png格式的图像
• IMG 静态图片, 程序会读取目录下随机.png格式的图像

头像

程序支持复杂的图像处理, 包括裁切, 旋转, 透明度, 滤镜等

{
  "avatar": [
    {
      "type": "FROM",
      "pos": [[92, 64, 40, 40], [135, 40, 40, 40], [84, 105, 40, 40]],
      "round": true,
      "rotate": false,
      "avatarOnTop": true,
      "angle": 90
    },
    {
      "type": "TO",
      "pos": [[5, 8], [60, 90], [50, 90], [50, 0], [60, 120]],
      "posType": "DEFORM",
      "opacity": 0.5
    }
  ]
}

头像类型枚举 type

• FROM 发送者头像
• TO 接收者头像, 或构造的图片
• GROUP 群头像
• BOT 机器人头像
• RANDOM 随机头像 (随机从群聊成员中选择, 不会重复)

坐标

坐标格式枚举posType

• ZOOM 缩放, 通过 x, y, width, height 表示图像
• DEFORM 变形, 通过四点坐标来表示图像

ZOOM

ZOOM 缩放坐标的基本组成单位是 4长度 int[] 数组

其中，前两项为 左上角顶点坐标， 后两项为 宽度和高度

例: [65, 128, 77, 72] 即 头像的左上角顶点坐标是 (65,128), 宽度为 77, 高度为 72

如果是 GIF 类型，坐标应为二维数组，GIF 的每一帧视为单个图像文件

 {
  // pos的元素对应GIF的4帧
  "pos": [[65, 128, 77, 72], [67, 128, 73, 72], [54, 139, 94, 61], [57, 135, 86, 65]]
}

如果是IMG类型, 可以使用一维数组

{
  "pos": [0, 0, 200, 200]
}

坐标支持变量运算, 例如 [100,100,"width/2","height*1.5^2"]

坐标变量

• width 原图宽度
• height 原图高度

DEFORM

DEFORM 仿射变换坐标格式为 [[x1,y1],[x2,y2],[x3,y3],[x4,y4],[x_anchor,y_anchor]]; 分别对应图片的[[左上角],[左下角],[右下角],[右上角],[锚点]]，四角坐标用相对于锚点的偏移量表示

旋转原点枚举 origin

• DEFAULT 左上角
• CENTER 中心

裁切

图片裁切坐标 [x1, y1, x2, y2], [0, 0, x2, y2] 可简写为 [x2, y2]

裁切格式枚举 cropType

• NONE 不裁切
• PIXEL 按像素裁切
• PERCENT 按百分比裁切

填充模式 fit

• CONTAIN 缩小以适应画布, 不改变原比例
• COVER 裁切以适应画布, 不改变原比例
• FILL 拉伸, 改变原比例

风格化枚举 style

• MIRROR 水平镜像
• FLIP 上下翻转
• GRAY 灰度化
• BINARIZATION 二值化

滤镜 filter

通过滤镜实现头像特效, Java 与 JavaScript 版本实现有偏差, 并非完全相同

{
  "filter": [
    {
      "type": "SWIRL",
      "radius": 200,
      "angle": 5.0
    }
  ]
}

滤镜参数

• SWIRL , 漩涡滤镜

• BULGE , 膨胀收缩滤镜

• SWIM , 水下滤镜

• BLUR , 模糊滤镜

• CONTRAST , 亮度对比度滤镜

• HSB , 相对HSB (色相, 饱和度, 亮度) 滤镜

• HALFTONE , 半色调滤镜 (模仿彩色印刷的CMYK色彩)

• DOT_SCREEN , 单色点阵滤镜 (模仿黑白印刷品)

• NOISE , 噪声滤镜

• DENOISE , 降噪滤镜

• OIL , 油画滤镜

文字

如果你想在图片上添加文字，可以编辑 text

{
  "text": [
    {
      "text": "Petpet!", // 文字内容
      "color": "#66ccff", // 颜色, 默认为#191919
      "pos": [100, 100], // 坐标
      "size": 24 // 字号, 默认为12
    },
    {
      "text": "发送者: $from, 接收者: $to", // 支持变量
      "pos": [20, 150], // 坐标
      "position": ["CENTER", "BOTTOM"], //坐标计算基准([x, y])
      "font": "宋体", // 字体, 默认为黑体
      "strokeColor": "#ffffff", // 描边颜色
      "strokeSize": 2 // 描边宽度
    },
    {
      "text": "$txt1[我]超市$txt2[你]!", // 支持关键词变量
      "pos": [0,200,300], // 第三个值为文本最大宽度
      "align": "CENTER", // 对齐方式, 默认为LEFT
      "wrap": "ZOOM", // 显示设置, 默认为NONE
      "style": "BOLD" // 字体样式, 默认为PLAIN
    }
  ]
}

变量

• $from : 发送者, 会被替换为发送者昵称
• $to : 接收者, 被戳或At的对象
• $group : 群名称
• $txt(i)[(xxx)] : 文本变量, 可用于生成meme图, i为关键词索引, xxx为默认值; 例: $txt1[我]超市$txt2[你] 指令为 pet [key] 我 你

font

在data/fonts目录下的字体文件会注册到环境中

align

• LEFT: 左对齐, 文本基线是标准的字母基线
• RIGHT: 右对齐, 文本基线是标准的字母基线
• CENTER: 居中对齐, 文本基线在文本块的中间

wrap

• NONE: 不换行
• BREAK: 自动换行, 超过最大宽度的文本会显示在下一行
• ZOOM: 自动缩放, 缩放字体大小以填充最大宽度

使用BREAK或ZOOM时, maxWidth 默认为 200

style

• PLAIN: 默认
• BOLD: 粗体
• ITALIC: 斜体
• BOLD_ITALIC: 粗体与斜体

position

• LEFT: 左定位(默认)
• RIGHT: 右定位
• TOP: 上定位(默认)
• BOTTOM: 下定位
• CENTER: 居中定位

background

程序支持动态创建画布

{
  "background": {
    "size": ["avatar0Width*2","avatar0Height"], //支持变量运算
    "color": "#f0f0f0"
  }
}

坐标变量

• avatar(i)Width i号头像(i为定义头像时的顺序, 从0开始)处理后的宽度
• avatar(i)Height i号头像处理后的高度
• text(i)Width i号文本渲染后的宽度
• text(i)Height i号文本渲染后的高度

MessageHook

本特性仅适用于 Mirai 插件, 消息注入, 插件会检查将要发送的消息 解析后注入图片, 可配合各类消息回复插件使用

<pet></pet> 标签中的JSON会被解析, 请求格式参考 WebServer.POST

用例:

这段文字之后的标签会变成一张图片发送<pet>{
  "key": "petpet",
  "to": {
    "qq": 2544193782 
  },
  "textList": [
    "text1"
  ]
}</pet>消息的顺序会被正确处理, 支持多张图片

不同于 POST 请求格式, 你可以用 "qq" 令程序自动获取头像和昵称, 也可以自定义"name" "avatar" (更推荐自定义的做法, 程序可能在某些情况下无法推断出正确的"name")

被"hidden": true隐藏的模板会正常调用

此功能默认禁用, 需在配置文件中启用messageHook: true

WebServer

程序可作为http服务器 / API单独运行, 被其它项目/语言使用

java -jar petpet.jar

启动时会生成 config.json:

{
    "port": 2333, // 监听端口
    "webServerThreadPoolSize": 10, // HTTP服务器线程池容量
    "dataPath": "data/xmmt.dituon.petpet", // PetData路径
    "preview": false, // 启用动态预览 (启动时生成所有模板预览)
    "antialias": true, // 启用抗锯齿, 详见上文
    "resampling": true, // 启用重采样, 详见上文
    "gifMaxSize": [200, 200, 32], // GIF缩放阈值, 详见上文
    "gifEncoder": "ANIMATED_LIB", // GIF编码器, 详见上文
    "gifQuality": 5, // GIF质量, 详见上文
    "threadPoolSize": 0, // GIF编码器线程池容量, 详见上文
    "headless": true // 使用headless模式
}

程序使用com.sun.net.httpserver实现http服务器

PetServer API

访问 127.0.0.1:2333/petpet 以获取 PetDataList

GET

使用 GET 传递参数, 例如 127.0.0.1:2333/petpet?key=petpet&toAvatar=$avatarUrl 127.0.0.1:2333/petpet?key=osu&textList=hso!

结构

POST

使用 POST 传递参数, 例如 127.0.0.1:2333/petpet

{
    "key": "petpet",
    "to": {
        "name":"d2n",
        "avatar":"https://q1.qlogo.cn/g?b=qq&nk=2544193782&s=640"
    },
    "randomAvatarList": [
        "url"
    ],
    "textList": [
        "text"
    ]
}

其中, key为必须项, 其它可以省略

form-data

可直接将图片二进制文件上传至服务器进行处理

类似于 GET数据结构, 使用 multipart/form-data

可参考example-script中的代码实现请求

WebUI

启动WebServer后即可使用WebUI

启用preview配置项以加载WebUI模板预览 (可选, 默认关闭)

• 修改 server-config.json preview: true

常见问题

• 戳一戳无法触发?

  检查 Mirai 登录协议, 仅 ANDORID_PHONE 可以收到 戳一戳 消息

• 没有生成配置文件?

  Mirai 2.11.0 提供了新的 JavaAutoSaveConfig 方法, 请更新Mirai版本至 2.11.0 (不是2.11.0-M1), 旧版本不支持自定义配置项

• Could not initialize class java.awt.Toolkit?

  对于无输入输出设备的服务器 需要启用headless

• 自动更新下载速度慢 / 无法连接远程资源?

  修改Petpet.yml中repositoryUrl的值为'https://ghproxy.com/https://raw.githubusercontent.com/Dituon/petpet/main'(高速镜像)

• 自动更新后 读取data.json出错?

  自动更新时网络出错导致, 删除出错的文件 重新获取即可

• 其它错误? 问题?

  若此文档无法解决您的问题, 欢迎提交issue

性能 & 兼容性

程序使用底层java.awt类合成图片, 渲染时使用多线程, 静态图片渲染时间一般不会超过1ms

对GIF编码器的分析, 转换, 映射部分进行多线程优化, 速度极快

Android JVM没有实现java.awt, 推荐使用JDK 11+版本

分享你的作品 (模板)

如果你想分享自定义的 Petpet, 欢迎Pr

二次开发

程序提供超多实用API 拓展性极强, 附有互动式开发实例, 欢迎初学者学习!

• 互动式开发实例 参见test.moe.dituon.petpet.example.HelloPetpet

• 在别的项目二次开发: mirai-simplepetpet-plugin

后话

如果此插件和您预期的一样正常工作，请给我一个 star

欢迎提交任何请求

交流群: 828350277