Metadata-Version: 2.4
Name: deskpets
Version: 1.0.0
Summary: Desktop pixel pets for Windows
Author: Minniti Julien
License: MIT License
        
        Copyright (c) 2025 Minniti Julien
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/Jumitti/DeskPets
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyQt6
Requires-Dist: PyQt6-WebEngine
Requires-Dist: Pyllow
Dynamic: license-file

# DeskPets 🐶

Desktop pets for Windows. Directly and explicitly inspired by 
[**vscode-pets**](https://github.com/tonybaloney/vscode-pets)
by [**tonybaloney**](https://github.com/tonybaloney/vscode-pets). 
This project adopts the same core idea, small pixel creatures living on your workspace.

![screenshot](img/display.png)

## Installation (Windows only)

### Option 1 — Python 

```bash
pip install deskpets
```

And in to run, in CMD.exe:

```bash
deskpets
```

### Option 2 — Executable

Download the `.zip` from the **Release** section, extract it, and run `DeskPets.exe`.

## Usage

Launching the application spawns one or more pets in the bottom-left corner of the screen.

Current behavior:

* Unlimited number of pets
* Some species support multiple color variations
* Per-species size control
* Position automatically adapts to the taskbar
* Simple interaction: some pets sit when the cursor gets close

## Settings

![screenshot](img/settings.png)

![screenshot](img/pets.png)

![screenshot](img/size.png)

![screenshot](img/bigger.png)

## Missing Features

* Bunny, cat, frog (assets not licensed yet)
* Background system
* Ball play mechanic

## Credits

This project is inspired by [**vscode-pets**](https://github.com/tonybaloney/vscode-pets)
by [**tonybaloney**](https://github.com/tonybaloney/vscode-pets).
