Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SeakMengs/WindowPet
Pet overlay app built with tauri and react that lets you have adorable companion such as pets, anime characters on your screen.
https://github.com/SeakMengs/WindowPet
companion cross-platform html learn mantine overlay pet productivity react react-query rust student-vscode tauri typescript zustand
Last synced: about 2 months ago
JSON representation
Pet overlay app built with tauri and react that lets you have adorable companion such as pets, anime characters on your screen.
- Host: GitHub
- URL: https://github.com/SeakMengs/WindowPet
- Owner: SeakMengs
- License: mit
- Created: 2023-07-18T09:17:58.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-01-23T22:02:51.000Z (5 months ago)
- Last Synced: 2024-01-30T04:48:37.887Z (5 months ago)
- Topics: companion, cross-platform, html, learn, mantine, overlay, pet, productivity, react, react-query, rust, student-vscode, tauri, typescript, zustand
- Language: TypeScript
- Homepage:
- Size: 44.1 MB
- Stars: 68
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Lists
- awesome-tauri - WindowPet - Overlay app that lets you have adorable companions such as pets and anime characters on your screen. (Applications / Productivity)
README
WindowPet
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.
## ✨ Features
- Add pets (45+ pets and characters available to choose from)
- 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](https://github.com/SeakMengs/WindowPet/releases/latest)
- Windows: .exe, .msi
- MacOS: .dmg
- Linux: .AppImage, .deb
## ✨ Development
- Clone the repo
- Install rust and tauri refer to this [link](https://tauri.app/v1/guides/getting-started/prerequisites)
- Install dependencies
```sh
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](https://github.com/SeakMengs/WindowPet/blob/main/.github/workflows/release.yml)
- for local build you have to generate your own signing key and replace the signing key in `tauri.conf.json` [refer to tauri doc](https://tauri.app/v1/guides/distribution/updater/)
## ✨ 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](https://www.buymeacoffee.com/seakmeng)
## ✨ Inspiration
- My friend [Blizzard4E](https://github.com/Blizzard4E) for suggesting me this project idea
- [vscode-pets](https://marketplace.visualstudio.com/items?itemName=tonybaloney.vscode-pets)
- [Shimeji-ee Desktop Pet](https://kilkakon.com/shimeji/)
- [DPET : Desktop Pet Engine](https://store.steampowered.com/app/1980920/DPET__Desktop_Pet_Engine/)
## ✨ License
MIT License Copyright (c) 2023 Seakmeng