Pixel Pets

Pixel Pets Plugin

A community plugin based off of the VSCode extension "vscode-pets". It allows you to open a view in your vault where your various pixel pets can play.

Key Features

• 🐱 22 different cats with 7+ different animations (and more pets on the way!)
  • Customizable with individual names
• 🖼️ 10 different backgrounds for your pets to play in
• 🎾 Pet interactivity
  • You can play fetch and throw balls for your pets to retrieve
  • You can pet your pets
  • You can get them to follow you with a pet toy
• ➡️ Movable view to allow for personal customization OR turn your entire Obsidian vault into your pets' playground
• 🤖 Catbot (chatbot) that can answer questions with context from your vault / allow you to chat with your pets

Getting Started

Installation

Method 1: Community Plugins (Recommended)

1. In Obsidian, go to Settings > Community Plugins.
2. Click Browse and search for "Pixel Pets".
3. Click Install, then Enable the plugin.

Method 2: Manual Installation

1. Download or clone this repository.
2. Copy the entire folder into your vault's .obsidian/plugins/ directory.
3. In Obsidian, go to Settings > Community Plugins and click Reload plugins.
4. Enable Pixel Pets in the list of installed plugins.

Adding Your First Pet

1. Enable the Pixel Pets plugin.
2. Once enabled, select the command Add a pet. Choose the pet's species and give it a name.
   • This will automatically open the pet view.
3. Select a background using the Choose pet view background command.
4. Continue to experiment with different backgrounds and pets, or just vibe along with your pets while you take notes, plan out RPGs, and more.

UI Previews

Toggle the cat ribbon icon to open and close the view.

Here is a preview of what the plugin could look like (Selected background: "Summer #1", added pet: "Christmas cat").

You can click and drag on the highlighted icon above the view to drag it into other views, as well as change the width and height of the view to customize your layout as desired. (See a couple of sample layouts below)

Here is what it looks like if you enable the full vault overlay.

Available Commands

• Adding pets
  • Add a pet: Select the species and provide it with a name. Added pets will immediately appear in the view.
• Removing pets
  • Remove a specific pet: Remove a specific pet. Provides a list of all the pets with their name and species.
  • Remove all pets: Removes all pets from the view.
• Interacting with pets
  • Add a ball: Chooses a random ball and launches it in the view for a pet to chase after.
  • Cat toy mouse toggle: Changes your mouse to a cat toy for your cats to follow.
• Background
  • Choose pet view background: Changes the background for the pet view. The background can also be changed in the settings tab.
• Chatting with pets
  • Chat with your pets: Opens up a chat modal for you to ask your pet questions.
    • NOTE: You must first set API keys for OpenAI (and optionally Gemini) to access this feature.
      • Further instructions can be found here -> OpenAI, Gemini
    • Usecases include: Chatting for fun, studying/reviewing your notes, and learning new concepts.

Contacts

If you have any kind of feedback or questions, feel free to reach out via GitHub issues or @hi.bye_2025 on the Obsidian Discord server.

Credits