openpetswithchatandmcp/README_OUR_CHANGES.md
OpenPets Dev 82abe08658 chore(release): integrate v3.1.0 companion fixes
- Harden memory capture/retrieval.
- Move virtual-pet HUD to context menu.
- Single-click petting; remove triple-click.
- Fix speech-bubble clipping.
- Make scale slider draggable.
- Fix Windows packaging build-deps script and update docs.
2026-06-13 06:33:48 +00:00

2.8 KiB
Raw Permalink Blame History

OpenPets — Our Additions (Isolated README)

This README describes only the capabilities added by our fork. It is kept separate from the upstream README.md so the original maintainer can review and adopt changes independently.

New: Floating Chat Window

Double-click the desktop pet to open an always-on-top floating chat window.

  • BYOK OpenAPI-compatible chat (OpenAI, OpenRouter, Moonshot/Kimi, LiteLLM, vLLM, Azure, custom).
  • Conversation history rendered as a styled list with role badges and timestamps.
  • History persists across app restarts.
  • Compact mode at 96px height; expanded editor/history mode at 280px.
  • Prompt bar sized for 23 lines of text.
  • Resizable corner grip; size remembered per mode.
  • Enter sends, Ctrl+Enter inserts a newline, Escape closes.

New: Local Memory

OpenPets now remembers things for you.

  • Durable local memory store with automatic capture from chat prompts.
  • Relevance-based retrieval into future system prompts.
  • Memory kinds: preference, identity, fact, note.
  • In-app memory viewer in Settings for search, edit, and delete.
  • Also exposed through existing OpenPets MCP tools (openpets_memory_*).

New: Vanilla Chat MCP Tools

Activate MCP tools directly inside the floating chat window for autonomous task execution.

  • Filesystem, Terminal, Memory, Fetch/Web, Sequential Thinking, Playwright, Git, GitHub, Docker, SQLite.
  • Tiered browser in Settings/Integrations: Starter, Terminal & Systems, Advanced.
  • Tools run through an internal stdio MCP client in the main process.

New: Pet Scale

  • Continuous scale slider from 0.16x to 10x in Settings.
  • Window dynamically resizes so the pet is never clipped.

New: Virtual Pet Status

  • Bundled virtual-pet plugin tracks hunger, energy, happiness, and affection.
  • Status values live in the right-click pet context menu (Virtual Pet ▸ Mood, Food, Energy, Play, Bond, Level) instead of an on-pet HUD overlay, so double-click chat stays unobstructed.
  • Feed, play, pet, and nap commands are available from the pet context menu.

New: Pet Character & Base Instructions

  • Give your pet a custom system-prompt style character in Settings.
  • Toggle whether the default OpenPets behavior instructions are included in every chat.

New: Multi-Screen Awareness

The pet now stays on the display it is currently near, rather than always snapping to the primary display.

Installing these changes

No additional setup is required beyond the normal OpenPets desktop app. The new surfaces appear automatically:

  • Single-click the pet → pet the virtual pet.
  • Double-click the pet → floating chat.
  • Right-click the pet → Virtual Pet status and care commands.
  • Settings → OpenAPI Chat for model/credential setup.
  • Settings → Memory for memory management.
  • Integrations → MCP Toolkit for tool activation.