# 🐾 Screen Pet Companion for Obsidian An interactive, lively animated screen pet companion for [Obsidian](https://obsidian.md). Bring your vault to life with 20+ iconic companions that roam your workspace, express moods, alert you of pending tasks, cheer your milestones, and keep you focused with built-in Pomodoro sprints and wellness break reminders! [![Release](https://img.shields.io/github/v/release/yashagrawall/obsidian-screen-pet?style=for-the-badge&color=7c3aed)](https://github.com/yashagrawall/obsidian-screen-pet/releases) [![Obsidian Community Plugin](https://img.shields.io/badge/Obsidian-Community%20Plugin-7c3aed?style=for-the-badge&logo=obsidian)](https://obsidian.md/plugins?id=screen-pet) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](https://opensource.org/licenses/MIT) --- ## ✨ Features ### 🌟 20+ Iconic Pet Characters Choose from a wide variety of mythical beasts, superheroes, anime icons, sci-fi creatures, and cozy animals: - 🏎️ **Lightning McQueen** (Cars) - 🌿 **Baby Groot** (Guardians of the Galaxy) - 🤖 **Iron Bot** (Iron Man) - 🐊 **Loki Gator** (Loki) - 🐉 **Drogon** (Game of Thrones) - 🐺 **Ghost** (Direwolf) - 🦉 **Hedwig** (Harry Potter) - 🐱 **Lucifer** (Cinderella) - 🌸 **Dart Demogorgon** (Stranger Things) - 🦅 **Damon's Raven** (The Vampire Diaries) - ⚡ **Sparky** (Frankenweenie) - 🪄 **Golden Snitch** (Harry Potter) - 🍃 **Totoro** (My Neighbor Totoro) - 🍊 **Capybara** (The Chill Master) - 🕷️ **Spider-Man** (Your Friendly Neighbor) - 🛸 **Baby Yoda / Grogu** (The Mandalorian) - 🦇 **Batman** (The Dark Knight) - 🐈‍⬛ **Black Cat** - 🐕 **Shiba Inu** - 🐭 **Stuart Little** --- ### 🎨 3 Distinct Visual Rendering Modes Switch between 3 handcrafted rendering styles at any time: 1. **Realistic Mode**: High-resolution movie CGI and authentic photographic renders. 2. **Pixelated Mode**: Crisp 16x16 retro pixel-art sprites designed for pure nostalgia. 3. **Cartoon Mode**: Dynamic 2D vector figures featuring animated moving parts (spinning wheels, flapping wings, glowing arc reactors, dancing bodies). --- ### 🍅 Built-In Pomodoro Focus Sprints & Health Breaks - **Focus Sprints**: Trigger a 25-minute Pomodoro focus session directly from your pet. A glowing live focus badge counts down near your companion. - **Break Reminders**: Automatic customizable intervals (15 to 90 min) prompting you to stretch, hydrate, and rest your eyes. - **Milestone Celebrations**: Complete your focus session or mark vault tasks done and your pet bursts with celebratory confetti particles! --- ### 📋 Interactive Vault Task Companion - Your pet actively monitors your vault for pending markdown checkbox tasks (`- [ ]`). - Click the pet radial menu to inspect pending tasks across your notes, complete them on the fly, and receive encouraging chirps. --- ### 💬 Interactive Radial Menu & Pet Actions Click or tap your pet to reveal a radial action menu: - 🍖 **Feed Treat**: Reward your pet with their favorite snack. - ❤️ **Pet & Cuddle**: Shower your companion with affection and hearts. - 🎾 **Play Fetch**: Throw a bouncing ball across your note editing area. - 💤 **Nap / Sleep**: Let your pet snooze peacefully. - 🍅 **Focus Timer**: Launch an instant Pomodoro timer. - 📋 **Vault Tasks**: View and interact with your uncompleted tasks. - 💬 **Universe Quotes**: Receive iconic movie quotes and uplifting daily affirmations. - ⚙️ **Settings**: Quick shortcut directly to pet settings. --- ### 🛠️ Custom Pets & Infinite Personalization - **Create Your Own Pets**: Import custom sprites, GIFs, or image URLs with custom names, quotes, treats, and flying capabilities. - **Roam Modes**: - `Stationary`: Sits comfortably in a corner or docked position. - `Free Roam`: Glides and explores across your entire Obsidian window. - `Bottom Walk`: Strolls playfully along the bottom of your workspace. - **Scale & Speed**: Adjust scale from small (55px) to jumbo (150px) and customize movement speed. - **Sound Effects**: Procedurally synthesized 8-bit chimes and audio cues with volume controls. --- ## 📦 Installation ### Option 1: Obsidian Community Plugins (Recommended) 1. Open **Obsidian Settings** > **Community plugins**. 2. Make sure **Restricted mode** is turned **OFF**. 3. Click **Browse** and search for `Screen Pet Companion`. 4. Click **Install**, then click **Enable**. ### Option 2: Obsidian BRAT 1. Install the [Obsidian BRAT](https://github.com/TfTHacker/obsidian-42-brat) plugin. 2. Go to **Options** > **BRAT** > **Add Beta plugin**. 3. Enter repository URL: `https://github.com/yashagrawall/obsidian-screen-pet` 4. Click **Add Plugin** and enable **Screen Pet Companion**. ### Option 3: Manual Installation 1. Download `main.js`, `manifest.json`, and `styles.css` from the [Latest Release](https://github.com/yashagrawall/obsidian-screen-pet/releases). 2. Create a folder named `screen-pet` inside your vault's plugin directory: `/.obsidian/plugins/screen-pet/`. 3. Copy the downloaded files into the `screen-pet` folder. 4. Reload Obsidian and enable **Screen Pet Companion** under **Community plugins**. --- ## ⚙️ Configuration & Settings | Setting | Description | Default | | :--- | :--- | :--- | | **Active Pet** | Choose which companion accompanies you | Lightning McQueen | | **Visual Style** | Realistic / Pixelated / Cartoon | Realistic | | **Scale** | Pet size (55px, 75px, 95px, 120px, 150px) | 95px | | **Roam Mode** | Stationary / Free Roam / Bottom Walk | Stationary | | **Speed** | Slow / Normal / Fast | Normal | | **Break Reminders** | Enable periodic wellness reminder bubbles | Enabled | | **Break Interval** | Minutes between reminders (15 - 90 min) | 30 minutes | | **Sound Synthesis** | 8-bit retro audio chimes & volume control | Enabled (30%) | | **Name Tag** | Floating badge displaying companion's name | Visible | --- ## ⌨️ Commands Open the Obsidian Command Palette (`Ctrl/Cmd + P`) and search for **Screen Pet Companion**: - `Toggle Pet Visibility`: Instantly hide or show your screen pet. - `Start 25-min Pomodoro Sprint`: Launch a focus session with live badge countdown. - `Pet / Cuddle Companion`: Trigger affection hearts and happy sound. - `Feed Active Pet`: Reward your companion with their favorite treat. - `Open Pet Companion Settings`: Jump directly to the configuration tab. --- ## 🛡️ Privacy & Performance - 🔒 **100% Local & Private**: No analytics, telemetry, or external network requests. All sprites, audio synthesis, and animations run locally. - ⚡ **Ultra Lightweight**: CSS GPU-accelerated transforms and `requestAnimationFrame` ensures zero lag during typing or note browsing. --- ## 🤝 Contributing Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/yashagrawall/obsidian-screen-pet/issues). --- ## 📄 License Distributed under the **MIT License**. See [`LICENSE`](LICENSE) for more information. ---

Made with ❤️ for the Obsidian Community by Yash Agrawall