DockCat

自定义指引

本文介绍如何让 DockCat 使用自定义宠物图片。

DockCat 使用这样的本地资源包结构:每个资源包都是一个文件夹,里面包含一个 manifest.json 文件,以及若干透明背景 PNG 图片,用来表示不同姿势和动画帧。你可以先只放一张图预览效果,再逐渐补齐其他状态的猫猫图。

如果你还没有自己的宠物图片,可以参考 图片生成提示词.md。那里整理了我们生成默认小猫时使用的提示词。

快速开始

我们推荐首先生成和测试用于对话场景的猫咪站立形象。这个姿势可以在“设置 > 宠物设置”里预览。确认整体形象满意后,再逐渐补充其他状态的小猫图片。

  1. 打开 DockCat 的“设置 > 宠物设置”。
  2. 点击 打开文件夹。DockCat 会打开:
~/Library/Application Support/DockCat/CatPacks/
  1. 打开里面的 my-cat/ 模板文件夹。
  2. 把至少一张你想使用的小猫图片放进对应的状态文件夹,例如 poses/dialogue/stand.png
  3. 回到“设置 > 宠物设置”,选择或输入 my-cat,点击 加载所选,然后保存。

资源包 ID 就是 CatPacks/ 下面的资源包文件夹名称。你可以把 my-cat/ 改成自己猫咪的名字。

DockCat 支持加载不完整的资源包,方便你预览效果。缺少的图片会自动使用默认小猫填充。

完整资源包结构

一个完整资源包需要小猫的每种状态都至少有一张图,例如:

my-cat/
  manifest.json
  poses/
    resting/
      loaf.png
      side.png
    held/
      held.png
    dialogue/
      stand.png
    transition/
      stretch.png
  animations/
    walk/
      walk_01.png
      walk_02.png
      walk_03.png
  app_icons/
    icon_sleep.png
    icon_empty.png

app_icons/ 是可选的。其他文件夹建议在完整资源包中都准备好。

CatPacks/default-lizz/ 是默认小猫栗子的资源包副本,可以作为参考。以后如果 DockCat 新版本内置了更多栗子姿势图片,这个参考副本也会自动更新。我们建议编辑或复制 my-cat/ 来制作自己的资源包,并另外备份好自己的小猫图片。

姿势图片要求

DockCat 会扫描每个姿势文件夹,并读取里面所有可用图片。图片的文件名可以任意取,不过清楚的命名会让你的资源包更容易维护。

当小猫切换到某个姿势时,DockCat 会从对应文件夹里随机选择一张图显示。你可以给同一种状态准备很多张图,从而让小猫表现更丰富。

当小猫需要朝向另一边时,DockCat 会自动镜像姿势图和散步动画。你不需要分别制作朝左和朝右两套图片。

图片规则

为了获得更好的显示效果,建议使用这些规则:

散步动画建议

散步帧比静态姿势更需要一致性,因为 DockCat 会一边水平移动小猫,一边循环播放这些帧。

为了获得更稳定的效果,建议:

推荐的散步条带提示词和质量检查清单见 图片生成提示词.md

Manifest

manifest.json 放在资源包根目录。

如果你只是新增或替换普通姿势图,通常不需要修改 manifest.json。DockCat 会自动扫描对应文件夹,所以普通姿势图和散步帧不用一张张写进 manifest。

完整示例:

{
  "id": "my-cat",
  "name": "My Cat",
  "author": "Your Name",
  "canvas_width": 1024,
  "canvas_height": 1024,
  "default_anchor": { "x": 0.5, "y": 0.88 },
  "poses": {
    "resting": "poses/resting",
    "held": "poses/held",
    "dialogue": "poses/dialogue",
    "transition": "poses/transition"
  },
  "animations": {
    "walk": { "fps": 3, "frames": [] }
  },
  "app_icons": {
    "sleep": "app_icons/icon_sleep.png",
    "empty": "app_icons/icon_empty.png"
  }
}

字段说明:

应用图标

DockCat 可以从你的资源包中加载自定义应用图标:

my-cat/app_icons/
  icon_sleep.png
  icon_empty.png

当 DockCat 成功加载一组有效图标后,会把它们复制到:

~/Library/Application Support/DockCat/AppIcon/

DockCat 会使用这个缓存副本作为持久自定义图标。替换或更新 DockCat App 不会删除这些本地图标。如果替换 App 后,在 DockCat 未运行时短暂显示了内置图标,启动一次 DockCat,它会重新把缓存的睡眠图标应用到当前 .app 文件图标上。

睡眠状态的程序坞图标还会受到 macOS Dock 图标缓存影响。DockCat 可以把自定义图标重新应用到 App 本身,但无法可靠地强制 Dock 进程立刻刷新缓存图片。如果重启 DockCat 后 icon_sleep.png 仍未显示,可能需要重启 Dock 或重启 Mac。

图标文件不会热更新。添加、替换或编辑 app_icons/icon_sleep.pngapp_icons/icon_empty.png 后,请重启 DockCat。

加载和更新

添加或修改自定义资源包后:

  1. 打开“设置 > 宠物设置”。
  2. 如需访问 Finder,点击 打开文件夹
  3. 选择或输入文件夹 ID,例如 my-cat
  4. 点击 加载资源包,让 DockCat 重新扫描并验证资源包。
  5. 保存。

如果只是修改设置项,直接保存即可。如果修改了资源包里的图片文件,请点击 加载资源包,让资源扫描器看到新文件。如果修改了 manifest.json,请重启 DockCat,让应用重新加载 manifest。图标文件更新后也需要重启 DockCat。

常见问题

如果资源包没有出现:

如果只有部分状态显示你的小猫:

如果小猫切换姿势时会跳动:

如果散步动画播放顺序不对:

如果替换图片后 DockCat 仍显示旧图:

如果散步状态的小猫比其他状态大或者小很多: