scriptoriumadmin/openpetswithchatandmcp
1
0
Fork 0
Code Issues Pull requests 6 Projects Releases Packages Wiki Activity Actions
openpetswithchatandmcp/README_OUR_CHANGES.md
OpenPets Dev 6ab3bb64d8 feat(rebrand): rename OpenPets to FamiliarOS and pets to familiars 
- Rename all user-facing and technical identifiers from OpenPets/Pet to FamiliarOS/Familiar.
- Rename packages from @open-pets/* to @familiaros/*; rename install-pet/pet-format packages.
- Rename plugin IDs and directories from openpets.* to familiaros.*.
- Rename IPC namespace from openpets:* to familiaros:* and state filenames from openpets-* to familiaros-* with legacy migration.
- Rename source files (pet-window, built-in-pet, default-pet-controller, etc.) to familiar equivalents.
- Update locales (en, es-419, ja, ko, pt-BR, zh-Hans, zh-Hant) and tray/pet context menu strings.
- Add Familiar naming feature: preference, settings input, tray menu display.
- Update assets and packaging config; all desktop tests pass.
2026-06-17 01:42:08 +00:00

4.6 KiB
Raw Blame History

FamiliarOS — 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 familiar 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 2–3 lines of text.
  • Resizable corner grip; size remembered per mode.
  • Enter sends, Ctrl+Enter inserts a newline, Escape closes.

New: Local Memory

FamiliarOS 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 FamiliarOS MCP tools (familiaros_memory_*).

New: Knowledge Store

Store files and add manual knowledge entries that the assistant can reference during chat.

  • Upload files from Settings > Knowledge Store or store attachments directly from the floating chat window.
  • Text-like files are indexed and searched by file name and extracted content.
  • Relevant files are injected into the assistant's system instructions automatically.
  • Combined search across stored files and FamiliarOS memories.

New: MCP Tool Servers (Built-in Chat)

Activate MCP tool servers for the built-in floating chat, independently of external agents.

  • Filesystem, Terminal, Memory, Fetch/Web, Sequential Thinking, Playwright, Git, GitHub, Docker, SQLite.
  • Top-level MCP Tool Servers panel in Control Center → Integrations.
  • Tiered browser: Starter, Terminal & Systems, Advanced.
  • Tools run through an internal stdio MCP client in the main process.

New: FamiliarOS MCP Server Panel

A central panel in Control Center → Integrations configures the external-agent bridge.

  • Command mode selector (published / bundled / local) in one place.
  • Node path override and familiar routing in one place.
  • One-click Test Server health check.
  • One-click Copy MCP JSON for Claude Code, Cursor, Codex CLI, or generic MCP hosts.

New: Familiar Scale

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

New: Virtual Familiar Status

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

New: Familiar Character & Base Instructions

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

New: Text-to-Speech (Phase 2)

The familiar can now speak aloud using a configurable TTS provider.

  • Settings > Text-to-Speech chooses between system OS voice, OpenAI TTS, ElevenLabs, Piper (local), or an OpenAI-compatible endpoint.
  • Per-provider voice, model, speed, endpoint preset, and API-key storage.
  • Test and Stop buttons preview the voice in Settings.
  • Speech is skipped during quiet hours and uses the same safety boundaries as bubbles.
  • Plugins with the voice:speak permission can ask the familiar to speak.

New: Multi-Screen Awareness

The familiar 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 FamiliarOS desktop app. The new surfaces appear automatically:

  • Single-click the familiar → familiar the virtual familiar.
  • Double-click the familiar → floating chat.
  • Right-click the familiar → Virtual Familiar status and care commands.
  • Settings → OpenAPI Chat for model/credential setup.
  • Settings → Text-to-Speech for voice provider and test preview.
  • Settings → Memory for memory management.
  • Settings → Knowledge Store for file-based knowledge.
  • Integrations → MCP Tool Servers for built-in chat tool activation.
  • Integrations → FamiliarOS MCP Server for external-agent bridge configuration.
  • Integrations → Curated MCP Toolkit for optional persistent bundles and copy-paste snippets.