Mate Pet Creator

Create animated desktop pet characters for MiMo Desktop's Mate (桌面伙伴) system.

Output Structure

A valid custom pet lives in a folder with this structure:

<pet-id>/
├── manifest.json     # Required, animation metadata
└── spritesheet.webp  # Required, all animation frames in a grid

The user places this folder in their MiMo Desktop custom pets directory (userData/pets/<pet-id>/), then clicks "Refresh" in Settings → Mate to load it.

Manifest Schema

{
  "id": "my-pet",
  "name": "My Pet",
  "description": "A cute custom pet",
  "version": 1,
  "spritesheet": "spritesheet.webp",
  "frameWidth": 240,
  "frameHeight": 240,
  "columns": 8,
  "totalFrames": 16,
  "animations": {
    "idle": { "row": 0, "frames": 8, "fps": 8, "loop": true }
  }
}

Required Fields

Field	Type	Description
id	string	Unique identifier (kebab-case)
name	string	Display name
version	number	Always 1
spritesheet	string	Filename of the spritesheet image
frameWidth	number	Width of each frame in pixels
frameHeight	number	Height of each frame in pixels
columns	number	Number of columns in the spritesheet grid
totalFrames	number	Total number of frames across all animations
animations	object	At minimum must include idle

Optional Fields

Field	Type	Description
description	string	Shown in settings UI
anchorX	number	Horizontal anchor (0, 1, default 0.5) for centering

Animation Definition

Each animation entry:

Field	Type	Description
row	number	Row index in the spritesheet (0-based)
frames	number	Number of frames in this animation
fps	number	Playback speed (recommended: 6, 12)
loop	boolean	Whether the animation loops