openpets

Download OpenPets

Download the latest OpenPets desktop release and launch it. A pet appears immediately; no agent setup required.

• Desktop pets: animated companions that idle, wander, react, and keep your workspace from feeling empty.
• Official plugins: focus timers, reminders, mood check-ins, mini games, launch shortcuts, hydration nudges, and virtual-pet stats.
• Plugin SDK v3: a sandboxed JavaScript/TypeScript runtime for building new pet abilities with permissions, quotas, storage, schedules, commands, panels, events, audio, notifications, and more.
• Optional agent layer: Claude Code, OpenCode, Cursor, Devin, Pi, and MCP clients can drive local pet reactions without exposing prompts, code, paths, logs, or secrets in speech bubbles.

Star OpenPets

If OpenPets makes your coding setup or desktop workspace a little more fun, please give the repo a star.

For Users: Getting Started

You do not need to be a developer or connect any AI agents to enjoy OpenPets. The desktop app is fully functional out of the box with the official plugin lineup.

1. Install OpenPets Desktop

Download the package for your operating system from OpenPets Releases, or use the community-maintained AUR package on Arch-based Linux:

• macOS Apple Silicon: OpenPets-*-mac-arm64.dmg
• macOS Intel: OpenPets-*-mac-x64.dmg
• Windows: OpenPets-*-win-x64-setup.exe
• Linux: OpenPets-*-linux-x86_64.AppImage
• Arch Linux / CachyOS: Install the community-maintained openpets-bin AUR package by @pinoybear with paru -S openpets-bin (or yay -S openpets-bin).

Note: Windows release installers are signed. macOS builds may still be unsigned and can trigger a security warning; if macOS blocks execution, remove the quarantine flag via terminal:

xattr -dr com.apple.quarantine /Applications/OpenPets.app

2. Manage and Customize Pets

Browse installed pets, preview their animation frames, and configure which pet monitors each workspace or agent window from the built-in Pet Gallery.

3. Enable Official Plugins

OpenPets v3 ships with a modular Official Plugin Catalog. Enable or configure plugins via the desktop Control Center to add focus timers, reminders, and mini interactive games.

Shipped official lineup

• Day Routine: Tracks habits and reminds you to stretch or step away.
• Focus Buddy: Pomodoro-style focus timers to manage work cycles.
• Fortune Cookie: Cracks open randomized daily advice and wisdom.
• Launch Buddy: Allows registering shortcut commands to quickly open local folders, projects, or applications.
• Magic 8 Ball: Ask questions and receive playful, randomized answers from your pet.
• Mood Check-in: Periodically checks in on your mood to support emotional well-being.
• Reminders: Renders snoozeable, bell-alert notifications with custom audio tones.
• Virtual Pet: Turns your desktop companion into a Tamagotchi-style pet with hunger, affection, and energy levels tracked via a live status pin.
• Water Reminder: Keeps you hydrated with regular, customizable drinking prompts.

Plugin Platform & SDK v3

The OpenPets plugin system offers a secure, developer-friendly SDK (@open-pets/plugin-sdk) for creating custom companion behavior.

Security & Architecture

• Sandboxed Runtime: Each JS plugin runs inside a sandboxed BrowserWindow host environment.
• Host-Rendered UI: Plugins describe actions, HUDs, and notifications; the desktop host renders them. HTML/JS code cannot render raw HTML or execute arbitrary scripting inside a pet window.
• Permissions Model: Permissions must be declared in the manifest and approved by the user at install. Flagged sensitive APIs (like voice:listen, clipboard, and pet:speak:dynamic) require explicit consent toggles.
• SSRF & Private Host Guards: Network fetch requests are limited to developer-declared hostnames and guarded against local SSRF.

The SDK surface (ctx)

Plugins hook into the desktop environment via the ctx object, exposing:

• ctx.pets / ctx.pet: Manage default and spawned pet instances: spawn, move, animate, and react.
• ctx.ui: Alerts, transient/pinned bubbles, custom menus, panels, and status HUDs. Pinned mini HUD bubbles support compact 2x2 grid layouts with progress bars, such as Virtual Pet stats.
• ctx.audio: Trigger host-managed alert tones or user-imported custom audio.
• ctx.schedule: Set precise timer hooks (once, every, daily, cron, at).
• ctx.ai / ctx.secrets: Hook into the user's host-configured AI provider (Anthropic, OpenAI, Ollama) without exposing API keys to the plugin source.
• ctx.storage: Simple JSON key-value store with change subscriptions.
• Other APIs: events, assets, bus, net (with streaming support), notify, voice (TTS & push-to-talk STT), auth (PKCE browser flow), files (secure picked OS dialogs), system, commands, status, and log.

Developer Tools & Commands

Create, validate, and test plugins using the official CLI.

1. Scaffold a new plugin

Create a template from any of the official layouts (blank, reminder, ambient, ai-chat, tamagotchi, calendar):

npx @open-pets/cli plugin new "My Plugin" --template tamagotchi

2. Validate

Verify manifest layout, permissions, and configuration schemas before packing:

npx @open-pets/cli plugin validate ./my-plugin

3. Test harness

Write deterministic tests without launching the desktop app. Using @open-pets/plugin-sdk/testing's createTestHarness, you can mock the host, advance clocks, trigger actions, and verify reactions:

import { createTestHarness } from "@open-pets/plugin-sdk/testing";
import { register } from "./index.js";

const h = createTestHarness(register, { permissions: ["pet:speak", "schedule"] });
await h.start();
h.expectScheduled("decay");
await h.clock.advance("30m");
h.expectSpoke(/need attention/i);

Run plugin tests from your plugin project:

npm test

Advanced: Agent Integrations

If you want your development agent to drive your desktop companion, OpenPets provides an optional local MCP (Model Context Protocol) integration layer.

How it works

When you configure an agent, OpenPets exposes standard MCP tools. The agent can trigger animations, change status, and display text bubbles locally:

1. Claude Code: Installs OpenPets MCP, memory instructions in ~/.claude/CLAUDE.md, and hooks in ~/.claude/settings.json.
2. OpenCode: Installs OpenPets MCP, custom project instruction files, and the @open-pets/opencode automatic hook plugin.
3. Devin Desktop + Devin CLI: Adds OpenPets MCP to the shared ~/.config/devin/mcp_config.json plus lifecycle hooks for both (openpets configure --agent devin).
4. Cursor / Other MCP Clients: Register OpenPets as a standard stdio or TCP MCP server.

Diagnose your setup

Check whether the Claude hook and project Cursor MCP integrations are installed, need an update, or are broken, and whether the desktop app is reachable:

npx @open-pets/cli doctor

Pass --cwd <path> to inspect a different project's .cursor/mcp.json, or --json for machine-readable output. The command exits non-zero only when an integration is broken, so it is safe to run before reporting a bug.

MCP Server Configuration

To run OpenPets as an MCP tool, add the server to your agent's configuration:

{
  "mcpServers": {
    "openpets": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@open-pets/mcp@latest"]
    }
  }
}

Tip: To target a specific pet, pass the --pet <petId> argument.

Available MCP Tools

• `op