Petpet

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

java 编写，未使用任何第三方库 ：轻量，高效。

在线编辑器

使用方法

1. 下载 最新版本

2. 将插件放入 Mirai/plugins/

3. 下载 图片素材

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

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

pet @xxx 后跟 key 可以返回指定图片 例如 pet @xxx kiss

启用 keyCommand 后 上述指令可简写为 kiss @xxx

启用 respondImage 后 可通过发送的图片生成Petpet pet [图片] kiss

可使用 pet指令 获取 keyList

配置文件

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

content: 
  version: 3.7 #配置文件版本

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

  keyCommand: true #以 key 作为指令头
  keyCommandHead: '' #keyCommand前缀

  commandMustAt: false #必须有At对象
  respondImage: true #使用发送的图片生成 petpet
  respondSelfNudge: false #响应机器人发出的戳一戳
  fuzzy: false #模糊匹配用户名

  headless: true #使用headless模式
  autoUpdate: true #自动从仓库同步PetData
  repositoryUrl: 'https://dituon.github.io/petpet' #仓库地址, 用于自动更新

修改后重启 Mirai 以重新加载

权限管理

群主或管理员使用 pet on pet off 以 启用/禁用 插件

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

图片预览

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

展开/收起

key	预览
kiss
rub
throw
petpet
play
roll
bite
twist
pound
thump
knock
suck
hammer
tightly

自定义

在线编辑器

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), 参考下文
}

图片类型枚举

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]

仿射变换/图像变形

坐标格式枚举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

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

文字

如果你想在图片上添加文字，可以编辑 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], // 坐标
      "font": "宋体" // 字体, 默认为黑体
    },
    {
      "text": "$txt1[我]超市$txt2[你]!", // 支持关键词变量
      "pos": [0,200,300], // 第三个值为文本最大宽度
      "align": "CENTER", // 对齐方式, 默认为LEFT
      "wrap": "ZOOM" // 显示设置, 默认为NONE
    }
  ]

变量

• $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

需要更多变量请提交 Issue

WebServer

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

java -jar petpet.jar

启动时会生成 config.json:

{
  "port": 2333, //监听端口
  "threadPoolSize": 10, //线程池容量
  "headless": true //使用headless模式
}

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!

结构

展开/收起

• key(str): 对应PetData,例如kiss``rub
• fromAvatar``toAvatar``groupAvatar``botAvatar(url): 头像URL地址
• fromName``toName``groupName(str): 昵称, 有默认值
• textList(str): 根据空格分割此字符串, 作为额外数据

更多示例请参考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'(高速镜像)

分享你的作品

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

依赖share包二次开发

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

后话

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

欢迎提交任何请求

交流群: 534814022