github.com/SeakMengs/WindowPet @v0.04

<img width="180" src="https://github.com/SeakMengs/WindowPet/raw/v0.04/public/media/icon.png" alt="WindowPet">
<h1 align="center">WindowPet</h1>

Pet overlay app built with tauri and react that lets you have adorable companion such as pets, anime characters on your screen. Available on Windows, Macos, and Linux.

<a href="https://github.com/SeakMengs/Windowpet/releases/latest" target="_blank">
    <img src="https://img.shields.io/github/v/release/seakmengs/windowpet" alt="release-version">
</a>

<a href="https://github.com/SeakMengs/Windowpet/releases/latest" target="_blank">
    <img src="https://img.shields.io/github/downloads/seakmengs/windowpet/total" alt="downloads">
</a>

<a href="https://github.com/SeakMengs/WindowPet/stargazers" target="_blank">
    <img src="https://img.shields.io/github/stars/SeakMengs/WindowPet?" alt="stars">
</a>

<a href="https://github.com/SeakMengs/WindowPet/network/members" target="_blank">
    <img src="https://img.shields.io/github/forks/SeakMengs/WindowPet.svg?" alt="fork">
</a>

<a href="https://github.com/SeakMengs/WindowPet" target="_blank">
    <img src="https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2FSeakMengs%2FWindowPet&countColor=%23263759&style=flat"
        alt="visitors">
</a>

<a href="https://github.com/SeakMengs/WindowPet/blob/main/LICENSE.md" target="_blank">
    <img src="https://img.shields.io/github/license/seakmengs/windowpet" alt="license">
</a>




<a href="https://github.com/SeakMengs/Windowpet/releases/latest" target="_blank">
    <img src="https://img.shields.io/badge/Windows-0078D6?style=flat&logo=windows&logoColor=white" alt="window">
</a>

<a href="https://github.com/SeakMengs/Windowpet/releases/latest" target="_blank">
    <img src="https://img.shields.io/badge/MACOS-adb8c5?style=flat&logo=macos&logoColor=white" alt="macos">
</a>

<a href="https://github.com/SeakMengs/Windowpet/releases/latest" target="_blank">
    <img src="https://img.shields.io/badge/linux-1793D1?style=flat&logo=linux&logoColor=white" alt="linux">
</a>



<a href="https://www.buymeacoffee.com/seakmeng" target="_blank"><img
        src="https://cdn.buymeacoffee.com/buttons/v2/default-blue.png" alt="Buy Me A Coffee"
        style="height: 40px !important;width: 145px !important;">
</a>

✨ Features

- Add pets - Add your own custom pet - Remove pets - Pixel perfect drag pets on your screen - Click through pets - Auto start up - Auto update - Allow as many pet/character as you want on your screen without any performance issue - Pet above taskbar - Settings window - Language support: English and Khmer - Dark mode and light mode (settings window) - Allow user to select state to see pet animation

✨ Demo

https://github.com/SeakMengs/WindowPet/assets/54373229/0b4c6ab3-539c-4b0a-8221-ca7113bf0fcf

✨ Download

• Download the latest version here
• Windows: .exe, .msi
• MacOS: .dmg
• Linux: .AppImage, .deb

✨ Development

• Clone the repo
• Install rust and tauri refer to this link
• Install dependencies

npm install

✨ Run & Build

• Run the project

 npm run tauri dev

• Build the project

 npm run tauri build --release

• Notice:
• for build release we use github actions to build the project and upload the build to github release. You can check the build workflow here
• for local build you have to generate your own signing key and replace the signing key in tauri.conf.json refer to tauri doc

✨ Contribute

• Feel free to open an issue or pull request if you have any idea or found any bug
• If you want to support me, you can buy me a coffee

✨ Inspiration

• My friend Blizzard4E for suggesting me this project idea
• vscode-pets
• Shimeji-ee Desktop Pet
• DPET : Desktop Pet Engine

✨ License

MIT License Copyright (c) 2023 Seakmeng