Petpet

一个生成摸摸头GIF的 Mirai 插件，灵感/部分数据来自 nonebot-plugin-petpet。

java 编写，支持多线程 ：轻量，高效。

在线编辑器

使用方法

1. 下载 最新版本

2. 将插件放入 Mirai/plugins/

3. 下载 图片素材

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

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

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

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

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

可使用 pet指令 获取 keyList

以上配置 均可在配置文件中修改

配置文件

首次运行 Petpet 插件时，会生成 Mirai/config/xmmt.dituon.petpet/Petpet.yml 文件

content: 
  command: pet #触发 petpet 的指令
  probability: 30 #使用 戳一戳 的触发概率
  antialias: true #抗锯齿
  disabled: [] #禁用列表

  keyCommandHead: '' #keyCommand前缀
  respondReply: true #响应回复
  cachePoolSize: 10000 #消息缓存池容量

  respondSelfNudge: false #响应机器人发出的戳一戳
  keyListFormat: FORWARD #keyList响应格式
  disablePolicy: FULL #禁用策略
  fuzzy: false #模糊匹配用户名

  synchronized: false #消息事件同步锁
  gifEncoder: ANIMATED_LIB #GIF编码器
  gifMaxSize: [] #GIF缩放阈值/尺寸
  gifQuality: 90 #GIF质量, 仅适用于ANIMATED_LIB编码器
  
  strictCommand: true #严格匹配模式
  headless: true #使用headless模式
  
  autoUpdate: true #自动从仓库同步PetData
  repositoryUrl: 'https://dituon.github.io/petpet' #仓库地址, 用于自动更新
  devMode: false #开发模式, 支持热重载

配置项说明

修改后重启 Mirai 以重新加载

权限管理

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

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

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

图片预览

图片按key排序(见data/xmmt.dituon.petpet/)

展开/收起

key	预览
acclaim 喝彩 欢呼
bible 圣经 典中典
breakdown 惊吓 击穿
carte 佩可莉姆 菜单 单页
hold_sign 唐可可 举牌 应援
kurumi 胡桃 放大
monad 唐可可 拍 单页
point_tv 康纳 电视
remake 泥头车 创 重开
reward 伊蕾娜 赏金 报酬
watch_tv 汤姆 电视
certificate 喜报
anyasuki 阿尼亚 喜欢
bite 啃 咬
breast 胸 凶
cast 丢
center_symmetry 中心对称 左上对称
coupon 陪睡
cover_face 挡
crawl 爬
decent_kiss 抱歉
distracted 注意力
dont_touch 不要靠近
down_symmetry 对称 下对称 上下对称
eat 吃
fencing 击剑 🤺
garbage 垃圾桶 垃圾 探头
hammer 锤
interview 采访
jiujiu 么么
keep_away 远离
kiss 亲 热吻
knock 敲 打
left_down_symmetry 中心对称 左下对称
leg 蹭
like 永远喜欢
loading 加载 加载中
make_friend 加好友
marry 结婚
nano 纳米科技
need 需要
osu
painter 画
pat 拍
perfect 完美
petpet 摸 摸头
play 玩 顶
police 警察
pound 捣
pr 舔屏
punch 打拳
record 唱片
right_down_symmetry 中心对称 右下对称
right_symmetry 对称 右对称 左右对称
right_up_symmetry 中心对称 右上对称
roll 滚 推
rub 舔 prpr
safe_sense 安全感
suck 吸
support 精神支柱
symmetry 对称 左对称 左右对称
tear 撕
thinkwhat 想
throw 扔
thump 锤
tightly 黏
twist 抱
up_symmetry 对称 上对称 上下对称
wallpaper 瑞克 壁纸
worship 膜拜
yoasobi 群青

..more&more

自定义

在线编辑器

data.json

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

data.json 标准如下 (以 thump/data.json 为例)

{
  "type": "GIF", // 图片类型(enum)
  "avatar": [{ //头像(objArr), 参考下文
      "type": "TO",
      "pos": [
        [65, 128, 77, 72], [67, 128, 73, 72], [54, 139, 94, 61], [57, 135, 86, 65]
      ],
      "round": true,
      "avatarOnTop": false
    }],
  "text": [], //文字(objArr), 参考下文
  "inRandomList": false, //在随机列表中(bolean)
  "delay": 50 //帧间延时(ms/int), 默认为65
}

