.. VS Code Pets documentation master file, created by
   sphinx-quickstart on Wed Nov  2 12:06:50 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

VS Code Pets
============

An extension for VS Code that puts pets in your editor to keep you company whilst you code.

.. image:: https://img.shields.io/visual-studio-marketplace/v/tonybaloney.vscode-pets?logo=visual-studio
   :alt: Visual Studio Marketplace Version
   :target: https://marketplace.visualstudio.com/items?itemName=tonybaloney.vscode-pets&WT.mc_id=python-17801-anthonyshaw

.. image:: _static/screenshot.gif
   :alt: Usage screenshot

Installation
------------

From the VS Code Marketplace
++++++++++++++++++++++++++++

Install this extension from the `VS Code marketplace <https://marketplace.visualstudio.com/items?itemName=tonybaloney.vscode-pets&WT.mc_id=python-17801-anthonyshaw>`_.

From VS Code
++++++++++++

With VS Code open, search for `vscode-pets` in the extension panel (`Ctrl+Shift+X` on Windows/Linux or `Cmd(⌘)+Shift+X` on MacOS) and click install.

.. image:: _static/install.png
   :alt: Installation screenshot

Alternatively, with VS Code open, launch VS Code Quick Open (`Ctrl+P` on Windows/Linux or `Cmd(⌘)+P` on MacOS), paste the following command, and press enter.

`ext install tonybaloney.vscode-pets`

Getting Started
---------------

Launch VS Code Command Palette (`Ctrl+Shift+P` on Windows/Linux or `Cmd(⌘)+Shift+P` on MacOS, then type `pets` and select `Pets: Start Pet Coding Session`.

.. image:: _static/start_pet_coding.png
   :alt: Start screenshot

This will open a new sub-panel inside the `Explorer` panel:

.. image:: _static/pet-in-default-explorer.png
   :alt: Step 1 screenshot

From here, you can add multiple pets, give them names, change the background. Find out how in the `usage section <usage>`_.

Credits
-------

The cat and dog media assets for this extension were licensed from itch.io.

`Marc Duiker <https://twitter.com/marcduiker>`_ created the Clippy, Rocky, Zappy, rubber duck, snake, cockatiel, Ferris the crab, and Mod the dotnet bot media assets.

`Karen Rustad Tölva <https://www.aldeka.net>`_ designed the original concept of Ferris the crab.

Thank you
---------

Thanks to all the `contributors <https://github.com/tonybaloney/vscode-pets/graphs/contributors>`_ to this project.


.. toctree::
   :glob:
   :maxdepth: 1
   :hidden:

   self
   usage
   contributing