OpenPet is an open-source, local-first desktop pet and companion platform for Windows 11. It brings living, customizable companions to your desktop with deterministic utility AI, transparent sprite rendering, and extensible plugin architecture.
- An open-source desktop companion that lives, walks, plays, and sleeps naturally on your Windows desktop.
- A local-first application: fully usable without internet access, accounts, or AI API keys.
- An extensible platform supporting community
.openpetpackages and sandboxed WebAssembly plugins. - A private local assistant capable of managing reminders and learning structured, user-auditable memory facts.
- It is NOT an Electron or web-wrapper app (built purely in Rust with native Windows APIs).
- It is NOT a cloud-dependent chatbot avatar (the pet behavior engine runs independently of generative AI).
- It is NOT spyware (local screen analysis defaults to OFF, and raw screen buffers never leave your machine).
- Current Version:
0.1.0-alpha.1(Active pre-release development). - Supported Platform: Windows 11 x64 (DirectX 12 / Win32).
- Dual Art-Style Companion Engine:
- Pixel Art: Procedural companion Mimi with 7 customizable breeds and fur patterns (Tabby/Tekir, Tuxedo/Smokin, Calico, Ginger/Sarıman, Siamese/Siyam, Black/Siyah, White/Beyaz).
- Photorealistic (Gerçek Kedi): High-resolution photographic cutout companion Oreo (Bıyıklı Smokin / Tuxedo with mustache marking) with alpha-channel edge processing and transparent desktop integration.
- Seamless switching anytime via Control Center header, Settings tab, desktop pet right-click menu, or system tray.
- Deterministic Utility AI Engine: 16+ semantic states (
idle,walk,run,sit,sleep,wake,play,pet,high_five, etc.) evaluated at 10–20 Hz with natural circadian rhythm transitions. - Direct Desktop Interactions: Drag-and-drop with position tracking, petting, high fives, and single/double-click reactions.
- Dynamic Frame Scheduler: Adapts frame rendering between 5 FPS (deep sleep), 24 FPS (idle), and 60 FPS (active locomotion).
- Secure
.openpetBundles: Self-contained ZIP packages validated with SHA-256 checks, Zip-Slip prevention, and atomic staging. - Sandboxed WebAssembly Plugins: Safe third-party extensibility powered by capability-based permissions (
NONEby default). - Local SQLite Storage: Encrypted at-rest context with automated transactional schema migrations and FTS search.
- Privacy by Architecture: Screen analysis strictly defaults to OFF. Instant Privacy Mode halts capture immediately.
- Optional AI Companion Layer: Normalized multi-provider streaming (Ollama, OpenAI, Anthropic, Gemini) with human confirmation required for all tool mutations.
+-------------------------------------------------------------+
| Windows Desktop |
| |
| [ Transparent Pet Window ] [ System Tray ] |
| | | |
| v v |
| +-----------------------------------------------------+ |
| | openpet-host.exe | |
| | - Behavior Engine (Utility AI, 10-20 Hz) | |
| | - Database Owner (SQLite / Storage Layer) | |
| | - Frame Scheduler (Dynamic 5-60 FPS) | |
| | - Reminder Scheduler & Notification Dispatcher | |
| | - Named Pipe IPC Server: \\.\pipe\OpenPet-... | |
| +-----------------------------------------------------+ |
| ^ |
| | Named Pipe IPC |
| v |
| +-----------------------------------------------------+ |
| | openpet-control.exe | |
| | - Management & Control Plane | |
| | - Onboarding, Pet Selector, Chat, Reminders, | |
| | Memory, Plugins, Privacy, Settings | |
| +-----------------------------------------------------+ |
+-------------------------------------------------------------+
For detailed architectural decisions, see the Architecture Decision Records (ADRs).
- Windows 11 x64
- Rust 1.80+ (
rustup default stable)
# Clone the repository
git clone https://github.com/Tiyatrotist/OpenPet.git
cd OpenPet
# Build all workspace targets
cargo build --workspace
# Run the test suite
cargo test --workspaceFor the easiest experience, simply run the launcher:
# Double click or run from terminal:
Run-OpenPet.batOr with PowerShell:
.\Run-OpenPet.ps1This automatically starts:
- Interactive Desktop Pet: Floats seamlessly on your desktop (choose between procedural Pixel Art Mimi or Realistic Oreo the Tuxedo Cat). Click to pet, drag around, or right-click to open actions!
- System Tray Icon: Lives in your Windows taskbar with a full context menu (Open Control Center, Toggle Art Style, Show/Hide Pet, Privacy Mode, Pause, Settings, Exit).
- Graphical Control Center: Full Win32 GUI window to check companion needs, chat, manage reminders, switch art styles, and toggle English / Türkçe!
You can also launch individual components manually:
# Background host daemon (pet window + system tray)
cargo run -p openpet-host
# Graphical Control Center
cargo run -p openpet-control
# Or CLI commands
cargo run -p openpet-control -- status# Validate the included official pet
cargo run -p openpet-pack -- validate packs/official/mimi-cat
# Inspect package contents
cargo run -p openpet-pack -- inspect packs/official/mimi-cat.openpetConfiguration is managed via %LOCALAPPDATA%\OpenPet\data\openpet.db.
| Setting | Default | Description |
|---|---|---|
screen_analysis_enabled |
false |
Local desktop activity analysis (strictly opt-in) |
privacy_mode |
false |
When true, immediately suspends capture and purges temporary buffers |
always_on_top |
true |
Keeps pet window above standard desktop windows |
animation_quality |
High |
Frame rate target mode (Low: 30 FPS, High: 60 FPS) |
- Windows 11 x64 is the sole supported platform (macOS, Linux, and mobile are roadmap items).
- Generative pet creation from photos requires an external AI provider key or local ComfyUI instance.
- Screen context awareness produces categorical activity signals (
Meeting,Video,Writing); full OCR text is intentionally not extracted to protect privacy.
We welcome contributions! Please review CONTRIBUTING.md and SECURITY.md before opening pull requests or reporting security issues.
OpenPet is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).