图片类型枚举

type

• GIF 动图
• IMG 静态图片

坐标

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

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

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

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

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

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

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

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

仿射变换/图像变形

坐标格式枚举posType

• ZOOM 缩放(见上文)
• DEFORM 变形

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

目前仿射变换仅支持单帧

头像

3.0版本后 提供了更灵活的头像构造方法, 与之前的版本有很大差别

"avatar": [
    {
      "type": "FROM", //头像类型枚举(enum), 非空
      "pos": [[92, 64, 40, 40], [135, 40, 40, 40], [84, 105, 40, 40]], // 坐标
      "round": true, // 值为true时, 头像裁切为圆形, 默认为false
      "avatarOnTop": true // 值为true时, 头像图层在背景之上, 默认为true
      "angle": 90, // 初始角度
    },
    {
      "type": "TO", 
      "pos": [[5, 8], [60, 90], [50, 90], [50, 0], [60, 120]],
      "posType": "DEFORM", // 图像变形 坐标格式, 默认为ZOOM
      "antialias": true, // 抗锯齿, 对头像单独使用抗锯齿算法, 默认为false
      "rotate": false // 值为true时, GIF类型的头像会旋转, 默认为false
    },
    {
      "type": "GROUP", 
      "pos": [[182, 64, "width/2", "height*1.5^2"], [225, 40, "40", 40], [174, 105, 40, "height+width"]], // 支持变量运算
      "crop": [0, 0, 50, 100], // 图片裁切坐标[x1, y1, x2, y2], 可简写为 [50, 100]
      "cropType": "PERCENT", // 裁切格式, 默认为NONE
      "style": [ // 风格化
        "MIRROR",
        "GRAY"
      ]
    }
  ]

在IMG中, 当rotate = true时, 头像会随机旋转角度, angle为最大值(angle = 0时, 随机范围为0-359)

头像类型枚举 type

• FROM 发送者头像
• TO 接收者头像, 或构造的图片
• GROUP 群头像
• BOT 机器人头像

裁切格式枚举 cropType

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

风格化枚举 style

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

坐标变量

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

文字

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

"text": [ // 这是一个数组, 可以添加很多文字
    {
      "text": "Petpet!", // 文字内容
      "color": "#66ccff", // 颜色, 默认为#191919
      "pos": [100, 100], // 坐标, 默认为 [2,14]
      "size": 24 // 字号, 默认为12
    },
    {
      "text": "发送者: $from, 接收者: $to", // 支持变量
      "color": [0,0,0,255], // 颜色可以使用RGB或RGBA的格式
      "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": "BLOD", // 字体样式, 默认为PLAIN
      "greedy": true // 贪婪匹配模式, 会匹配多余的关键词
    }
  ]

变量

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

需要更多变量请提交 Issue

font

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

align

• LEFT: 左对齐
• RIGHT: 右对齐
• CENTER: 居中对齐

wrap

• NONE: 不换行
• BREAK: 自动换行
• ZOOM: 自动缩放

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

style

• PLAIN: 默认
• BLOD: 粗体
• ITALIC: 斜体

position

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

background

4.0版本后, 支持动态创建画布

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

坐标变量

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

WebServer

除了作为Mirai插件, Petpet 也可以作为http服务器单独运行, 可被其它项目/语言使用

java -jar petpet.jar

启动时会生成 config.json:

{
  "port": 2333, //监听端口
  "threadPoolSize": 10, //线程池容量
  "dataPath": "data/xmmt.dituon.petpet", //PetData路径
  "gifMaxSize": [200, 200, 32], //Gif缩放阈值, 详见上文
  "gifEncoder": "ANIMATED_LIB", //Gif编码器, 详见上文
  "headless": true //使用headless模式
}

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

PetServer API

访问 127.0.0.1:2333/petpet 以获取 PetDataList

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

结构

更多示例请参考example-script

常见问题

• 戳一戳无法触发?

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

• 没有生成配置文件?

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

• Exception in coroutine <unnamed>?

  图片素材应位于 Mirai/data/xmmt.dituon.petpet 目录下, 请检查路径

• 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

依赖share包二次开发

• 方式1. 在本项目内二次开发（非mirai插件形式）：见xmmt.dituon.example.SimpleUsage
• 方式2. 在别的项目二次开发：mirai-simplepetpet-plugin

后话

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

欢迎提交任何请求

交流群: 534814022